DescribeDBClusterProxy - PolarDB: Central de Documentação do Alibaba Cloud

Consulta um proxy de cluster de banco de dados.

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

polardb:DescribeDBClusterProxy

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-2zek76tdi709m6mf4
RegionId	string	Não	O ID da região. Nota Para mais informações, consulte DescribeRegions.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfm4ifnqnun3zq

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ChildInstances	array<object>	Uma lista de instâncias de rede carregadas pela instância da Cloud Enterprise Network (CEN).
	object	Os detalhes de uma instância de rede.
DBNodeClass	string	As especificações do nó. Para mais informações, consulte os seguintes documentos: PolarDB for MySQL: Especificações de nós de computação. PolarDB for Oracle: Especificações de nós de computação. PolarDB for PostgreSQL: Especificações de nós de computação.	polar.mysql.g4.medium
DBNodeIP	string	O endereço IP privado do nó do cluster de banco de dados.	10..10
DBNodeId	string	O ID do nó do cluster de banco de dados.	pi-wz97h479y364g9du7
DBNodePort	string	A porta do nó do cluster de banco de dados.	2450
DBNodeStatus	string	O status do nó. Valores válidos: Creating: O nó está sendo criado. Running: O nó está em execução. Deleting: O nó está sendo excluído. Rebooting: O nó está sendo reiniciado. DBNodeCreating: Um nó está sendo adicionado. DBNodeDeleting: Um nó está sendo excluído. ClassChanging: As especificações do nó estão sendo alteradas. NetAddressCreating: Uma conexão de rede está sendo criada. NetAddressDeleting: Uma conexão de rede está sendo excluída. NetAddressModifying: Uma conexão de rede está sendo modificada. MinorVersionUpgrading: A versão secundária está sendo atualizada. Maintaining: A instância está em manutenção. Switching: Um switchover está em andamento.	Running
HostName	string	O nome do host.	sh-lsf01-144-37
DBProxyClusterId	string	O ID do cluster de proxy.	pe-xxxxxxxxx
DBProxyClusterNum	integer	O número de nós de proxy.	2
DBProxyClusterStatus	string	O status do cluster de proxy.	ClassChanging
RequestId	string	O ID da solicitação.	30E11ED2-C922-5B96-BCC6-11EE8C484AC6

Exemplos

Resposta de sucesso

JSON formato

{
  "ChildInstances": [
    {
      "DBNodeClass": "polar.mysql.g4.medium",
      "DBNodeIP": "10.*.*10",
      "DBNodeId": "pi-wz97h479y364g9du7",
      "DBNodePort": "2450",
      "DBNodeStatus": "Running",
      "HostName": "sh-lsf01-144-37"
    }
  ],
  "DBProxyClusterId": "pe-xxxxxxxxx",
  "DBProxyClusterNum": 2,
  "DBProxyClusterStatus": "ClassChanging",
  "RequestId": "30E11ED2-C922-5B96-BCC6-11EE8C484AC6"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.