Todos os produtos
Search
Central de documentação

:Consultar informações sobre bancos de dados

Última atualização: Jun 26, 2026

Chame a operação DescribeDatabases para consultar informações dos bancos de dados de uma instância.

Nota

Se os parâmetros de solicitação especificados forem inválidos, nenhuma informação de banco de dados será retornada.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeDatabases

Operação a ser executada. Defina o valor como DescribeDatabases.

DBInstanceIdStringYesrm-uf6wjk5xxxxxxx

ID da instância.

DBNameStringNotestDB01

Nome do banco de dados.

DBStatusStringNoCreating

Status do banco de dados. Valores válidos:

  • Creating
  • Running
  • Deleting
PageSizeIntegerNo30

Número de entradas a serem retornadas em cada página. Valores válidos:

  • 30
  • 50
  • 100

Valor padrão: 30.

PageNumberIntegerNo1

Número da página a ser retornada. Valores válidos: qualquer número inteiro positivo diferente de zero.

Valor padrão: 1.

ResourceGroupIdStringNorg-acfmy*****

ID do grupo de recursos.

Parâmetros de resposta

ParameterTypeExampleDescription
RequestIdString2603CA96-B17D-4903-BC04-61A2C829CD94

ID da solicitação.

DatabasesArray of Database

Matriz com as informações dos bancos de dados.

Database
DBDescriptionStringTest database

Descrição do banco de dados.

DBStatusStringCreating

Status do banco de dados. Valores válidos:

  • Creating
  • Running
  • Deleting
DBNameStringtestDB01

Nome do banco de dados.

DBInstanceIdStringrm-uf6wjk5xxxxxxx

ID da instância à qual o banco de dados pertence.

EngineStringMySQL

Mecanismo de banco de dados da instância à qual o banco de dados pertence.

CharacterSetNameStringutf8

Nome do conjunto de caracteres.

CollateStringC

Intercalação do conjunto de caracteres. O valor de exemplo C representa a localização.

Nota Este parâmetro é retornado apenas para instâncias que executam PostgreSQL.
CtypeStringen_US.utf8

Tipo do conjunto de caracteres.

Nota Este parâmetro é retornado apenas para instâncias que executam PostgreSQL.
ConnLimitString-1

Limite de solicitações simultâneas. O valor -1 indica que não há limite para solicitações simultâneas.

Nota Este parâmetro é retornado apenas para instâncias que executam PostgreSQL.
TablespaceStringpg_default

Tablespace do banco de dados.

Nota Este parâmetro é retornado apenas para instâncias que executam PostgreSQL.
ResourceGroupIdStringrg-acfmy*****

ID do grupo de recursos.

AccountsArray of AccountPrivilegeInfo

Matriz com os detalhes das contas. Cada conta possui permissões específicas no banco de dados.

AccountPrivilegeInfo
AccountStringtest

Nome de usuário da conta.

AccountPrivilegeStringDMLOnly

Permissões da conta no banco de dados. Valores válidos:

  • ReadWrite: permissões de leitura e gravação
  • ReadOnly: permissões somente leitura
  • DMLOnly: permissões apenas para DML
  • DDLOnly: permissões apenas para DDL
AccountPrivilegeDetailStringSELECT

Detalhes das permissões da conta no banco de dados.

PageNumberInteger1

Parâmetro reservado.

PageSizeInteger30

Parâmetro reservado.

TotalCountInteger100

Número total de entradas retornadas.

Exemplos

Exemplos de solicitações

http(s)://rds.aliyuncs.com/?Action=DescribeDatabases
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeDatabasesResponse>
    <RequestId>2603CA96-B17D-4903-BC04-61A2C829CD94</RequestId>
    <Databases>
        <Database>
            <Engine>MySQL</Engine>
            <CharacterSetName>utf8</CharacterSetName>
            <DBStatus>Creating</DBStatus>
            <DBDescription></DBDescription>
            <DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
            <Accounts></Accounts>
            <DBName>testdb</DBName>
        </Database>
        <Database>
            <Engine>MySQL</Engine>
            <CharacterSetName>gbk</CharacterSetName>
            <DBStatus>Creating</DBStatus>
            <DBDescription></DBDescription>
            <DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>
            <Accounts></Accounts>
            <DBName>testdb2</DBName>
        </Database>
    </Databases></DescribeDatabasesResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2603CA96-B17D-4903-BC04-61A2C829CD94",
  "Databases" : {
    "Database" : [ {
      "Engine" : "MySQL",
      "CharacterSetName" : "utf8",
      "DBStatus" : "Creating",
      "DBDescription" : "",
      "DBInstanceId" : "rdsaiiabnaiiabn",
      "Accounts" : {
        " AccountPrivilegeInfo" : [ ]
      },
      "DBName" : "testdb"
    }, {
      "Engine" : "MySQL",
      "CharacterSetName" : "gbk",
      "DBStatus" : "Creating",
      "DBDescription" : "",
      "DBInstanceId" : "rdsaiiabnaiiabn",
      "Accounts" : {
        " AccountPrivilegeInfo" : [ ]
      },
      "DBName" : "testdb2"
    } ]
  }
}

Códigos de erro

HTTP status code

Error code

Error message

Description

400

Database.ConnectError

Database connect error. please check instance status and database processlist

Erro retornado devido a uma conexão anormal com o banco de dados. Verifique o status da instância e o pool de conexões do banco de dados.

400

Database.QueryError

Query Db failed, please check input value and instance status

Erro retornado devido a falha na consulta ao banco de dados. Verifique os parâmetros de entrada e o status da instância.

Para obter uma lista de códigos de erro, visite o API Error Center.