文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 数据库代理/ 查询单个数据库代理信息
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询单个数据库代理信息

功能介绍

查询数据库代理信息。

该接口计划于2025-03-31下线，建议及时切换到新接口查询数据库代理信息列表。

  • 调用接口前，您需要了解API认证鉴权。
  • 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。
  • DeC专属云账号暂不支持数据库代理。

URI

GET /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

X-Language

否

String

语言

响应参数

状态码： 200

表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和unfreezing。

address

String

Proxy读写分离地址。

port

Integer

Proxy端口信息。

pool_status

String

Proxy实例状态。 取值范围：ACTIVE、BUILD、FAILED和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规格信息。

name

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}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy

响应示例

状态码： 200

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
    },
    "name" : "proxy-name"
  },
  "master_node" : {
    "id" : "5ee8010ab992460d8d9cffcc5edabb59no07",
    "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"
    }
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理