Todos os produtos
Search
Central de documentação

:ListDatabases

Última atualização: Jul 08, 2026

Use esta operação para consultar informações detalhadas dos bancos de dados em uma instância específica.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar o OpenAPI Explorer para chamar esta operação. Você pode pesquisar operações de API, chamá-las e gerar dinamicamente códigos de exemplo do SDK no OpenAPI Explorer.

Parâmetros de solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim ListDatabases

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

InstanceId String Sim 1

ID da instância. Obtenha este valor pelo ID retornado na operação ListInstances. Certifique-se de que não seja o ID de uma instância RDS.

PageNumber Integer Sim 1

Número da página retornada.

Tid Long Sim -1

ID do locatário.

Nota Obtenha o ID do locatário ao passar o ponteiro do mouse sobre sua foto de perfil. Para mais informações, consulte Visualizar informações do locatário .
PageSize Integer Não 10

Quantidade de entradas a retornar por página.

Parâmetros de resposta

Parâmetro Tipo Resposta de exemplo Descrição
DatabaseList Array of Database

Detalhes do banco de dados.

Database
CatalogName String 1

Nome do catálogo do banco de dados.

DatabaseId String 1

ID do banco de dados.

DbType String mysql

Tipo da instância de banco de dados.

DbaId String 1

ID do administrador de banco de dados (DBA).

DbaName String dba_user

Apelido do DBA.

Encoding String utf-8

Formato de codificação do banco de dados.

EnvType String dev

Tipo de ambiente do banco de dados.

Host String xxx.xxx.xxx.xxx

Endpoint da instância associada ao banco de dados.

InstanceId String 1

ID da instância associada ao banco de dados.

OwnerIdList List 1

ID do proprietário do banco de dados.

OwnerNameList List owner_name

Apelido do proprietário do banco de dados.

Port Integer 3306

Porta de conexão da instância associada ao banco de dados.

SchemaName String test

Nome do banco de dados.

SearchName String test@xxx.xxx.xxx.xxx:3306

Nome de consulta do banco de dados.

Sid String test

ID do sistema (SID) da instância associada ao banco de dados.

State String NORMAL

Status do banco de dados. Valores válidos:

  • NORMAL: banco de dados normal.
  • DISABLE: banco de dados desabilitado.
  • OFFLINE: banco de dados offline.
  • NOT_EXIST: banco de dados inexistente.
ErrorCode String UnknownError

Códigos de erro.

ErrorMessage String UnknownError

Mensagem de erro da falha.

RequestId String 5541CDA6-F674-435C-81BD-40C2FB926CE3

ID da solicitação.

Success Boolean true

Indica se a chamada foi bem-sucedida.

TotalCount Long 1

Quantidade total de bancos de dados na instância.

Exemplos

Exemplo de solicitação


     http(s)://[Endpoint]/? Action=ListDatabases &InstanceId=1 &PageNumber=1 &Tid=-1 &<common request parameters> 
   

Exemplos de respostas de sucesso

Formato XML


     <TotalCount> 1 </TotalCount> <RequestId> 5541CDA6-F674-435C-81BD-40C2FB926CE3 </RequestId> <Success> true </Success> <DatabaseList> <Database> <Encoding> utf8 </Encoding> <Host> pc-xxx.rwlb.rds.aliyuncs.com </Host> <InstanceId> 24710 </InstanceId> <DbType> polardb </DbType> <EnvType> product </EnvType> <OwnerIdList> <OwnerIds> 88653 </OwnerIds> </OwnerIdList> <DbaId> 104442 </DbaId> <OwnerNameList> <OwnerNames> dmstest </OwnerNames> </OwnerNameList> <Port> 3306 </Port> <DatabaseId> 116366 </DatabaseId> <State> NORMAL </State> <SearchName> xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306 [xxx_test] </SearchName> <DbaName> xxx [account] </DbaName> <SchemaName> xxx_test </SchemaName> </Database> </DatabaseList> 
   

JSON


     {"TotalCount": 1, "RequestId": "5541CDA6-F674-435C-81BD-40C2FB926CE3", "Success": true, "DatabaseList": { "Database": [ { "Encoding": "utf8", "Host": "pc-xxx.rwlb.rds.aliyuncs.com", "InstanceId": 24710, "DbType": "polardb", "EnvType": "product", "OwnerIdList": { " OwnerIds ": [ 88653 ] }, " DbaId ": 104442, " OwnerNameList ": { " OwnerNames ": [ " dmstest " ] }, " Port ": 3306, " DatabaseId ": 116366," State ": " NORMAL ", " SearchName ": 3306" xxx_test@pc-xxx.rwlb.rds.aliyuncs.com: [xxx_xxtest] "DbaName": "xxx [Ram user]", "SchemaName": "xxx_test" } ] } } 
   

Códigos de erro

Para mais informações sobre códigos de erro, consulte o centro de erros.