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

Obtém as informações de topologia de uma instância.

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

polardbx:DescribeDBInstanceTopology

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância.	cn-hangzhou
DBInstanceName	string	Sim	O ID da instância.	pxc-********
StartTime	string	Não	A hora de início do intervalo histórico da instância para a consulta de topologia, no formato yyyy-MM-dd HH:mm:ss.	2021-10-21T10:30:45Z 04:00:00
EndTime	string	Não	A hora de término do intervalo histórico da instância para a consulta de topologia, no formato yyyy-MM-dd HH:mm:ss.	2021-10-22T10:30:45Z 04:00:00
MinuteSimple	boolean	Não	Especifica se a topologia histórica deve ser consultada.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	C458B1E8-1683-3645-B154-6BA32080EEA
Data	object	A estrutura de dados.
LogicInstanceTopology	object	As informações de topologia.
DBInstanceName	string	O nome da instância.	pxc-sprcym7g7w****
DBInstanceCreateTime	string	A hora em que a instância foi criada. O formato é yyyy-MM-dd HH:mm:ss.	2021-10-21T10:30:45Z 04:00:00
MaintainStartTime	string	A hora de início da janela de O&M. O formato é HH:mm:ss.	04:00:00
MaintainEndTime	string	A hora de término da janela de O&M. O formato é HH:mm:ss.	05:00:00
LockReason	string	O motivo do bloqueio.	Overdue payment
DBInstanceStatus	integer	O status da instância.	8
LockMode	integer	O status de bloqueio. Valores válidos: 0: Desbloqueado. 1: Bloqueado.	0
EngineVersion	string	A versão do mecanismo DPI. Valor padrão: 2.0.	2.0
DBInstanceStorage	integer	O número de nós de armazenamento.	1
DBInstanceConnType	string	Indica que o LVS é usado para balanceamento de carga.	lvs
DBInstanceId	string	O ID da instância.	304726047
Engine	string	O mecanismo. Valor padrão: polarx.	polarx
DBInstanceDescription	string	A descrição da instância.	pxc-sprcym7******
DBInstanceStatusDescription	string	A descrição do status da instância.	TDE_MODIFYING
Items	array<object>	A lista de nós.
	array<object>	As informações do nó.
DBInstanceCreateTime	string	A hora em que a instância foi criada.	2021-10-21T10:30:45Z
DBInstanceName	string	O nome da instância.	pxc-i-tk6t4z****
CharacterType	string	O atributo do nó. Valores válidos: polarx_cn: Nó de computação. polarx_store: Nó de dados. polarx_gms: Nó GMS.	Node role
MaintainStartTime	string	A hora de início da janela de O&M.	Not displayed
DiskSize	integer	O tamanho do disco.	3145728
MaintainEndTime	string	A hora de término da janela de O&M.	Not displayed
LockReason	string	O motivo do bloqueio.	Not displayed
DBInstanceStatus	integer	O status da instância.	8
LockMode	integer	O status de bloqueio. Valores válidos: 0: Desbloqueado. 1: Bloqueado.	0
EngineVersion	string	A versão do mecanismo DPI. Valor padrão: 2.0.	5.7
DBInstanceConnType	integer	O tipo de conexão.	Not displayed
MaxConnections	integer	O número máximo de conexões.	4000
DBInstanceId	string	O ID da instância.	304726049
Engine	string	A versão do mecanismo DPI. Valores válidos: mysql polarx_cdc polarx_dn	mysql
MaxIops	integer	O IOPS máximo.	7000
DBInstanceDescription	string	A descrição da instância.	Not displayed
DBInstanceStatusDescription	string	A descrição do status da instância.	Not displayed
ConnectionIp	array<object>	A estrutura de dados.
	object	As informações de conexão.
Port	string	A porta.	3306
DBInstanceNetType	integer	O tipo de conexão interna. O valor é fixo em 1, o que indica a rede clássica.	1
ConnectionString	string	As informações de conexão.	pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com
Region	string	A região à qual o nó pertence. Se o nó for um nó do ApsaraDB RDS, as regiões de vários nós filhos são separadas por ponto e vírgula (;).	cn-hangzhou
Azone	string	A zona à qual o nó pertence. Se o nó for um nó do ApsaraDB RDS, as zonas de vários nós filhos são separadas por ponto e vírgula (;).	cn-hangzhou-a
Role	string	A função do nó. Valores válidos: master: Nó primário. standby: Nó secundário.	master
Activated	boolean	Indica se o nó está ativado. Na camada de computação, apenas os nós na zona primária estão ativados. Após a execução de uma alternância entre os nós primário e secundário na instância, os nós secundários na camada de computação são alternados para nós primários. Todos os nós na camada de armazenamento estão ativados.	true
AzoneRoleList	array<object>	A lista de informações de dados para a implantação de três nós do ApsaraDB RDS.
	object
