查询数据库代理信息

功能介绍

查询数据库代理信息。

当前页面API为历史版本API，未来可能停止维护。建议及时切换到新接口查询数据库代理信息列表。

调用方法

请参见如何调用API。

URI

GET /mysql/v3/{project_id}/instances/{instance_id}/proxy

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一Region下的project ID。获取方法请参见获取项目ID。
instance_id	是	String	实例ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Language	否	String	请求语言类型。默认en-us。取值范围： en-us zh-cn

响应参数

状态码： 202

表3 响应Body参数
参数	参数类型	描述
proxy	MysqlProxy object	Proxy实例信息。
master_node	MysqlProxyNode object	主节点信息。
readonly_nodes	Array of MysqlProxyNode objects	只读节点信息。

表4 MysqlProxy
参数	参数类型	描述
pool_id	String	Proxy实例ID。
status	String	Proxy实例开启状态。取值范围：closed、open、frozen、opening、closing、enlarging、freezing和unfreezin。
address	String	Proxy读写分离地址。
port	Integer	Proxy端口信息。
pool_status	String	Proxy实例状态。取值范围：abnormal、normal、creating和deleted。
delay_threshold_in_seconds	Integer	延时阈值，单位：秒。
elb_vip	String	Elb模式的虚拟ip信息。
eip	String	弹性公网IP信息。
vcpus	String	Proxy实例规格的CPU数量。
ram	String	Proxy实例规格的内存数量。
node_num	Integer	Proxy节点个数。
mode	String	Proxy主备模式，取值范围：Cluster。
nodes	Array of MysqlProxyNodes objects	Proxy节点信息。
flavor_ref	String	Proxy规格信息。

表5 MysqlProxyNodes
参数	参数类型	描述
id	String	Proxy节点ID。
status	String	Proxy节点状态。取值范围：normal、abnormal、creating和deleted。
name	String	Proxy节点名称。
role	String	Proxy节点角色：master和slave。
az_code	String	可用区。
frozen_flag	Integer	Proxy节点是否被冻结。 0：未冻结； 1：冻结； 2：冻结删除。

表6 MysqlProxyNode
参数	参数类型	描述
id	String	节点ID。
instance_id	String	实例ID。
status	String	节点状态。
name	String	节点名称。
weight	Integer	节点读写分离权重。
available_zones	Array of MysqlProxyAvailable objects	可用区信息。

表7 MysqlProxyAvailable
参数	参数类型	描述
code	String	可用区编码。
description	String	可用区描述。

状态码： 400

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码： 500

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/proxy

响应示例

状态码： 202

Success.

{
  "proxy" : {
    "pool_id" : "2e7cf21d14794bafab623a334efd9ad8po01",
    "status" : "open",
    "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
    }
  },
  "master_node" : {
    "id" : "2a111d6d494e4327ad2e326afb591108in07",
    "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
    "status" : "ACTIVE",
    "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node01",
    "weight" : 0,
    "available_zones" : {
      "code" : "az1xahz",
      "description" : "可用区1"
    }
  },
  "readonly_nodes" : {
    "id" : "d23535333138462880bfa1838fdfced2no07",
    "instance_id" : "7a871d6d494e4327ad2e326afb591108in07",
    "status" : "ACTIVE",
    "name" : "taurus_mysql80_x86-ondemand-2-1U4G_1_202103070251274842281_node02",
    "weight" : 100,
    "available_zones" : {
      "code" : "az1xahz",
      "description" : "可用区1"
    }
  }
}