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

Descreve os bancos de dados em um cluster PolarDB no ENS.

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:DescribeDatabasesZonal

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-**************
DBName	string	Não	O nome do banco de dados.	test_db
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 50 100 O valor padrão é 30.	30
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para a solicitação atual.	10
NextToken	string	Não	O token de consulta. Este é o valor de NextToken da chamada de API anterior. Se não houver mais resultados, não especifique este parâmetro.	212db86sca4384811e0b5e8707e******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageRecordCount	integer	O número de entradas retornadas na página atual.	7
Databases	array<object>	Os detalhes dos bancos de dados.
	array<object>
DBDescription	string	A descrição do banco de dados.	test_des
DBStatus	string	O status do banco de dados. Valores válidos: Creating Running Deleting	Running
DBName	string	O nome do banco de dados.	test_db
Engine	string	O tipo de motor do banco de dados. Valores válidos: MySQL Oracle PostgreSQL	MySQL
MasterID	string	O ID do nó primário que corresponde ao banco de dados em um cluster da edição Multi-master Cluster (Database/Table).	2
CharacterSetName	string	O conjunto de caracteres.	utf8mb4
Accounts	array<object>	Os detalhes das contas do banco de dados. Nota Se o cluster for um cluster PolarDB for MySQL, as contas privilegiadas não são incluídas.
	object
PrivilegeStatus	string	The authorization status. Valid values: Empowering: Permissions are being granted. Empowered: Permissions are granted. Removing: Permissions are being revoked.	Empowered
AccountStatus	string	The status of the account. Valid values: Creating Available Deleting	Available
AccountPrivilege	string	The permissions of the account. Valid values: ReadWrite ReadOnly DMLOnly DDLOnly ReadIndex	ReadOnly
AccountName	string	The account name. Nota If the cluster is a PolarDB for MySQL cluster, privileged accounts are not included.	test_acc
RequestId	string	O ID da solicitação.	2FED790E-FB61-4721-8C1C-07C627******
PageNumber	integer	O número da página.	1
MaxResults	integer	O número máximo de entradas retornadas para a solicitação atual.	10
NextToken	string	O token de consulta. Este é o valor de NextToken da chamada de API anterior. Se não houver mais resultados, não especifique este parâmetro.	212db86sca4384811e0b5e8707e******

Exemplos

Resposta de sucesso

JSON formato

{
  "PageRecordCount": 7,
  "Databases": [
    {
      "DBDescription": "test_des",
      "DBStatus": "Running",
      "DBName": "test_db",
      "Engine": "MySQL",
      "MasterID": "2",
      "CharacterSetName": "utf8mb4",
      "Accounts": [
        {
          "PrivilegeStatus": "Empowered",
          "AccountStatus": "Available",
          "AccountPrivilege": "ReadOnly",
          "AccountName": "test_acc"
        }
      ]
    }
  ],
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627******",
  "PageNumber": 1,
  "MaxResults": 10,
  "NextToken": "212db86sca4384811e0b5e8707e******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	Failed to connect to the database cluster. Check the cluster status and database process list.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBInstanceId 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.