Consulta de informações de instância de proxy

Função

Essa API é usada para consultar informações de uma instância de proxy. Antes de chamar essa API:

Esta API estará indisponível em 31 de março de 2025. É aconselhável mudar as cargas de trabalho para a nova API (Consulta de instâncias de proxy) antes disso.

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

• instâncias de proxy não estão disponíveis para instâncias de BD em uma DeC.

URI

• Formato de URI

  GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/proxy

• Exemplo

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

• 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 numa 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
  proxy	Object	Informações da instância de proxy. Para mais detalhes, consulte Tabela 3.
  master_node	Object	Nó primário. Para mais detalhes, consulte Tabela 4.
  readonly_nodes	Array of Object	Informações da réplica de leitura. Para mais detalhes, consulte Tabela 5.

  Tabela 3 Descrição da estrutura de dados do campo proxy

  Nome	Tipo	Descrição
  pool_id	String	ID da instância do proxy.
  status	String	Se a instância de proxy está ativada. Pode ser closed, open, frozen, opening, closing, enlarging, freezing ou unfreezing.
  address	String	Endereço de divisão de leitura/gravação de proxy.
  port	Integer	Informações da porta de proxy.
  pool_status	String	Status da instância de proxy. Pode ser abnormal, normal, creating ou deleted.
  delay_threshold_in_seconds	Integer	Limite de atraso em segundos.
  elb_vip	String	Endereço IP virtual em modo de ELB.
  eip	String	Informações do EIP.
  vcpus	String	Número de vCPUs da instância de proxy.
  ram	String	Tamanho da memória da instância do proxy.
  node_num	Integer	Número de nós de proxy.
  mode	String	Modo de instância de proxy. O valor é Cluster.
  nodes	Object	Informações do nó de proxy. Para mais detalhes, consulte Tabela 6.
  flavor_ref	String	Código de especificação do proxy.

  Tabela 4 Descrição da estrutura de dados de master_node

  Nome	Tipo	Descrição
  id	String	ID do nó primário.
  instance_id	String	ID da instância de BD.
  status	String	Status do nó primário.
  name	String	Nome do nó primário.
  weight	Integer	Peso de divisão de leitura/gravação do nó primário.
  available_zones	Array of object	Informações da AZ. Para mais detalhes, consulte Tabela 7.

  Tabela 5 Descrição da estrutura de dados do campo readonly_nodes

  Nome	Tipo	Descrição
  id	String	ID da réplica de leitura.
  instance_id	String	ID da instância de BD.
  status	String	Status da réplica de leitura.
  name	String	Nome da réplica de leitura.
  weight	Integer	Peso de leitura de réplicas de leitura.
  available_zones	Array of object	Informações da AZ.

  Tabela 6 Descrição da estrutura de dados do campo nodes

  Nome	Tipo	Descrição
  id	String	ID do nó de proxy.
  status	String	Status do nó de proxy. Pode ser normal, abnormal, creating ou deleted.
  name	String	Nome do nó do proxy.
  role	String	Função do nó de proxy. Pode ser master ou slave.
  az_code	String	AZ.
  frozen_flag	Integer	Se o nó de proxy está congelado. Pode ser 0 (descongelado), 1 (congelado) ou 2 (excluído após ser congelado).

  Tabela 7 Descrição da estrutura de dados do campo available_zones

  Nome	Tipo	Descrição
  code	String	Código de AZ.
  description	String	Descrição da AZ.

• Exemplo de resposta normal

  {

  "proxy":{

  "pool_id":null,

  "status":"closed",

  "address":null,

  "port":null,

  "pool_status":null,

  "delay_threshold_in_seconds":null,

  "elb_vip":null,

  "eip":null,

  "vcpus":null,

  "ram":null,

  "node_num":null,

  "mode":null,

  "nodes":[

  ],

  "flavor_ref": "gaussdb.proxy.xlarge.arm.2"

  },

  "master_node":{

  "id":"294daeb0ec9e4c4eacaf2c6dbd8246a9no07",

  "instance_id":"71215aadf19c428db088e51b157583f2in07",

  "status":"ACTIVE",

  "name":"BUG-gauss-dw_node01",

  "weight":null,

  "available_zones":[

  {

  "code":"az1xahz",

  "description":"az1xahz"

  }

  ]

  },

  "readonly_nodes":[

  {

  "id":"b36d70cc3c3b4ef680e34c5b25b168dano07",

  "instance_id":"71215aadf19c428db088e51b157583f2in07",

  "status":"ACTIVE",

  "name":"BUG-gauss-dw_node02",

  "weight":null,

  "available_zones":[

  {

  "code":"az1xahz",

  "description":"az1xahz"

  }

  ]

  }

  ]

  }

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.