Querying Proxy Instances

Function

This API is used to query proxy instances. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be a non-negative integer. Range ≥ 0 Default Value 0
limit	No	Integer	Definition Number of records to be queried. Constraints The value must be a non-negative integer. Range 1–100 Default Value 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
proxy_list	Array of MysqlShowProxyResponseV3 objects	Definition Proxy instances.

**Table 5** MysqlShowProxyResponseV3
Parameter	Type	Description
proxy	MysqlProxyV3 object	Definition Proxy instance information.
master_node	MysqlProxyNodeV3 object	Definition Primary node information.
readonly_nodes	Array of MysqlProxyNodeV3 objects	Definition Read replica information.

**Table 6** MysqlProxyV3
Parameter	Type	Description
pool_id	String	Definition Proxy instance ID. Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed.
status	String	Definition Status of a proxy instance. Range ACTIVE: The proxy instance is normal. FAILED: The proxy instance failed to be created. DELETED: The proxy instance has been deleted. ABNORMAL: The proxy instance is abnormal. ENABLING PROXY: The proxy instance is being created. DISABLING PROXY: The proxy instance is being deleted. ADDING PROXY NODE: Nodes are being added to the proxy instance. DELETING READ REPLICAS FROM PROXY: Read replicas are being removed from the proxy instance. ADDING READ REPLICAS TO PROXY: Read replicas are being added to the proxy instance. CHANGING WEIGHTS: The weights of read replicas for the proxy instance are being changed.
address	String	Definition IP address of a proxy instance. Range N/A
port	Integer	Definition Port of a proxy instance. Range N/A
pool_status	String	Definition Status of a proxy instance. Range ACTIVE: The proxy instance is normal. ABNORMAL: The proxy instance is abnormal. FAILED: The proxy instance failed to be created. DELETED: The proxy instance has been deleted.
delay_threshold_in_seconds	Integer	Definition Delay threshold, in seconds. Range N/A
elb_vip	String	Definition Virtual IP address in ELB mode. Range N/A
eip	String	Definition EIP. Range N/A
vcpus	String	Definition vCPUs of a proxy instance. Range N/A
ram	String	Definition Memory size of a proxy instance. Range N/A
node_num	Integer	Definition Number of proxy instance nodes. Range N/A
mode	String	Definition Proxy instance mode. Range Cluster
nodes	Array of MysqlProxyNodes objects	Definition Proxy instance nodes.
flavor_ref	String	Definition Proxy instance specifications. Range N/A
name	String	Definition Proxy instance name. Range N/A
transaction_split	String	Definition Status of transaction splitting for a proxy instance. Range true: enabled false: disabled
connection_pool_type	String	Definition Connection pool type. Range CLOSED: The connection pool is closed. SESSION: The session-level connection pool is enabled.
switch_connection_pool_type_enabled	Boolean	Definition Whether the proxy instance version supports the session-level connection pool. Range true: Yes false: No
route_mode	Integer	Definition Routing policy of a proxy instance. Range 0: weighted 1: load balancing (The primary node does not process read requests.) 2: load balancing (The primary node processes read requests.)
balance_route_mode_enabled	Boolean	Definition Whether the proxy instance version supports load balancing. Range true: Yes false: No
consistence_mode	String	Definition Consistency level. The parameter is left blank by default. Its value depends on the session_consistence parameter. Range session: session consistency (Only this value can be used when session_consistence is true.) global: global consistency (This value can be used when session_consistence is false.) eventual: eventual consistency (This value can be used when session_consistence is false.)
subnet_id	String	Definition ID of the subnet that a proxy instance belongs to. Range N/A
ssl_option	String	Definition Whether to enable SSL. Range true: SSL is enabled. false: SSL is disabled.
new_node_auto_add_status	String	Definition Whether new nodes are automatically associated with proxy instances. Range ON: New nodes are automatically associated with proxy instances. OFF: New nodes are not automatically associated with proxy instances.
new_node_weight	Integer	Definition Read weight of a new node. Range 1–1000

**Table 7** MysqlProxyNodes
Parameter	Type	Description
id	String	Definition ID of a proxy instance node.
status	String	Definition Status of a proxy instance node. Range ACTIVE: The node is normal. ABNORMAL: The node is abnormal. FAILED: The node fails. DELETED: The node has been deleted.
name	String	Definition Name of a proxy instance node. Range N/A
role	String	Definition Role of a proxy instance node. Range master: primary node slave: read replica
az_code	String	Definition AZ. Range N/A
frozen_flag	Integer	Definition Whether a proxy instance node is frozen. Range 0: unfrozen 1: frozen 2: deleted after being frozen

**Table 8** MysqlProxyNodeV3
Parameter	Type	Description
id	String	Definition ID of a proxy instance node. Range The value contains 36 characters with a suffix of no07. Only letters and digits are allowed.
instance_id	String	Definition Instance ID, which uniquely identifies an instance. Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.
status	String	Definition Node status. Range ACTIVE: The node is normal. ABNORMAL: The node is abnormal. FAILED: The node fails. DELETED: The node has been deleted.
name	String	Definition Node name. Range N/A
weight	Integer	Definition Read weight of a node. Range 1–1000
availability_zone	Array of MysqlProxyAvailable objects	Definition AZ information.

**Table 9** MysqlProxyAvailable
Parameter	Type	Description
code	String	Definition AZ code. Range N/A
description	String	Definition AZ description. Range N/A

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying proxy instances

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

Example Response

Status code: 200

Success.

{
  "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"
      }]
    }
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic:Database Proxy

Previous topic: Deleting a Proxy Instance

Next topic: Querying Proxy Instance Specifications

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.