Consulta de instâncias de proxy
Função
Essa API é usada para consultar instâncias de proxy. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/instances/{instance_id}/proxies
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Explicação: ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. Restrições: Nenhuma Intervalo de valores: O valor pode conter 32 caracteres. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum |
instance_id |
Sim |
String |
Explicação: ID da instância, que identifica exclusivamente uma instância. Restrições: Nenhuma Intervalo de valores: O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
Integer |
Explicação: Deslocamento do índice. A consulta começa a partir da próxima parte dos dados indexados por este parâmetro. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: ≥0 Valor padrão: 0 |
limit |
Não |
Integer |
Explicação: Número de registros a serem consultados. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: 1–100 Valor padrão: 100 |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Explicação: Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. Restrições: Nenhuma Intervalo de valores: Nenhum Valor padrão: Nenhum |
X-Language |
Não |
String |
Explicação: Tipo de linguagem da solicitação. Restrições: Nenhuma Intervalo de valores:
Valor padrão: en-us |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
proxy_list |
Array of MysqlShowProxyResponseV3 objects |
Explicação: Instâncias de proxy. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
proxy |
MysqlProxyV3 object |
Explicação: Informações da instância de proxy. |
master_node |
MysqlProxyNodeV3 object |
Explicação: Informações do nó primário. |
readonly_nodes |
Array of MysqlProxyNodeV3 objects |
Explicação: Informações da réplica de leitura. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
pool_id |
String |
Explicação: ID da instância do proxy. Intervalo de valores: O valor pode conter 36 caracteres com um sufixo de po01. Apenas letras e dígitos são permitidos. |
status |
String |
Explicação: Status de uma instância de proxy. Intervalo de valores:
|
address |
String |
Explicação: Endereço IP do proxy. Intervalo de valores: Nenhum |
port |
Integer |
Explicação: Porta de uma instância de proxy. Intervalo de valores: Nenhum |
pool_status |
String |
Explicação: Status de uma instância de proxy. Intervalo de valores:
|
delay_threshold_in_seconds |
Integer |
Explicação: Limite de atraso em segundos. Intervalo de valores: Nenhum |
elb_vip |
String |
Explicação: Endereço IP virtual em modo de ELB. Intervalo de valores: Nenhum |
eip |
String |
Explicação: EIP. Intervalo de valores: Nenhum |
vcpus |
String |
Explicação: vCPUs de uma instância de proxy. Intervalo de valores: Nenhum |
ram |
String |
Explicação: Tamanho da memória de uma instância de proxy. Intervalo de valores: Nenhum |
node_num |
Integer |
Explicação: Número de nós de instância de proxy. Intervalo de valores: Nenhum |
mode |
String |
Explicação: Modo de instância de proxy. Intervalo de valores: Cluster |
nodes |
Array of MysqlProxyNodes objects |
Explicação: Nós de proxy de banco de dados. |
flavor_ref |
String |
Explicação: Especificações de instância de proxy. Intervalo de valores: Nenhum |
name |
String |
Explicação: Nome da instância do proxy. Intervalo de valores: Nenhum |
transaction_split |
String |
Explicação: Status da divisão de transação para a instância de proxy. Intervalo de valores:
|
connection_pool_type |
String |
Explicação: Tipo de pool de conexões. Intervalo de valores:
|
switch_connection_pool_type_enabled |
Boolean |
Explicação: Se a versão da instância de proxy suporta o pool de conexão de nível de sessão. Intervalo de valores:
|
route_mode |
Integer |
Explicação: Política de roteamento da instância de proxy. Intervalo de valores:
|
balance_route_mode_enabled |
Boolean |
Explicação: Se a versão da instância de proxy suporta balanceamento de carga. Intervalo de valores:
|
consistence_mode |
String |
Explicação: Nível de consistência. O parâmetro é deixado em branco por padrão. Intervalo de valores:
|
subnet_id |
String |
Explicação: ID da sub-rede à qual a instância de proxy pertence. Intervalo de valores: Nenhum |
ssl_option |
String |
Explicação: Se deve ativar o SSL. Intervalo de valores:
|
new_node_auto_add_status |
String |
Explicação: Se os novos nós são automaticamente associados a instâncias de proxy. Intervalo de valores:
|
new_node_weight |
Integer |
Explicação: Peso de leitura de um novo nó. Intervalo de valores: 1–1000 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Explicação: ID do nó de proxy. |
status |
String |
Explicação: Status do nó da instância de proxy. Intervalo de valores:
|
name |
String |
Explicação: Nome do nó da instância de proxy. Intervalo de valores: Nenhum |
role |
String |
Explicação: Função do nó de instância de proxy. Intervalo de valores:
|
az_code |
String |
Descrição AZ. Intervalo de valores: Nenhum |
frozen_flag |
Integer |
Explicação: Se o nó de instância de proxy está congelado. Intervalo de valores:
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Explicação: ID do nó da instância de proxy. Intervalo de valores: O valor pode conter 36 caracteres com um sufixo de no07. Apenas letras e dígitos são permitidos. |
instance_id |
String |
Explicação: ID da instância, que identifica exclusivamente uma instância. Intervalo de valores: O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos. |
status |
String |
Explicação: Status do nó. Intervalo de valores:
|
name |
String |
Explicação: Nome do nó. Intervalo de valores: Nenhum |
weight |
Integer |
Explicação: Peso de leitura do nó. Intervalo de valores: 1–1000 |
availability_zone |
Array of MysqlProxyAvailable objects |
Explicação: Informações da AZ. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
Explicação: Código de AZ. Intervalo de valores: Nenhum |
description |
String |
Explicação: Descrição da AZ. Intervalo de valores: Nenhum |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
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.