Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ TaurusDB/ Referência de API/ APIs (indisponível em breve)/ Gerenciamento de instâncias/ Consulta de detalhes de uma instância de BD

Atualizado em 2024-09-29 GMT+08:00

Ver PDF

Consulta de detalhes de uma instância de BD

Função

Essa API é usada para consultar os detalhes de uma instância de banco de dados especificada. Antes de chamar essa API:

Essa API estará indisponível em 31 de março de 2024. É aconselhável mudar as cargas de trabalho para a nova API (Consulta de detalhes de uma instância de BD) antes disso.

Saiba como autorizá-la e autenticá-la.
Obtenha a região e o ponto de extremidade necessários.

URI

Formato de URI
GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}
Exemplo
GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

Descrição do parâmetro

**Tabela 1** Descrição do parâmetro
Nome	Tipo	Obrigatório	Descrição
project_id	String	Sim	ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto.
instance_id	String	Sim	ID da instância de BD.

Solicitação

Nenhuma.

Resposta

Resposta normal

**Tabela 2** Descrição do parâmetro
Nome	Tipo	Descrição
instance	Object	Informações da instância. Para mais detalhes, consulte Tabela 3.

**Tabela 3** Descrição da estrutura de dados do campo instance
Nome	Tipo	Descrição
id	String	ID da instância de BD.
name	String	Nome da instância de BD.
project_id	String	ID do projeto de um locatário em uma região.
status	String	Status da instância de BD. Valor válido: Se o valor for BUILD, a instância de banco de dados está sendo criada. Se o valor for ACTIVE, a instância de banco de dados está normal. Se o valor for FAILED, a instância de banco de dados está anormal. Se o valor for FROZEN, a instância de banco de dados está congelada. Se o valor for MODIFYING, a instância de banco de dados está sendo dimensionada. Se o valor for REBOOTING, a instância de banco de dados está sendo reinicializada. Se o valor for RESTORING, a instância de banco de dados está sendo restaurada. Se o valor for MODIFYING INSTANCE TYPE, a instância de banco de dados está mudando de primária para em espera. Se o valor for SWITCHOVER, a alternância primária/em espera está sendo executada. Se o valor for MIGRATING, a instância de banco de dados está sendo migrada. Se o valor for BACKING UP, o backup da instância de banco de dados está sendo feito. Se o valor for MODIFYING DATABASE PORT, a porta do banco de dados está sendo alterada. Se o valor for STORAGE FULL, o espaço de armazenamento da instância está cheio.
enterprise_project_id	String	ID do projeto empresarial.
type	String	Tipo de instância de BD. Atualmente, apenas o tipo de cluster é suportado.
node_count	Integer	Número de nós.
datastore	Object	Informações do banco de dados. Para mais detalhes, consulte Tabela 4.
backup_used_space	Double	Espaço de backup usado em GB.
created	String	Tempo de criação no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800. O valor fica vazio, a menos que a criação da instância esteja concluída.
updated	String	Hora da atualização. O formato é o mesmo do campo created. O valor fica vazio, a menos que a criação da instância esteja concluída.
public_ips	String	Endereço IP público da instância.
private_write_ips	Array of List	Endereço IP privado para gravação.
db_user_name	String	Nome de usuário padrão.
port	String	Porta do banco de dados.
vpc_id	String	ID de VPC
subnet_id	String	ID de rede da sub-rede.
security_group_id	String	ID do grupo de segurança.
volume	Object	Informações do disco. Para mais detalhes, consulte Tabela 7.
backup_strategy	Object	Política de backup. Para mais detalhes, consulte Tabela 5.
nodes	Arrays of object	Informações do nó. Para mais detalhes, consulte Tabela 6.
time_zone	String	Fuso horário.
az_mode	String	Tipo de AZ. Pode ser single ou multi.
master_az_code	String	AZ primária.
maintenance_window	String	Janela de manutenção no formato UTC.
configuration_id	String	ID do modelo de parâmetro usado para criar uma instância ou ID do último modelo de parâmetro aplicado a uma instância.
tags	Arrays of object	Tags para gerenciar instâncias. Para mais detalhes, consulte Tabela 8.

**Tabela 4** Descrição da estrutura de dados do campo datastore
Nome	Tipo	Descrição
type	String	Mecanismo de BD.
version	String	Versão de BD.

**Tabela 5** Descrição da estrutura de dados do campo backup_strategy
Nome	Tipo	Descrição
start_time	String	Janela de tempo de backup. Os backups automatizados serão acionados durante a janela de tempo de backup.
keep_days	Integer	Dias de retenção de backup.

