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

Consulta os detalhes dos bancos de dados em um cluster PolarDB especificado.

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

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-**************
DBName	string	Não	O nome do banco de dados. Nota Você não pode especificar vários nomes de bancos de dados.	test_db
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser um número inteiro maior que 0 e não exceder o valor máximo de um número inteiro. 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 Valor padrão: 30.	30

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageRecordCount	integer	O número de entradas retornadas na página atual.	1
Databases	object
Database	array<object>	Os detalhes dos bancos de dados.
	array<object>
DBDescription	string	The description of the database.	test_des
DBStatus	string	The status of the database. Valid values: Creating: The database is being created. Running: The database is in use. Deleting: The database is being deleted.	Running
DBName	string	The name of the database.	test_db
Engine	string	The type of the database engine. Valid values: MySQL Oracle PostgreSQL	MySQL
MasterID	string	The ID of the primary node for the database in a Multi-master Cluster (Database/Table) edition cluster.	2
CharacterSetName	string	The character set. For more information, see Character sets.	utf8mb4
Accounts	object
Account	array<object>	The details of the database accounts. Nota For PolarDB for MySQL clusters, privileged accounts are not returned.
	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: The account is being created. Available: The account is available. Deleting: The account is being deleted.	Available
AccountPrivilege	string	The permissions of the account. Valid values: ReadWrite: Read and write. ReadOnly: Read-only. DMLOnly: DML only. DDLOnly: DDL only. ReadIndex: Read and index.	ReadOnly
AccountName	string	The name of the account. Nota For PolarDB for MySQL clusters, privileged accounts are not returned.	test_acc
RequestId	string	O ID da solicitação.	E1DF8CA6-2300-448B-9ABF-760C4B******
PageNumber	integer	O número da página.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "PageRecordCount": 1,
  "Databases": {
    "Database": [
      {
        "DBDescription": "test_des",
        "DBStatus": "Running",
        "DBName": "test_db",
        "Engine": "MySQL",
        "MasterID": "2",
        "CharacterSetName": "utf8mb4",
        "Accounts": {
          "Account": [
            {
              "PrivilegeStatus": "Empowered",
              "AccountStatus": "Available",
              "AccountPrivilege": "ReadOnly",
              "AccountName": "test_acc"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "E1DF8CA6-2300-448B-9ABF-760C4B******",
  "PageNumber": 1
}

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.