Todos os produtos
Search
Central de documentação

Bastionhost:GetDatabase

Última atualização: Sep 20, 2026

Obtém os detalhes de um banco de dados 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

yundun-bastionhost:GetDatabase

get

*Todos os recursos.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

InstanceId

string

Sim

O ID da instância do Bastionhost na qual o banco de dados reside.

Nota

Você pode chamar a operação DescribeInstances para obter o valor deste parâmetro.

bastionhost-cn-wwo36qbv601

RegionId

string

Não

O ID da região do Bastionhost na qual o banco de dados reside.

Nota

Para o mapeamento entre IDs de região e nomes de região, consulte Regiões e zonas.

cn-hangzhou

DatabaseId

string

Sim

O ID do banco de dados a ser consultado.

Nota

Você pode chamar a operação ListDatabases para obter o valor deste parâmetro.

21

ProjectId

integer

Não

O ID do projeto.

3

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Database

object

Os detalhes da instância do banco de dados.

ActiveAddressType

string

O tipo de endereço da instância do banco de dados. Valores válidos:

  • Public: endereço público.

  • Private: endpoint privado. O banco de dados é acessado por uma rede privada.

Public

Comment

string

A descrição da instância do banco de dados.

comment

DatabaseId

string

O ID da instância do banco de dados.

22

DatabaseName

string

O nome da instância do banco de dados.

test

DatabasePort

integer

A porta do banco de dados.

3306

DatabasePrivateAddress

string

O endpoint privado da instância do banco de dados. O banco de dados é acessado por uma rede privada.

rm-bp1zq******

DatabasePublicAddress

string

O endereço público da instância do banco de dados.

rm-uf65******

DatabaseType

string

O tipo do banco de dados. Valores válidos:

  • mysql

  • sqlserver

  • postgresql

  • oracle

MySQL

NetworkDomainId

string

O ID do domínio de rede ao qual o banco de dados pertence.

45

Source

string

A origem da instância do banco de dados. Valores válidos:

  • Local: uma instância de banco de dados local.

  • Rds: uma instância de banco de dados ApsaraDB RDS.

  • PolarDB: uma instância de banco de dados PolarDB.

Local

SourceInstanceId

string

O ID da instância ApsaraDB RDS ou PolarDB que corresponde ao banco de dados.

Nota

Se Source estiver definido como Local, este parâmetro retornará um valor vazio.

i-wz9527ob0e0nftcsffke

SourceInstanceRegionId

string

O ID da região da instância ApsaraDB RDS ou PolarDB que corresponde ao banco de dados.

cn-hangzhou

SourceInstanceState

string

O status da instância do banco de dados. Valores válidos:

  • Normal: normal.

  • Release: liberada.

Normal

RequestId

string

O ID da solicitação.

4D72B883-9D15-5B05-B987-DFD10EB1FFB4

Exemplos

Resposta de sucesso

JSON formato

{
  "Database": {
    "ActiveAddressType": "Public",
    "Comment": "comment",
    "DatabaseId": "22",
    "DatabaseName": "test",
    "DatabasePort": 3306,
    "DatabasePrivateAddress": "rm-bp1zq******",
    "DatabasePublicAddress": "rm-uf65******",
    "DatabaseType": "MySQL",
    "NetworkDomainId": "45",
    "Source": "Local",
    "SourceInstanceId": "i-wz9527ob0e0nftcsffke",
    "SourceInstanceRegionId": "cn-hangzhou",
    "SourceInstanceState": "Normal"
  },
  "RequestId": "4D72B883-9D15-5B05-B987-DFD10EB1FFB4"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 InvalidParameter The argument is invalid.
500 InternalError An unknown error occurred.
404 DatabaseNotFound The database is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.