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/ GaussDB(for MySQL)/ 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 BD especificada. Antes de chamar essa API:

Essa API estará indisponível em 31 de dezembro de 2024.

URI

GET /v3/{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.

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. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token.
X-Language	Não	String	Tipo de linguagem da solicitação. O valor padrão é en-us. Valor: en-us zh-cn

Parâmetros de resposta

Código de status: 200

**Tabela 3** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
instance	MysqlInstanceInfoDetail object	Informações da instância.

**Tabela 4** MysqlInstanceInfoDetail
Parâmetro	Tipo	Descrição
id	String	ID da instância.
name	String	Nome da instância de BD.
project_id	String	ID do projeto de um locatário numa região.
status	String	Status da instância de BD. Valor: BUILD: a instância de BD está sendo criada. ACTIVE: a instância de BD está normal. FAILED: a instância do BD está anormal. FROZEN: a instância de BD está congelada. MODIFYING: a instância de BD está sendo ampliada. REBOOTING: a instância de BD está sendo reinicializada. RESTORING: a instância de BD está sendo restaurada. MODIFYING INSTANCE TYPE: a instância de BD está mudando de primária para em espera. SWITCHOVER: uma alternância primária/em espera está sendo realizada. MIGRATING: a instância de BD está sendo migrada. BACKING UP: o backup da instância de BD está sendo feito. MODIFYING DATABASE PORT: a porta do banco de dados está sendo alterada. STORAGE FULL: o espaço de armazenamento da instância de BD está cheio.
port	String	Porta do banco de dados.
alias	String	Observações de instância.
type	String	Tipos 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	MysqlDatastore object	Informações do banco de dados.
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. NOTA: O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio.
updated	String	Hora da atualização. O formato é o mesmo do campo created. NOTA: O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio.
private_write_ips	Array of strings	Endereço IP privado para gravação.
private_dns_names	Array of strings	Nomes de domínio privados da instância. Depois que uma instância de BD for criada, você precisará solicitar manualmente um nome de domínio privado ou o nome de domínio privado será deixado em branco.
public_ips	String	Endereço IP público da instância.
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 ou ID do último modelo de parâmetro aplicado a uma instância.
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. Valor: 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 para gerenciar instâncias.
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 da instância de proxy.

**Tabela 5** MysqlInstanceChargeInfo
Parâmetro	Tipo	Descrição
charge_mode	String	Modo de cobrança.
order_id	String	ID do pedido.

**Tabela 6** MysqlDatastoreWithKernelVersion
Parâmetro	Tipo	Descrição
type	String	Mecanismo de BD. Atualmente, apenas gaussdb-mysql é suportado.
version	String	Versão de BD. Para obter detalhes sobre as versões de BD suportadas, consulte Consulta de informações de versão sobre um mecanismo 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. O backup automatizado será acionado 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. O valor de HH deve ser 1 maior que o valor de hh. 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. Valor: 1-732.

**Tabela 8** MysqlInstanceNodeInfo
Parâmetro	Tipo	Descrição
id	String	ID da instância.
name	String	Nome do nó.
type	String	Tipo de nó. Valor: 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ço IP privado para leitura do nó.
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	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. NOTA: O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio.
updated	String	Hora da atualização. O formato é o mesmo do campo created. NOTA: O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio.
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. Contém um máximo de 43 caracteres Unicode. O valor pode ser uma cadeia de caracteres 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 uma instância de proxy

Código de status: 400

**Tabela 12** 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 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.

Exemplo de solicitação

Consulta de detalhes de uma instância de BD especificada

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

Exemplo de resposta

Código de status: 201

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

Bem-sucedido.

{
  "instance" : {
    "id" : "d738399de028480fabb2b8120d4e01a4in07",
    "name" : "gaussdb-mysql-instance01",
    "alias" : "",
    "status" : "ACTIVE",
    "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.154.219.187" ],
    "private_write_ips" : [ "192.168.0.142" ],
    "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" : "ACTIVE",
      "port" : 3306,
      "private_read_ips" : [ "192.168.0.163" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1xahz",
      "region_code" : "cn-xianhz-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.x86.4",
      "max_connections" : 1500,
      "vcpus" : 4,
      "ram" : 16,
      "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" : "ACTIVE",
      "port" : 3306,
      "private_read_ips" : [ "192.168.0.162" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1xahz",
      "region_code" : "cn-xianhz-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysqlxlarge.arm.2.ha",
      "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.168.10.76",
      "name" : "proxy-name"
    } ]
  }
}

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: Exclusão de uma instância de BD

Próximo tópico: Consulta de detalhes de instâncias de BD em lotes

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