**Tabela 6** Descrição da estrutura de dados do campo nodes
Nome	Tipo	Descrição
id	String	ID do nó.
name	Array of object	Nome do nó.
type	String	Tipo de nó, que pode ser master ou slave.
status	String	Status do nó.
port	Integer	Porta do banco de dados.
private_read_ips	Array of String	Endereço IP privado para leitura.
volume	Object	Informações do disco.
az_code	String	AZ.
region_code	String	Região onde a instância de banco de dados é implementada.
created	String	Tempo de criação da instância de banco de dados.
updated	String	Hora da atualização.
flavor_ref	String	Código de especificação. Para mais detalhes, consulte Tabela 3.
max_connections	String	Número máximo de conexões.
vcpus	String	Número de vCPUs.
ram	String	Tamanho da memória em GB.
need_restart	Boolean	Se reinicializar a instância de banco de dados para que as modificações tenham efeito.
priority	String	Prioridade de failover.

**Tabela 7** Descrição da estrutura de dados do campo volume
Nome	Tipo	Descrição
type	String	Tipo de armazenamento. Atualmente, apenas o POOL é suportado.
used	String	Tamanho de armazenamento usado em GB.

**Tabela 8** Descrição da estrutura de dados do campo tags
Nome	Tipo	Descrição
type	String	Chave da tag. O valor pode conter no máximo 36 caracteres Unicode. O valor não pode ser uma cadeia vazia, um espaço ou deixado em branco. Apenas letras maiúsculas, letras minúsculas, dígitos, hifens (-) e sublinhados (_) são permitidos.
used	String	Valor da tag. O valor contém um máximo de 43 caracteres Unicode e também pode ser uma cadeia de caracteres vazia. Somente letras maiúsculas, letras minúsculas, dígitos, pontos (.), hifens (-) e sublinhados (_) são permitidos.

Os valores de region_code e az_code são usados como exemplos.

Exemplo de resposta normal

{
  "instance": {
    "id": "d2cda7b97a39488e8b30e3cea4066204in07",
    "name": "gauss-d616-lb07",
    "status": "FAILED",
    "project_id": "053f533ead80d5102f0cc012e8d468a4",
    "enterprise_project_id": "0",
    "type": "Cluster",
    "charge_info": {
      "charge_mode": "postPaid",
      "order_id": ""
    },
    "node_count": 2,
    "datastore": {
      "type": "GaussDB(for MySQL)",
      "version": "8.0"
    },
    "created": "2020-07-21T09:13:56+0800",
    "updated": "2020-07-21T09:27:54+0800",
    "public_ips": "",
    "private_write_ips": [
      "192.168.0.235"
    ],
    "db_user_name": "root",
    "port": "3306",
    "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
    "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
    "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902",
    "backup_strategy": {
      "start_time": "00:00-00:00",
      "keep_days": "0"
    },
    "nodes": [
      {
        "id": "799a0f2fa49a4151bf9f7063c1fbba36no07",
        "name": "gauss-d616-lb07_node01",
        "type": "master",
        "status": "FAILED",
        "port": 3306,
        "private_read_ips": [
          "192.168.0.163"
        ],
        "volume": {
          "type": "POOL",
          "used": "0.0"
        },
        "az_code": "az1xahz",
        "region_code": "cn-xianhz-1",
        "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
        "flavor_ref": "gaussdb.large.4",
        "max_connections": null,
        "vcpus": "1",
        "ram": "4",
        "need_restart": false,
        "priority": 1
      },
      {
        "id": "816459d771c444db9fa4c1d5c173cb1cno07",
        "name": "gauss-d616-lb07_node02",
        "type": "slave",
        "status": "FAILED",
        "port": 3306,
        "private_read_ips": [
          "192.168.0.160"
        ],
        "volume": {
          "type": "POOL",
          "used": "0.0"
        },
        "az_code": "az1xahz",
        "region_code": "cn-xianhz-1",
        "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
        "flavor_ref": "gausssdb.large.4",
        "max_connections": null,
        "vcpus": "1",
        "ram": "4",
        "need_restart": false,
        "priority": 1
      }
    ],
    "time_zone": "UTC+08:00",
    "backup_used_space": 0,
    "az_mode": "single",
    "master_az_code": "az1xahz",
    "maintenance_window": "18:00-22:00"
  }
}

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: Gerenciamento de instâncias

Tópico anterior: Consulta de detalhes de instâncias de BD em lotes

Próximo tópico: Criação de uma réplica de leitura

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar