Todos os produtos
Search
Central de documentação

:GetDatabase

Última atualização: Jul 08, 2026

Consulta os detalhes de um banco de dados.

Depuração

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

Parâmetros de solicitação

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

A operação a ser executada. Defina o valor como GetDatabase.

Host String Sim xxx.xxx.xxx.xxx

O endereço de conexão da instância.

Port Integer Sim 3306

A porta usada para conectar à instância.

SchemaName String Sim test_db

O nome do banco de dados.

Tid Long Sim -1

O 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 .
Sid String Não test_sid

O ID do sistema (Sid) da instância.

Parâmetros de resposta

Parâmetro

Tipo

Resposta de exemplo

Descrição

Database

Struct

As informações detalhadas do banco de dados.

CatalogName

String

def

CatalogName

DatabaseId

String

1

O ID do banco de dados.

DbType

String

mysql

O tipo da instância de banco de dados.

DbaId

String

1

ID do DBA

DbaName

String

dba_name

O apelido do DBA.

Encoding

String

utf8mb4

O formato de codificação do banco de dados.

EnvType

String

test

O tipo de ambiente ao qual o banco de dados pertence.

Host

String

xxx.xxx.xxx.xxx

O endpoint da instância de banco de dados.

InstanceId

String

1

O ID da instância de banco de dados.

OwnerIdList

List

1

O ID de um proprietário do banco de dados.

OwnerNameList

List

test

O apelido de um proprietário do banco de dados.

Port

Integer

3306

A porta de conexão da instância de banco de dados.

SchemaName

String

test_db

O nome do banco de dados.

SearchName

String

test_db@xxx.xxx.xxx.xxx:3306

O nome de consulta do banco de dados.

Sid

String

test_sid

O SID da instância de banco de dados.

State

String

NORMAL

O status do banco de dados. Para obter mais informações sobre os valores válidos, consulte a descrição da operação ListDatabases.

ErrorCode

String

UnknownError

Os códigos de erro.

ErrorMessage

String

UnknownError

A mensagem de erro da falha.

RequestId

String

3CDB8601-AD74-4A47-8114-08E08CD6319D

O ID da solicitação.

Success

Boolean

true

Indica se a solicitação foi bem-sucedida.

Exemplos

Exemplo de solicitação


     http(s)://[Endpoint]/? Action=GetDatabase &Host=xxx.xxx.xxx.xxx &Port=3306 &SchemaName=test_db &Tid=-1 &<common request parameters> 
   

Exemplos de respostas de sucesso

Formato XML


     <Database> <Encoding> utf8mb4 </Encoding> <Host> pc-xxx.rwlb.rds.aliyuncs.com </Host> <InstanceId> 24710 </InstanceId> <DbType> polardb </DbType> <OwnerIdList> <OwnerIds> 88653 </OwnerIds> <OwnerIds> 104442 </OwnerIds> </OwnerIdList> <EnvType> product </EnvType> <DbaId> 104442 </DbaId> <OwnerNameList> <OwnerNames> xxx </OwnerNames> <OwnerNames> xxx [account] </OwnerNames> </OwnerNameList> <Port> 3306 </Port> <DatabaseId> 116367 </DatabaseId> <State> NORMAL </State> <SearchName> xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306[xxx_test] </SearchName> <DbaName> xxx [sub-account] </DbaName> <SchemaName> xxx_test </SchemaName> </Database> <RequestId> returns </RequestId> <Success> true </Success> 
   

JSON


     {"Database": { "Encoding": "utf8mb4", "Host": "pc-xxx.rwlb.rds.aliyuncs.com", "InstanceId": 24710, "DbType": "polardb", "OwnerIdList": { "OwnerIds": [ 88653, 104442 ] }, "EnvType": "product", "DbaId": 104442, "OwnerNameList": { "OwnerNames": ["xxx", "xxx [Ram user]" ] }, "Port": 3306, "DatabaseId": 116377, "State": "NORMAL", "SearchName": "xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306 [xxx_test]", "DbaName": "xxx [Ram user]", "SchemaName": "xxx_test" }, "RequestId": "Success", "Success": true} 
   

Códigos de erro

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