DescribeDBProxyEndpoint - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

Obtém o endpoint de proxy de banco de dados de uma instância RDS.

Descrição da operação

Mecanismos compatíveis

RDS MySQL
RDS PostgreSQL

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

rds:DescribeDBProxyEndpoint

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar os IDs das instâncias.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	Não	O ID do endpoint de proxy. Você pode chamar a operação DescribeDBProxy para consultar este ID.	keaxncrjluwu0gue****
DBProxyConnectString	string	Não	A string de conexão do proxy. Você pode chamar a operação DescribeDBProxy para consultar esta string de conexão.	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
DBInstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar os IDs das instâncias.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	Não	Este parâmetro é reservado e não precisa ser especificado.	normal

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
DBProxyConnectString	string	A string de conexão do proxy.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	O tipo de rede da string de conexão do proxy. Valores válidos: InnerString: Endereço interno. OuterString: Endereço público.	InnerString
DBProxyConnectStringPort	string	A porta para a string de conexão do proxy.	3306
DBProxyEndpointId	string	O ID do endpoint de proxy.	keaxncrjluwu0gue****
DBProxyEngineType	string	Um parâmetro reservado. Você pode ignorar este parâmetro.	normal
DBProxyFeatures	string	As configurações de recursos do endpoint de proxy. O valor é uma string de pares chave-valor delimitados por ponto e vírgula. A string contém as seguintes chaves: TransactionReadSqlRouteOptimizeStatus: Especifica se a divisão de transações deve ser ativada. Valores válidos: 0 (desativado) e 1 (ativado). ConnectionPersist: Especifica o tipo de pool de conexões. Valores válidos: 0 (desativado), 1 (pool de conexões no nível de sessão) e 2 (pool de conexões no nível de transação). ReadWriteSpliting: Especifica se a divisão de leitura/gravação deve ser ativada. Valores válidos: 0 (desativado) e 1 (ativado). AZProximityAccess: O recurso de acesso próximo. Valores válidos: 0 (desativado) e 1 (ativado). CausalConsistRead: Especifica o nível de consistência de leitura. Valores válidos: 0 (consistência eventual), 1 (consistência de sessão) e 2 (consistência global). HtapFilter: O roteamento automático de solicitações HTAP. Valores válidos: 0 (desativado) e 1 (ativado). PinPreparedStmt: Um parâmetro interno reservado que é visível apenas para instâncias do ApsaraDB RDS for PostgreSQL. Nota Para instâncias do ApsaraDB RDS for PostgreSQL, você pode modificar apenas a configuração ReadWriteSpliting. As chaves TransactionReadSqlRouteOptimizeStatus e PinPreparedStmt são permanentemente definidas como 1.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	Os nós de proxy associados ao endpoint de proxy.
	object	As propriedades de um nó de proxy.
cpuCores	string	O número de núcleos de CPU do nó.	2
nodeId	string	O ID do nó de proxy.	pn-xxxxxxx01
zoneId	string	O ID da zona de disponibilidade onde o nó está localizado.	cn-hangzhou-c
DbProxyEndpointAliases	string	O alias do endpoint de proxy.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	O modo de leitura/gravação do endpoint de proxy. Valores válidos: ReadWrite: modo de leitura/gravação. ReadOnly: modo somente leitura.	ReadWrite
DbProxyEndpointVswitchId	string	O ID do VSwitch do endpoint de proxy.	vsw-****
DbProxyEndpointVpcId	string	O ID da VPC do endpoint de proxy.	vpc-****
DbProxyEndpointZoneId	string	O ID da zona de disponibilidade onde o endpoint de proxy é criado.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	Uma lista de detalhes sobre as strings de conexão do proxy.
	object	Os detalhes de uma string de conexão do proxy.
