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

Consulta as informações de endpoint do proxy de banco de dados para uma instância do ApsaraDB 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 o ID da instância.	rm-bp1ja4f56s7us****
DBProxyEndpointId	string	Não	O nome do endpoint do proxy. Você pode chamar a operação DescribeDBProxy para consultar o nome.	keaxncrjluwu0gue****
DBProxyConnectString	string	Não	O endpoint do proxy. Você pode chamar a operação DescribeDBProxy para consultar o endpoint.	testproxy****.rwlb.rds.aliyuncs.com
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
DBProxyEngineType	string	Não	Um parâmetro reservado. Nenhuma configuração é necessária.	normal

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
DBProxyConnectString	string	O endpoint do proxy.	testproxy****.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	O tipo de rede do endpoint do proxy. Valores válidos: InnerString: endpoint interno. OuterString: endpoint público.	InnerString
DBProxyConnectStringPort	string	A porta do endpoint do proxy.	3306
DBProxyEndpointId	string	O ID do endpoint do proxy.	keaxncrjluwu0gue****
DBProxyEngineType	string	Um parâmetro interno. Você pode ignorar este parâmetro.	normal
DBProxyFeatures	string	As configurações do endpoint do proxy. O valor está no formato JSON e inclui os seguintes parâmetros: TransactionReadSqlRouteOptimizeStatus: a configuração de divisão de transações. Valores válidos: 0 (desativado) e 1 (ativado). ConnectionPersist: a configuração do 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: a configuração de divisão de leitura e gravação. Valores válidos: 0 (desativado) e 1 (ativado). AZProximityAccess: a configuração de acesso mais próximo. Valores válidos: 0 (desativado) e 1 (ativado). CausalConsistRead: a configuração de consistência de leitura. Valores válidos: 0 (consistência eventual), 1 (consistência de sessão) e 2 (consistência global). HtapFilter: a configuração de distribuição automática de solicitações entre nós de armazenamento em linha e armazenamento em coluna para HTAP. Valores válidos: 0 (desativado) e 1 (ativado). PinPreparedStmt: um parâmetro interno visível apenas no ApsaraDB RDS for PostgreSQL. Nota Para o ApsaraDB RDS for PostgreSQL, apenas ReadWriteSpliting pode ser modificado. TransactionReadSqlRouteOptimizeStatus e PinPreparedStmt são definidos como 1 por padrão.	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
DBProxyNodes	object
DBProxyNodes	array<object>	A lista de nós de proxy associados ao endpoint do proxy.
	object	Os detalhes do nó de proxy.
cpuCores	string	O número de núcleos de CPU do nó.	2
nodeId	string	O ID do nó de proxy na zona.	pn-xxxxxxx01
zoneId	string	O ID da zona onde o nó reside.	cn-hangzhou-c
DbProxyEndpointAliases	string	A descrição do endpoint do proxy.	proxyterminal-test
DbProxyEndpointReadWriteMode	string	O modo de leitura e gravação do endpoint do proxy. Valores válidos: ReadWrite: modo de leitura e gravação. ReadOnly: modo somente leitura.	ReadWrite
DbProxyEndpointVswitchId	string	O ID do vSwitch do endpoint do proxy.	vsw-****
DbProxyEndpointVpcId	string	O ID da VPC do endpoint do proxy.	vpc-****
DbProxyEndpointZoneId	string	As informações de zona do endpoint do proxy.	cn-hangzhou-c
EndpointConnectItems	object
EndpointConnectItems	array<object>	A lista de informações detalhadas sobre os endpoints do proxy.
	object	As informações detalhadas sobre o endpoint do proxy.
DbProxyEndpointConnectString	string	O endpoint do proxy.	testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetType	string	O tipo de rede. Valores válidos: 0: Internet 1: rede clássica 2: VPC	2
DbProxyEndpointPort	string	A porta de serviço. Valor padrão: 3306.	3306
ReadOnlyInstanceDistributionType	string	O modo de distribuição de peso de leitura. Para mais informações, consulte Distribuição de peso de leitura. Valores válidos: Standard: alocação automática com base nas especificações da instância Custom: alocação de peso personalizada	Standard
ReadOnlyInstanceMaxDelayTime	string	O limite de latência para divisão de leitura e gravação. Se a latência de uma instância somente leitura exceder esse limite, o tráfego de leitura não será roteado para a instância. Unidade: segundos.	30
CausalConsistReadTimeout	string	O período de tempo limite para leituras consistentes. Unidade: milissegundos. Valor padrão: 10. Valores válidos: 0 a 60000.	10
ReadOnlyInstanceWeight	string	As informações de distribuição de peso de leitura, que especificam os pesos de solicitação de leitura das instâncias primária e somente leitura. O valor está no formato JSON e inclui os seguintes parâmetros: DBInstanceId: o ID da instância. DBInstanceType: o tipo da instância. Valores válidos: Master (instância primária) e ReadOnly (instância somente leitura). NodeID: os IDs das instâncias dos nós primário e secundário da instância primária na Cluster Edition. NodeType: o tipo do nó na Cluster Edition. Valores válidos: Primary (nó primário da instância primária) e Secondary (nó secundário da instância primária). Weight: o peso da solicitação de leitura. O peso aumenta em incrementos de 100, e o valor máximo é 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	O limite de custo de execução para instruções SQL na distribuição automática de solicitações entre nós de armazenamento em linha e armazenamento em coluna para HTAP.	30000
DBProxyEndpointMinSlaveCount	string	O número mínimo de instâncias reservadas.	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": "30000",
  "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.	A operação falhou porque a instância não oferece suporte ao proxy dedicado. Verifique a configuração para ativar o proxy dedicado.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	O ID do endpoint de proxy dedicado (DBProxyEndpointId) não foi fornecido. Verifique o parâmetro Endpoint.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	O nome da instância especificado (DBInstanceName) é inválido. Verifique se o valor do parâmetro é nulo ou uma string vazia.
