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 (recomendadas)/ Gerenciamento de instâncias/ Consulta de detalhes de uma instância de BD
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Consulta de detalhes de uma instância de BD

Função

Essa API é usada para consultar os detalhes de uma instância de BD especificada. Antes de usar essa API:

URI

GET /v3.1/{project_id}/instances/{instance_id}

Tabela 1 Parâmetros de URI

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto de um locatário numa região.

Para obter esse valor, consulte Obtenção de um ID de projeto.

instance_id

Sim

String

ID da instância, que é compatível com o formato UUID.

Parâmetros de solicitação

Tabela 2 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário.

Para obter esse valor, chame a API do IAM para obter um token de usuário.

O valor de X-Subject-Token no cabeçalho da resposta é o valor do token.

X-Language

Não

String

Tipo de linguagem da solicitação. O valor padrão é en-us.

Valores:

  • en-us
  • zh-cn

Parâmetros de resposta

Código de status: 200

Tabela 3 Parâmetro do corpo da resposta

Parâmetro

Tipo

Descrição

instance

MysqlInstanceInfoDetailUnifyStatus object

Informações da instância.
Tabela 4 MysqlInstanceInfoDetailUnifyStatus

Parâmetro

Tipo

Descrição

id

String

ID da instância, que é compatível com o formato UUID.

name

String

Nome da instância.

project_id

String

ID do projeto de um locatário numa região.

status

String

Status da instância.

Valores:

  • creating: a instância de BD está sendo criada.
  • normal: a instância está sendo executada corretamente.
  • abnormal: a instância está anormal.
  • createfail: falha ao criar a instância.

port

String

Porta do banco de dados.

alias

String

Descrição da instância.

type

String

Tipo de instância. O valor é Cluster.

charge_info

MysqlInstanceChargeInfo object

Modo de cobrança, que é anual/mensal ou pagamento por uso (configuração padrão).

node_count

Integer

Número de nós.

datastore

MysqlDatastoreWithKernelVersion object

Informações do banco de dados.

backup_used_space

Double

Espaço de backup usado em GB.

created

String

Hora de criação. O 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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

updated

String

Hora da atualização. O formato é o mesmo do campo created.

private_write_ips

Array of strings

Lista de endereços IP privados.

private_dns_names

Array of strings

Lista de nomes de domínios privados. Depois que uma instância de BD é criada, você precisa solicitar manualmente um nome de domínio privado, ou o nome de domínio privado é deixado em branco.

public_ips

String

EIPs.

db_user_name

String

Nome de usuário padrão.

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.

configuration_id

String

ID do modelo de parâmetro usado para criar uma instância de banco de dados ou ID do último modelo de parâmetro aplicado a uma instância de banco de dados.

backup_strategy

MysqlBackupStrategy object

Política de backup automatizado.

nodes

Array of MysqlInstanceNodeInfo objects

Informações do nó.

enterprise_project_id

String

ID do projeto empresarial.

time_zone

String

Fuso horário.

az_mode

String

Tipo de AZ.

Valores:

  • single: AZ única
  • multi: várias AZs

master_az_code

String

AZ primária.

maintenance_window

String

Janela de manutenção no formato UTC.

tags

Array of MysqlTags objects

Tags de instância.

dedicated_resource_id

String

ID do pool de recursos dedicado. Esse parâmetro é retornado somente quando a instância pertence a um pool de recursos dedicado.

proxies

Array of MysqlProxyInfo objects

Informações do proxy.

tde_info

MysqlTdeInfo object

Configuração do TDE. Os algoritmos AES 256 e SM4 são compatíveis.

O TDE está na fase de teste beta aberto (OBT). Para usá-la, envie um tíquete de serviço.
Tabela 5 MysqlInstanceChargeInfo

Parâmetro

Tipo

Descrição

charge_mode

String

Modo de cobrança.

order_id

String

ID do pedido. Este parâmetro é retornado somente para instâncias anuais/mensais.
Tabela 6 MysqlDatastoreWithKernelVersion

Parâmetro

Tipo

Descrição

type

String

Mecanismo de BD. Atualmente, apenas o gaussdb-mysql é suportado.

version

String

Versão de BD.

kernel_version

String

Versão do kernel do banco de dados.
Tabela 7 MysqlBackupStrategy

Parâmetro

Tipo

Descrição

start_time

String

Hora de início do backup automatizado. A criação de um backup automatizado será acionada dentro de uma hora após o horário especificado por este parâmetro.

O valor não pode ser vazio. Deve ser um valor válido no formato "hh:mm-HH:MM". A hora atual está no formato UTC.

  1. O valor de HH deve ser 1 maior que o valor de hh.
  2. Os valores de mm e MM devem ser os mesmos e devem ser definidos como 00.

keep_days

String

Dias de retenção de backup automatizado. Intervalo de valores: 1–732.
Tabela 8 MysqlInstanceNodeInfo

Parâmetro