DbProxyEndpointConnectString	string	O endereço de conexão do proxy.	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	O tipo de rede. Valores válidos: 0: rede pública 1: rede clássica 2: VPC	2
DbProxyEndpointPort	string	O número da porta. Valor padrão: 3306.	3306
ReadOnlyInstanceDistributionType	string	O modo de distribuição de peso de leitura. Para mais informações, consulte Alocação de peso de leitura. Valores válidos: Standard: O sistema aloca automaticamente pesos de leitura para instâncias com base em suas especificações. Custom: Você especifica pesos de leitura personalizados para instâncias.	Standard
ReadOnlyInstanceMaxDelayTime	string	O limite de latência para divisão de leitura/gravação. Se a latência de replicação em uma instância somente leitura exceder esse limite, as solicitações de leitura não serão roteadas para a instância. Unidade: segundos.	30
CausalConsistReadTimeout	string	O tempo limite para uma leitura consistente, em milissegundos. Valores válidos: 0 a 60000. Valor padrão: 10.	10
ReadOnlyInstanceWeight	string	A distribuição de peso de leitura. O valor é uma string JSON que especifica os pesos de leitura das instâncias primárias e somente leitura. Ela contém os seguintes campos: DBInstanceId: O ID da instância. DBInstanceType: O tipo de instância. Valores válidos: Master (instância primária) e ReadOnly (instância somente leitura). NodeID: O ID do nó primário ou secundário da instância primária se a instância executar o RDS Cluster Edition. NodeType: O tipo de nó de uma instância que executa o RDS Cluster Edition. Valores válidos: Primary (nó primário) e Secondary (nó secundário). Weight: O peso de leitura da instância. O valor aumenta em incrementos de 100, com um valor máximo de 10000.	[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z**\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z\"，\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c**\",\"NodeType\":\"Secondary\",\"Weight\":400}]]
RequestId	string	O ID da solicitação.	847BA085-B377-4BFA-8267-F82345ECE1D2
DBProxyEndpointCostThresholdForDuckdb	string
DBProxyEndpointMinSlaveCount	string	O número mínimo de instâncias somente leitura a serem retidas.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyConnectStringPort": "3306",
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyEngineType": "normal",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointVswitchId": "vsw-****",
  "DbProxyEndpointVpcId": "vpc-****",
  "DbProxyEndpointZoneId": "cn-hangzhou-c",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "2",
        "DbProxyEndpointPort": "3306"
      }
    ]
  },
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "CausalConsistReadTimeout": "10",
  "ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-t2****\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-z9****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\"，\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-1c****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}]]",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "DBProxyEndpointCostThresholdForDuckdb": "",
  "DBProxyEndpointMinSlaveCount": "2"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MaxscaleNotSupport	Current custins can not support Maxscale.	Esta operação não é compatível com instâncias com MaxScale.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	O ID do endpoint de proxy dedicado (DBProxyEndpointId) não foi especificado ou não existe. Verifique o parâmetro Endpoint.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	O valor DBInstanceName especificado é nulo ou nenhuma instância correspondente foi encontrada. Verifique o parâmetro DBInstanceName.
