Chame a operação DescribeDatabases para consultar informações dos bancos de dados de uma instância.
Se os parâmetros de solicitação especificados forem inválidos, nenhuma informação de banco de dados será retornada.
Depuração
Parâmetros de solicitação
| Parameter | Type | Required | Example | Description |
| Action | String | Yes | DescribeDatabases | Operação a ser executada. Defina o valor como DescribeDatabases. |
| DBInstanceId | String | Yes | rm-uf6wjk5xxxxxxx | ID da instância. |
| DBName | String | No | testDB01 | Nome do banco de dados. |
| DBStatus | String | No | Creating | Status do banco de dados. Valores válidos:
|
| PageSize | Integer | No | 30 | Número de entradas a serem retornadas em cada página. Valores válidos:
Valor padrão: 30. |
| PageNumber | Integer | No | 1 | Número da página a ser retornada. Valores válidos: qualquer número inteiro positivo diferente de zero. Valor padrão: 1. |
| ResourceGroupId | String | No | rg-acfmy***** | ID do grupo de recursos. |
Parâmetros de resposta
| Parameter | Type | Example | Description |
| RequestId | String | 2603CA96-B17D-4903-BC04-61A2C829CD94 | ID da solicitação. |
| Databases | Array of Database | Matriz com as informações dos bancos de dados. | |
| Database | |||
| DBDescription | String | Test database | Descrição do banco de dados. |
| DBStatus | String | Creating | Status do banco de dados. Valores válidos:
|
| DBName | String | testDB01 | Nome do banco de dados. |
| DBInstanceId | String | rm-uf6wjk5xxxxxxx | ID da instância à qual o banco de dados pertence. |
| Engine | String | MySQL | Mecanismo de banco de dados da instância à qual o banco de dados pertence. |
| CharacterSetName | String | utf8 | Nome do conjunto de caracteres. |
| Collate | String | C | 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. |
| Ctype | String | en_US.utf8 | Tipo do conjunto de caracteres. Nota Este parâmetro é retornado apenas para instâncias que executam PostgreSQL. |
| ConnLimit | String | -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. |
| Tablespace | String | pg_default | Tablespace do banco de dados. Nota Este parâmetro é retornado apenas para instâncias que executam PostgreSQL. |
| ResourceGroupId | String | rg-acfmy***** | ID do grupo de recursos. |
| Accounts | Array of AccountPrivilegeInfo | Matriz com os detalhes das contas. Cada conta possui permissões específicas no banco de dados. | |
| AccountPrivilegeInfo | |||
| Account | String | test | Nome de usuário da conta. |
| AccountPrivilege | String | DMLOnly | Permissões da conta no banco de dados. Valores válidos:
|
| AccountPrivilegeDetail | String | SELECT | Detalhes das permissões da conta no banco de dados. |
| PageNumber | Integer | 1 | Parâmetro reservado. |
| PageSize | Integer | 30 | Parâmetro reservado. |
| TotalCount | Integer | 100 | 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.