400	Endpoint.NotFound	The specified EndPoint is not valid.	A operação falhou porque o endpoint especificado não foi encontrado.
400	InvalidParameter	The specified parameter is invalid.	O 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 de preços para o plano 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 passou pela verificação de nome real e não atende aos requisitos de 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 saldo disponível da sua conta é menor que zero. Adicione fundos à sua conta antes de tentar fazer uma compra.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	A chamada para o serviço de comércio falhou.
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.	A Alibaba Cloud planeja otimizar e ajustar a região atual, e os serviços em nuvem nesta região cessarão as operações. Para garantir a continuidade dos negócios e uma transição suave para a migração de dados, você não pode fazer novos pedidos de compra no momento. Agradecemos a 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 comércio.
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 novamente o período.
400	pay.noCreditCard	Account not bound to credit card.	A sua conta não está vinculada 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.	Você tem pedidos não pagos para o serviço selecionado. Pague ou cancele os pedidos não pagos antes de fazer um novo pedido.
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 sua conta. Adicione um método de pagamento.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Suas informações estão incompletas. Complete suas informações antes de prosseguir.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Uma anomalia foi detectada em sua conta. Entre em contato com o suporte ao cliente para obter detalhes.
400	Api.NotSupport	Specified api is not supported.	Esta operação de API não é suportada.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Existe uma tag que proíbe a realização de pedidos. Entre em contato com seu distribuidor para obter assistência.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	A instância especificada não existe. Verifique se a instância existe e se não foi excluída.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	O tipo de instância atual não suporta este tipo de armazenamento.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	A operação falhou porque o parâmetro é 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.	A conta não existe.
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 de banco de dados 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 suporta esta operação.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	O nome do endpoint está duplicado. Reconfigure a string de conexão.
400	RequiredParam.NotFound	Required input param is not found.	Os parâmetros obrigatórios não foram fornecidos.
400	Parameters.Invalid	Parameter error, please check the parameters.	O parâmetro é inválido. Verifique os parâmetros.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	O arquivamento de dados não suporta backups entre regiões ou snapshots de nível de segundo. Verifique a política de backup.
400	InvalideStatus.Format	The instance status does not support this operation.	O status atual 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 para backups 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 venda.
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.	A consulta do produto falhou.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	A instância foi liberada. Verifique o status da instância antes de fazer um 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 de 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 técnico.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	O processamento da solicitação falhou devido a uma falha no serviço da API do ApsaraDB RDS.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	A operação falhou porque o tipo de ambiente da instância atual não é suportado. Verifique os tipos de instância suportados pela operação de API.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	A operação falhou porque o mecanismo e o tipo da instância de banco de dados atual não são suportados.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	A operação falhou porque o mecanismo de banco de dados atual não é suportado.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	A instância possui pedidos não pagos. Pague os pedidos e tente novamente.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	A capacidade de armazenamento de destino 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 SSDs padrão não suportam esta operação. Atualize para ESSDs.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Você não tem as permissões necessárias para realizar esta operação.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	O VSwitchId especificado é inválido ou está vazio.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	A versão secundária atual do mecanismo não oferece suporte a esta operação.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Nenhuma zona tem estoque disponível.
403	NotInFlowController	Sorry,no permission.	Este recurso não está disponível para usuários de nuvem não corporativos. 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.	A operação falhou porque o código de especificação especificado não suporta o número de endpoints. Verifique o número de shards e o número atual de endpoints.
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.	A VPC especificada não existe.
404	Endpoint.NotFound	Specified endpoint is not found.	A operação falhou porque o endpoint especificado não foi encontrado.
404	Maxscale.NotFound	The relative maxscale instance is not found.	A operação falhou porque 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.