Tipo

Descrição

id

String

ID da instância, que é compatível com o formato UUID.

name

String

Nome do nó.

type

String

Tipo de nó.

Valores:

  • master: nó primário
  • slave: réplica de leitura

status

String

Status do nó.

port

Integer

Porta do banco de dados.

private_read_ips

Array of strings

Endereços IP privados para leitura de nós.

volume

MysqlInstanceNodeVolumeInfo object

Informações do disco de armazenamento.

az_code

String

AZ.

region_code

String

Região onde a instância está localizada.

created

String

Hora de criação. O 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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

updated

String

Hora da atualização. O formato é o mesmo do campo created.

flavor_id

String

ID da especificação.

flavor_ref

String

Código de especificação.

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 reiniciar a instância para que as modificações de parâmetro entrem em vigor.

priority

Integer

Prioridade de failover.
Tabela 9 MysqlInstanceNodeVolumeInfo

Parâmetro

Tipo

Descrição

type

String

Tipo de disco.

used

String

Tamanho do disco usado em GB.

size

Long

Tamanho do disco da instância anual/mensal em GB.
Tabela 10 MysqlTags

Parâmetro

Tipo

Descrição

key

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.

value

String

Valor da tag. Pode conter até 43 caracteres Unicode e pode ser uma cadeia vazia.

Somente letras maiúsculas, letras minúsculas, dígitos, pontos (.), hifens (-) e sublinhados (_) são permitidos.
Tabela 11 MysqlProxyInfo

Parâmetro

Tipo

Descrição

pool_id

String

ID da instância do proxy.

name

String

Nome da instância do proxy.

address

String

Endereço de divisão de leitura/gravação de proxy.
Tabela 12 MysqlTdeInfo

Parâmetro

Tipo

Descrição

enable_tde

Boolean

Se o TDE deve ser ativado.

encryption_type

String

Algoritmo TDE. Os algoritmos AES 256 e SM4 são compatíveis.

Código de status: 400

Tabela 13 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 14 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitação

Consulta de detalhes de uma instância de BD especificada

GET https://{endpoint}/v3.1/3cedfc54-b105-4652-a4e0-847b11576628/instances/d738399de028480fabb2b8120d4e01a4in07

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "instance" : {
    "id" : "d738399de028480fabb2b8120d4e01a4in07",
    "name" : "gaussdb-mysql-instance01",
    "alias" : "",
    "status" : "normal",
    "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628",
    "enterprise_project_id" : 0,
    "type" : "Cluster",
    "charge_info" : {
      "charge_mode" : "postPaid",
      "order_id" : ""
    },
    "node_count" : 2,
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0",
      "kernel_version" : "2.0.29.1"
    },
    "created" : "2022-07-14T16:26:58+0800",
    "updated" : "2022-07-18T14:20:33+0800",
    "public_ips" : "10.*.*.*",
    "private_write_ips" : [ "192.*.*.*" ],
    "private_dns_names" : [ "d738399de028480fabb2b8120d4e01a4in07.internal.cn-xianhz-1.gaussdbformysql.myhuaweicloud.com" ],
    "db_user_name" : "root",
    "port" : 3306,
    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
    "backup_strategy" : {
      "start_time" : "19:00-20:00",
      "keep_days" : 7
    },
    "nodes" : [ {
      "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07",
      "name" : "gauss-d616-lb07_node01",
      "type" : "master",
      "status" : "normal",
      "port" : 3306,
      "private_read_ips" : [ "192.*.*.*" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1",
      "region_code" : "region-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.arm.4",
      "max_connections" : 1500,
      "vcpus" : 1,
      "ram" : 4,
      "need_restart" : false,
      "priority" : 1,
      "created" : "2022-07-14T16:26:58+0800",
      "updated" : "2022-07-18T09:24:18+0800"
    }, {
      "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07",
      "name" : "gauss-d616-lb07_node02",
      "type" : "slave",
      "status" : "normal",
      "port" : 3306,
      "private_read_ips" : [ "192.*.*.*" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1*",
      "region_code" : "region-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.arm.4",
      "max_connections" : 1500,
      "vcpus" : 1,
      "ram" : 4,
      "need_restart" : false,
      "priority" : 1,
      "created" : "2022-07-14T16:26:58+0800",
      "updated" : "2022-07-18T09:36:18+0800"
    } ],
    "time_zone" : "UTC+08:00",
    "backup_used_space" : 0.24,
    "az_mode" : "single",
    "master_az_code" : "az1",
    "maintenance_window" : "18:00-22:00",
    "tags" : [ ],
    "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07",
    "dedicated_resource_id" : "",
    "proxies" : [ {
      "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01",
      "address" : "192.*.*.*",
      "name" : "proxy-name"
    } ]
  }
}

Código de status

Código de status

Descrição

200

Bem-sucedido.

400

Erro do cliente.

500

Erro no servidor.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: Gerenciamento de instâncias