400	Endpoint.NotFound	The specified EndPoint is not valid.	O endpoint de destino não existe.
400	InvalidParameter	The specified parameter is invalid.	Parâmetro inválido.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Operações individuais não são permitidas para instâncias de pacote.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	O resultado do preço do plano de preços não foi encontrado.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	Você não concluiu a verificação de nome real e não está elegível para fazer uma compra. Faça login em Despesas e Custos para concluir a verificação de nome real.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	O crédito disponível da sua conta é menor que 0. Recarregue sua conta antes de tentar fazer uma compra.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	A chamada para o serviço de commodity retornou uma falha.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	O Alibaba Cloud planeja otimizar e ajustar a região atual. Os serviços em nuvem nesta região serão descontinuados. Para garantir a continuidade dos seus negócios e uma migração de dados tranquila, você não pode fazer novos pedidos de compra no momento. Agradecemos sua compreensão e apoio.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	O módulo adquirido é inválido. Adquira um módulo válido.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	A região foi desativada.
400	Price.CommoditySys	Commodity system call exception.	Ocorreu uma exceção ao chamar o sistema de commodities.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	O período de assinatura selecionado é inválido. Selecione um período de assinatura válido.
400	pay.noCreditCard	Account not bound to credit card.	A conta não está associada a um cartão de crédito.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	Existe um pedido não pago para o serviço selecionado. Pague ou cancele o pedido antes de fazer um novo.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	Nenhum método de pagamento está especificado para a conta. Adicione um método de pagamento.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Suas informações básicas estão incompletas. Complete suas informações básicas antes de realizar esta operação.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Ocorreu uma exceção com a sua conta. Entre em contato com o atendimento ao cliente para obter detalhes.
400	Api.NotSupport	Specified api is not supported.	A operação de API atual não é suportada.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Existe uma tag de bloqueio de pedido. Entre em contato com seu distribuidor para obter assistência.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	O DBInstanceId especificado não existe.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	O tipo de instância atual não oferece suporte ao tipo de armazenamento especificado.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	O parâmetro de entrada é inválido.
400	KmsApiError	User secret key invalid.	A chave do usuário é inválida.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.	Sua conta da Alibaba Cloud não existe ou sua AccessKey expirou.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	A execução do comando SQL falhou ou expirou.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	A versão atual do mecanismo DPI da instância não suporta o arquivamento de dados frios.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	A versão atual do kernel não suporta o arquivamento de dados frios.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	O tipo de instância atual não oferece suporte a esta operação.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	O nome do endereço de conexão está duplicado. Reconfigure a string de conexão.
400	RequiredParam.NotFound	Required input param is not found.	Parâmetros obrigatórios estão ausentes.
400	Parameters.Invalid	Parameter error, please check the parameters.	O parâmetro está incorreto. Verifique o parâmetro.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	O arquivamento de dados frios não oferece suporte a backup entre regiões ou backup de snapshot de alta frequência. Verifique a política de backup.
400	InvalideStatus.Format	The instance status does not support this operation.	O status da instância não suporta esta operação.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	A política de retenção de dados de backup arquivados após a liberação da instância é inválida.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	O tipo de mecanismo de banco de dados da instância não oferece suporte a esta operação.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Esta operação não é suportada para instâncias do tipo de rede VPC.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	A imagem da instância de banco de dados atual já existe.
400	UnsupportedClassCode	The specified DB instance class stops selling.	O tipo de instância não está mais disponível para compra.
400	InvalidBackupSet	The specified database does not exist in the backup set.	O banco de dados especificado não existe no conjunto de backup.
400	OrdTCommodityQueryError	Failed to query for product.	Falha ao consultar o produto.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	A instância foi liberada. Verifique a instância antes de fazer o pedido.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	A região foi desativada.
500	ExternalFailure	The request processing has failed due to external service failure.	A solicitação para o serviço falhou. Tente novamente mais tarde.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	A solicitação de serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	A solicitação falhou porque o serviço da API do RDS apresentou falha.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	A operação falhou. O tipo de ambiente da instância atual não é suportado. Verifique os tipos de instância suportados pela operação.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	A operação falhou. Esta operação não é suportada no status atual da instância.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	A operação falhou. O mecanismo do banco de dados atual não é suportado.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	Existe um pedido não pago para a instância atual. Pague o pedido e tente novamente.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	A capacidade de destino para redução de escala não pode ser menor que o uso de armazenamento atual.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Os discos em nuvem SSD não suportam esta operação. Faça upgrade para ESSD.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	As permissões do usuário não suportam esta operação.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	O VSwitchId especificado está em um formato incorreto ou está vazio.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	A versão secundária atual do mecanismo não suporta esta operação.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Não há regiões de inventário disponíveis.
403	NotInFlowController	Sorry,no permission.	Este recurso está disponível apenas para usuários de nuvem corporativa. Você não tem as permissões necessárias.
403	InvalidKmsKey	Kms key is disabled.	A chave KMS está desativada.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	O nível atual da instância de banco de dados não oferece suporte a esta operação.
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.	As informações da VPC especificadas não existem.
404	Endpoint.NotFound	Specified endpoint is not found.	O endpoint de destino não existe.
404	Maxscale.NotFound	The relative maxscale instance is not found.	A operação falhou. A instância MaxScale associada não foi encontrada.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	A instância atual não está autorizada a acessar o Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	O recurso solicitado não está disponível.
404	HostInfo.NotFound	The specified host info is not found.	As informações do host especificado não existem.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.