更新时间:2024-09-11 GMT+08:00

查询数据库代理信息列表

功能介绍

查询数据库代理信息列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

必须为整数,不能为负数。

取值范围

≥0

默认取值

0

limit

Integer

参数解释

查询记录数。

约束限制

必须为整数,不能为负数。

取值范围

1-100

默认取值

100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us
  • zh-cn

默认值

en-us。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

proxy_list

Array of MysqlShowProxyResponseV3 objects

参数解释

数据库代理信息列表。

表5 MysqlShowProxyResponseV3

参数

参数类型

描述

proxy

MysqlProxyV3 object

参数解释

数据库代理信息。

master_node

MysqlProxyNodeV3 object

参数解释

主节点信息。

readonly_nodes

Array of MysqlProxyNodeV3 objects

参数解释

只读节点信息。

表6 MysqlProxyV3

参数

参数类型

描述

pool_id

String

参数解释

数据库代理ID。

取值范围

只能由英文字母、数字组成,后缀为po01,长度为36个字符。

status

String

参数解释

数据库代理开启状态。

取值范围

  • ACTIVE:表示数据库代理正常。
  • FAILED:表示数据库代理创建失败。
  • DELETED:表示数据库代理已删除。
  • ABNORMAL:表示数据库代理异常。
  • ENABLING PROXY:表示数据库代理正在开启。
  • DISABLING PROXY:表示数据库代理正在关闭。
  • ADDING PROXY NODE:表示数据库代理正在扩容。
  • DELETING READ REPLICAS FROM PROXY:表示数据库代理正在移除只读节点。
  • ADDING READ REPLICAS TO PROXY:表示数据库代理正在添加只读节点。
  • CHANGING WEIGHTS:表示数据库代理正在修改只读节点权重。

address

String

参数解释

数据库代理地址。

取值范围

不涉及。

port

Integer

参数解释

数据库代理端口信息。

取值范围

不涉及。

pool_status

String

参数解释

数据库代理状态。

取值范围

  • ACTIVE:表示数据库代理正常。
  • ABNORMAL:表示数据库代理异常。
  • FAILED:表示数据库代理创建失败。
  • DELETED:表示数据库代理已删除。

delay_threshold_in_seconds

Integer

参数解释

延时阈值,单位:秒。

取值范围

不涉及。

elb_vip

String

参数解释

ELB模式的虚拟IP信息。

取值范围

不涉及。

eip

String

参数解释

弹性公网IP地址信息。

取值范围

不涉及。

vcpus

String

参数解释

数据库代理规格的CPU数量。

取值范围

不涉及。

ram

String

参数解释

数据库代理规格的内存数量。

取值范围

不涉及。

node_num

Integer

参数解释

数据库代理节点个数。

取值范围

不涉及。

mode

String

参数解释

数据库代理主备模式。

取值范围

Cluster。

nodes

Array of MysqlProxyNodes objects

参数解释

数据库代理节点信息。

flavor_ref

String

参数解释

数据库代理规格信息。

取值范围

不涉及。

name

String

参数解释

数据库代理名称。

取值范围

不涉及。

transaction_split

String

参数解释

数据库代理事务拆分开关状态。

取值范围

  • true:开启。
  • false:关闭。

connection_pool_type

String

参数解释

连接池类型。

取值范围:

  • CLOSED: 关闭连接池。
  • SESSION: 开启会话级连接池。

switch_connection_pool_type_enabled

Boolean

参数解释

数据库代理版本是否支持会话级连接池。

取值范围:

  • true: 支持。
  • false: 不支持。

route_mode

Integer

参数解释

数据库代理路由模式。

取值范围

  • 0:表示权重负载模式。
  • 1:表示负载均衡模式(数据库主节点不接受读请求)。
  • 2:表示负载均衡模式(数据库主节点接受读请求)。

balance_route_mode_enabled

Boolean

参数解释

数据库代理版本是否支持负载均衡模式。

取值范围

  • true 支持。
  • false 不支持。

consistence_mode

String

参数解释

一致性模式。默认值为空,此时以会话一致性参数session_consistence的值为准。

取值范围

  • session:会话一致性(当session_consistence为true时,只能取该值)。
  • global:全局一致性(当session_consistence为false时,可取该值)。
  • eventual:最终一致性(当session_consistence为false时,可取该值)。

subnet_id

String

参数解释

数据库代理所属的子网ID。

取值范围

不涉及。

ssl_option

String

参数解释

SSL数据加密开关设置。

取值范围

  • true:开启SSL数据加密。
  • false:关闭SSL数据加密。

new_node_auto_add_status

String

参数解释

新增节点是否自动加入该数据库代理。

取值范围

  • ON:自动加入。
  • OFF:不自动加入。

new_node_weight

Integer

参数解释

新增节点的读权重。

取值范围

1-1000。

表7 MysqlProxyNodes

参数

参数类型

描述

id

String

参数解释:

代理实例节点ID。

status

String

参数解释

数据库代理节点状态。

取值范围

  • ACTIVE:表示节点正常。
  • ABNORMAL:表示节点异常。
  • FAILED:表示节点失败。
  • DELETED:表示节点已删除。

name

String

参数解释

数据库代理节点名称。

取值范围

不涉及。

role

String

参数解释

数据库代理节点角色。

取值范围

  • master:主节点。
  • slave:只读节点。

az_code

String

参数解释

可用区。

取值范围

不涉及。

frozen_flag

Integer

参数解释

数据库代理节点是否被冻结。

取值范围

  • 0:未冻结。
  • 1:冻结。
  • 2:冻结删除。
表8 MysqlProxyNodeV3

参数

参数类型

描述

id

String

参数解释

数据库代理节点ID。

取值范围

只能由英文字母、数字组成,后缀为no07,长度为36个字符。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

status

String

参数解释

节点状态。

取值范围

  • ACTIVE:表示节点正常。
  • ABNORMAL:表示节点异常。
  • FAILED:表示节点失败。
  • DELETED:表示节点已删除。

name

String

参数解释

节点名称。

取值范围

不涉及。

weight

Integer

参数解释

节点读写分离读权重。

取值范围

1-1000。

availability_zone

Array of MysqlProxyAvailable objects

参数解释

可用区信息。

表9 MysqlProxyAvailable

参数

参数类型

描述

code

String

参数解释

可用区编码。

取值范围

不涉及。

description

String

参数解释

可用区描述。

取值范围

不涉及。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例的数据库代理信息列表。

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

响应示例

状态码: 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" : "可用区1"
      }]
    },
    "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" : "可用区1"
      }]
    }
  } ]
}

状态码

请参见状态码

错误码

请参见错误码