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

Esta API é usada para consultar as configurações do PolarProxy 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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

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****
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 o ID da instância.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	Não	Um parâmetro obsoleto. Você não precisa especificar este parâmetro.	normal
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmy****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
DBProxyInstanceMinorVersions	object
DBProxyInstanceMinorVersions	array	A coleção de versões secundárias para as quais a instância de proxy pode ser atualizada.	2.25.9
	string	Versões atualizáveis para o proxy.	2.25.9_20251028
DBProxyConnectStringItems	object
DBProxyConnectStringItems	array<object>	Um array que consiste nas informações sobre o endpoint do database proxy criado para a instância.
	object	O endpoint do proxy criado para a instância.
DBProxyConnectString	string	O endpoint de proxy de banco de dados.	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	O tipo de rede do endpoint de proxy de banco de dados. Um endpoint de proxy de banco de dados era anteriormente chamado de terminal de proxy. Valores válidos: OuterString: Internet InnerString: rede interna	InnerString
DBProxyConnectStringNetWorkType	string	O tipo de rede do proxy de banco de dados. Valores válidos: 0: Internet 1: rede clássica 2: nuvem privada virtual (VPC)	2
DBProxyConnectStringPort	string	A porta associada ao endpoint de proxy de banco de dados.	3306
DBProxyEndpointId	string	O ID do endpoint de proxy de banco de dados de back-end.	20****
DBProxyEndpointName	string	O nome do endpoint de proxy de banco de dados. O nome pode ser substituído pelo ID do endpoint de proxy de banco de dados.	gos787jog2wk0ye1****
DBProxyVpcId	string	A VPC do proxy de banco de dados.	vpc-uf6oobt****
DBProxyVpcInstanceId	string	O ID da instância de proxy de banco de dados.	rm-bp145737x5**131161274792**
DBProxyVswitchId	string	O vSwitch do proxy de banco de dados.	vsw-uf6l0pic17****
DBProxyEngineType	string	Um parâmetro interno. Você pode ignorar este parâmetro.	normal
DBProxyInstanceCurrentMinorVersion	string	A versão da instância de proxy.	1.13.11
DBProxyInstanceLatestMinorVersion	string	A versão mais recente disponível para a instância de proxy.	1.13.12
DBProxyInstanceName	string	O nome da instância de proxy.	gos787jog2wk0ye1****
DBProxyInstanceNum	integer	O número de proxies habilitados na instância.	1
DBProxyInstanceSize	string	Este parâmetro está disponível apenas para instâncias ApsaraDB RDS for PostgreSQL. As especificações da instância de proxy habilitada. Formato: `Número de núcleos/Capacidade de memória`. Por exemplo, um valor de 4/8 indica que a instância de proxy possui 4 núcleos e 8 GB de memória.	4/8
DBProxyInstanceStatus	string	O status da instância de proxy. DBInstanceClassChanging: As especificações da instância de proxy estão sendo alteradas. Creating: A instância de proxy está sendo criada. Running: A instância de proxy está em execução. Deleting: A instância de proxy está sendo excluída.	Running
DBProxyInstanceType	string	O tipo do database proxy habilitado na instância. Valores válidos: 1: database proxy compartilhado 2: database proxy dedicado 3: database proxy de uso geral Nota ApsaraDB RDS for PostgreSQL não oferece suporte a database proxies compartilhados.	2
DBProxyKindCode	string	Um parâmetro interno. Você não precisa especificar este parâmetro.	18
DBProxyNodes	object
DBProxyNodes	array<object>	Os nós de proxy.
	object	Detalhes da lista de nós.
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 na qual o nó está implantado.	cn-hangzhou-c
DBProxyPersistentConnectionStatus	string	O status das conexões persistentes. Valores válidos: Enabled Disabled Unsupported	Disabled
DBProxyServiceStatus	string	O status do database proxy. Shutdown: desabilitado Startup: habilitado	Startup
DbProxyEndpointItems	object
DbProxyEndpointItems	array<object>	Os terminais de proxy da instância.
	object	As informações sobre o terminal de proxy.
DbProxyEndpointAliases	string	A descrição do endpoint de proxy de banco de dados.	proxy-test
DbProxyEndpointName	string	O ID do endpoint de proxy de banco de dados.	gos787jog2wk0ye1****
DbProxyEndpointType	string	O tipo de endpoint de proxy de banco de dados. Valores válidos: Custom: endpoint de proxy de banco de dados personalizado RWSplit: endpoint de proxy de banco de dados padrão	RWSplit
DbProxyReadWriteMode	string	Os atributos de leitura e gravação do endpoint de proxy de banco de dados. ReadOnly ReadWrite	ReadWrite
RequestId	string	O ID da solicitação.	909A69EE-71C8-4417-A0B9-FF085407E1E3
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmy****
DBProxyAVZones	object
DBProxyAVZones	array	A lista de zonas disponíveis para o database proxy.
	string	A zona disponível para o database proxy.	cn-shanghai-e

Exemplos

Resposta de sucesso

JSON formato

{
  "DBProxyInstanceMinorVersions": {
    "DBProxyInstanceMinorVersions": [
      "2.25.9_20251028"
    ]
  },
  "DBProxyConnectStringItems": {
    "DBProxyConnectStringItems": [
      {
        "DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
        "DBProxyConnectStringNetType": "InnerString",
        "DBProxyConnectStringNetWorkType": "2",
        "DBProxyConnectStringPort": "3306",
        "DBProxyEndpointId": "20****",
        "DBProxyEndpointName": "gos787jog2wk0ye1****",
        "DBProxyVpcId": "vpc-uf6oobt****",
        "DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
        "DBProxyVswitchId": "vsw-uf6l0pic17****"
      }
    ]
  },
  "DBProxyEngineType": "normal",
  "DBProxyInstanceCurrentMinorVersion": "1.13.11",
  "DBProxyInstanceLatestMinorVersion": "1.13.12",
  "DBProxyInstanceName": "gos787jog2wk0ye1****",
  "DBProxyInstanceNum": 1,
  "DBProxyInstanceSize": "4/8",
  "DBProxyInstanceStatus": "Running",
  "DBProxyInstanceType": "2",
  "DBProxyKindCode": "18",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DBProxyPersistentConnectionStatus": "Disabled",
  "DBProxyServiceStatus": "Startup",
  "DbProxyEndpointItems": {
    "DbProxyEndpointItems": [
      {
        "DbProxyEndpointAliases": "proxy-test",
        "DbProxyEndpointName": "gos787jog2wk0ye1****",
        "DbProxyEndpointType": "RWSplit",
        "DbProxyReadWriteMode": "ReadWrite"
      }
    ]
  },
  "RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "ResourceGroupId": "rg-acfmy****",
  "DBProxyAVZones": {
    "DBProxyAVZones": [
      "cn-shanghai-e"
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	RWSplitNetTypeNotExists	Specified rw split net type is not eixsts.
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	InvalidInstanceLevelExtraInfo	Specified class code has error extra info.	O código de classe especificado contém informações adicionais inválidas.
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	Current custins kindCode does not support this 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 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.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	A instância especificada não existe ou não é suportada.
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.