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 (recomendadas)/ Proxy do banco de dados/ Consulta de instâncias de proxy
Atualizado em 2024-09-29 GMT+08:00
Ver PDF
Compartilhar

Consulta de instâncias de proxy

Função

Essa API é usada para consultar instâncias de proxy. Antes de chamar essa API:

URI

GET /v3/{project_id}/instances/{instance_id}/proxies

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.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

offset

Não

Integer

Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo.

limit

Não

Integer

Número de registros a serem consultados. O valor padrão é 10. O valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100.

Parâmetros de solicitação

Tabela 3 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 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

proxy_list

Array of MysqlShowProxyResponseV3 objects

Instâncias de proxy.
Tabela 5 MysqlShowProxyResponseV3

Parâmetro

Tipo

Descrição

proxy

MysqlProxyV3 object

Informações da instância de proxy.

master_node

MysqlProxyNodeV3 object

Informações do nó primário.

readonly_nodes

Array of MysqlProxyNodeV3 objects

Informações da réplica de leitura.
Tabela 6 MysqlProxyV3

Parâmetro

Tipo

Descrição

pool_id

String

ID da instância do proxy.

status

String

Status operacional da instância de proxy.

Valor:

  • ACTIVE: a instância de proxy é normal.
  • FAILED: a instância de proxy falha ao ser criada.
  • DELETED: a instância de proxy é excluída.
  • ABNORMAL: a instância de proxy é anormal.
  • ENABLING PROXY: a instância do proxy está sendo criada.
  • DISABLING PROXY: a instância de proxy está sendo excluída.
  • ADDING PROXY NODE: os nós estão sendo adicionados à instância de proxy.
  • DELETING READ REPLICAS FROM PROXY: as réplicas de leitura estão sendo removidas da instância de proxy.
  • ADDING READ REPLICAS TO PROXY: réplicas de leitura estão sendo adicionadas à instância de proxy.
  • CHANGING WEIGHTS: os pesos das réplicas de leitura para a instância de proxy estão sendo alterados.

address

String

Endereço de divisão de leitura/gravação.

port

Integer

Porta de divisão de leitura/gravação.

pool_status

String

Status da instância de proxy.

Valor:

  • ACTIVE: a instância de proxy é normal.
  • ABNORMAL: a instância de proxy é anormal.
  • FAILED: falha na instância do proxy.
  • DELETED: a instância de proxy foi excluída.

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ós da instância de proxy.

mode

String

Proxy primário/em espera. O valor é Cluster.

nodes

Array of MysqlProxyNodes objects

Informações do nó de proxy.

flavor_ref

String

Especificações de instância de proxy.

name

String

Nome da instância do proxy.

transaction_split

String

Se a divisão de transação de proxy está ativada.

Valor:

  • ON: a divisão da transação está ativada.
  • OFF: a divisão da transação está desativada.

connection_pool_type

String

Tipo de pool de conexões.

Valor:

  • CLOSED: o pool de conexões não é usado.
  • SESSION: o pool de conexão de nível de sessão é usado.

switch_connection_pool_type_enabled

Boolean

Se a versão do proxy suporta o pool de conexão de nível de sessão.

Valor:

  • true: suportado
  • false: não suportado

route_mode

Integer

Política de roteamento da instância de proxy.

Valor:

  • 0 (valor padrão): ponderado
  • 1: balanceamento de carga (o nó primário não processa solicitações de leitura.)
  • 2: balanceamento de carga (o nó primário processa solicitações de leitura.)

balance_route_mode_enabled

Boolean

Se a versão do proxy do banco de dados suporta balanceamento de carga.

Valor:

  • true: suportado
  • false: não suportado

consistence_mode

String

Modo de consistência. O valor padrão está vazio. Neste caso, o valor de session_consistence é usado.

Valor:

  • session: consistência da sessão
  • global: consistência global
  • eventual: consistência eventual

subnet_id

String

ID da sub-rede à qual a instância do proxy pertence.

ssl_option

String

Se deve ativar o SSL.

Valor:

  • true: o SSL está ativado.
  • false: o SSL está desativado.
Tabela 7 MysqlProxyNodes

Parâmetro

Tipo

Descrição

id

String

ID do nó de proxy.

status

String

Status do nó de proxy.

Valor:

  • ACTIVE: o nó está disponível.
  • ABNORMAL: o nó está anormal.
  • FAILED: o nó falha.
  • DELETED: o nó foi excluído.

name

String

Nome do nó do proxy.

role

String

Nome do nó do proxy.

Valor:

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

az_code

String

AZ.

frozen_flag

Integer

Se o nó de proxy está congelado.

Valor:

  • 0: descongelado
  • 1: congelado
  • 2: excluído depois de ser congelado
Tabela 8 MysqlProxyNodeV3

Parâmetro

Tipo

Descrição

id

String

ID do nó.

instance_id

String

ID da instância.

status

String

Status do nó.

name

String

Nome do nó.

weight

Integer

Peso de leitura do nó.

availability_zone

Array of MysqlProxyAvailable objects

Informações da AZ.
Tabela 9 MysqlProxyAvailable

Parâmetro

Tipo

Descrição

code

String

Código de AZ.

description

String

Descrição da AZ.

Código de status: 400

Tabela 10 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 11 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 instâncias de proxy

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxies?offset=0&limit=10

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "proxy_list" : [ {
    "proxy" : {
      "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01",
      "status" : "ACTIVE",
      "address" : "192.168.125.69",
      "port" : 3306,
      "pool_status" : "ACTIVE",
      "delay_threshold_in_seconds" : 30,
      "elb_vip" : "192.168.125.60",
      "eip" : "192.168.125.50",
      "vcpus" : 4,
      "ram" : 8,
      "node_num" : 2,
      "mode" : "Cluster",
      "nodes" : [ {
        "id" : "db53a238a02240c49365e72e284a4890pn01",
        "name" : "PROXY-2e7cf21d14794bafab623a334efd9ad8po01_0",
        "role" : "master",
        "az_code" : "az1xahz",
        "status" : "ACTIVE",
        "frozen_flag" : 0
      } ],
      "name" : "proxy-name",
    
      "connection_pool_type" : "SESSION", 
      "switch_connection_pool_type_enabled" : true ,
      "subnet_id" : "6991d82d-9166-4aff-a1fa-d2a8748b7084"
    },
    "master_node" : {
      "id" : "c01a5645eb2c4fb6a9373542f5366e50no07",
      "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
      "status" : "ACTIVE",
      "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01",
      "weight" : 0,
      "availability_zone" : [{
        "code" : "az1",
        "description": "AZ1"
      }]
    },
    "readonly_nodes" : {
      "id" : "d23535333138462880bfa1838fdfced2no07",
      "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
      "status" : "ACTIVE",
      "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02",
      "weight" : 100,
      "availability_zone" : [{
        "code" : "az1",
        "description": "AZ1"
      }]
    }
  } ]
}

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: Proxy do banco de dados