Azone	string	A zona à qual um nó específico na implantação de três nós do ApsaraDB RDS pertence.	cn-hangzhou-a
Role	string	A função de um nó específico na implantação de três nós do ApsaraDB RDS. Valores válidos: leader: Nó primário. follower: Nó secundário. logger: Nó logger.	leader
Status	string	O status do nó. Valores válidos: 0: Em execução. 1: Criando. 2: Anormal. 3: Expirado. 4: Liberando. 5: Liberado. 6: Bloqueado.	0
NodeClass	string	As especificações do nó. Valores válidos: polarx.x4.medium.2e: 2 vCPUs e 8 GB de memória. polarx.x4.large.2e: 4 vCPUs e 16 GB de memória. polarx.x8.large.2e: 4 vCPUs e 32 GB de memória. polarx.x4.xlarge.2e: 8 vCPUs e 32 GB de memória. polarx.x8.xlarge.2e: 8 vCPUs e 64 GB de memória. polarx.x4.2xlarge.2e: 16 vCPUs e 64 GB de memória. polarx.x8.2xlarge.2e: 16 vCPUs e 128 GB de memória. polarx.x4.4xlarge.2e: 32 vCPUs e 128 GB de memória. polarx.x8.4xlarge.2e: 32 vCPUs e 256 GB de memória. polarx.st.8xlarge.2e: 60 vCPUs e 470 GB de memória. polarx.st.12xlarge.2e: 90 vCPUs e 720 GB de memória.	polarx.x4.large.2e
Version	string	A versão do nó logger.	polarx-cdc-kernel-2.0.0-3985896
PhyInstanceName	string	O nome da instância física.	pxc-unrbk8oyz**********
StorageUsed	string	A quantidade de espaço de armazenamento utilizado. Unidade: MB.	16681
InstanceClusterName	string	O nome do cluster CN da instância, como default.	default
ReadType	string	O tipo de leitura/gravação, como ReadWrite.	ReadWrite
HistoryItems	array<object>	A lista de nós históricos.
	object
CharacterType	string	O atributo do nó. Valores válidos: polarx_cn: Nó de computação. polarx_store: Nó de dados. polarx_gms: Nó GMS.	Node role
Role	string	A função do nó. Valores válidos: master: Nó primário. standby: Nó secundário.	master
DBInstanceName	string	O nome da instância.	pxc-sprcym7g7w****
DBInstanceId	string	O ID da instância.	304726049
Region	string	A região à qual o nó pertence. Se o nó for um nó do ApsaraDB RDS, as regiões de vários nós filhos são separadas por ponto e vírgula (;).	cn-hangzhou
Azone	string	A zona à qual o nó pertence. Se o nó for um nó do ApsaraDB RDS, as zonas de vários nós filhos são separadas por ponto e vírgula (;).	cn-hangzhou-a
Activated	boolean	Indica se o nó está ativado. Na camada de computação, apenas os nós na zona primária estão ativados. Após a execução de uma alternância entre os nós primário e secundário na instância, os nós secundários na camada de computação são alternados para nós primários. Todos os nós na camada de armazenamento estão ativados.	true
PhyInstanceName	string	O nome da instância física.	pxc-unrbk8oyz**********

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data": {
    "LogicInstanceTopology": {
      "DBInstanceName": "pxc-sprcym7g7w****",
      "DBInstanceCreateTime": "2021-10-21T10:30:45Z 04:00:00",
      "MaintainStartTime": "04:00:00",
      "MaintainEndTime": "05:00:00",
      "LockReason": "Overdue",
      "DBInstanceStatus": 8,
      "LockMode": 0,
      "EngineVersion": "2.0",
      "DBInstanceStorage": 1,
      "DBInstanceConnType": "lvs",
      "DBInstanceId": "304726047",
      "Engine": "polarx",
      "DBInstanceDescription": "pxc-sprcym7******",
      "DBInstanceStatusDescription": "TDE_MODIFYING",
      "Items": [
        {
          "DBInstanceCreateTime": "2021-10-21T10:30:45Z",
          "DBInstanceName": "pxc-i-tk6t4z****",
          "CharacterType": "Node role",
          "MaintainStartTime": "Not displayed",
          "DiskSize": 3145728,
          "MaintainEndTime": "Not displayed",
          "LockReason": "Not displayed",
          "DBInstanceStatus": 8,
          "LockMode": 0,
          "EngineVersion": "5.7",
          "DBInstanceConnType": 0,
          "MaxConnections": 4000,
          "DBInstanceId": "304726049",
          "Engine": "mysql",
          "MaxIops": 7000,
          "DBInstanceDescription": "Not displayed",
          "DBInstanceStatusDescription": "Not displayed",
          "ConnectionIp": [
            {
              "Port": "3306",
              "DBInstanceNetType": 1,
              "ConnectionString": "pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com"
            }
          ],
          "Region": "cn-hangzhou",
          "Azone": "cn-hangzhou-a",
          "Role": "master",
          "Activated": true,
          "AzoneRoleList": [
            {
              "Azone": "cn-hangzhou-a",
              "Role": "leader"
            }
          ],
          "Status": "0",
          "NodeClass": "polarx.x4.large.2e",
          "Version": "polarx-cdc-kernel-2.0.0-3985896",
          "PhyInstanceName": "pxc-unrbk8oyz**********",
          "StorageUsed": "16681",
          "InstanceClusterName": "default",
          "ReadType": "ReadWrite"
        }
      ],
      "HistoryItems": [
        {
          "CharacterType": "Node role",
          "Role": "master",
          "DBInstanceName": "pxc-sprcym7g7w****",
          "DBInstanceId": "304726049",
          "Region": "cn-hangzhou",
          "Azone": "cn-hangzhou-a",
          "Activated": true,
          "PhyInstanceName": "pxc-unrbk8oyz**********"
        }
      ]
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	RAM.Permission.Denied	RAM authentication failed.	A autenticação RAM falhou.
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.	A instância especificada não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.