文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 数据库代理（MySQL）/ 查询数据库代理信息列表

更新时间：2024-05-21 GMT+08:00

查看PDF

查询数据库代理信息列表

功能介绍

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

调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

URI

URI格式
 GET /v3/{project_id}/instances/{instance_id}/proxy-list

参数说明

表1 参数说明
名称	是否必选	说明
project_id	是	租户在某一Region下的项目ID。获取方法请参见获取项目ID。
instance_id	是	实例ID。

请求消息

请求参数
 无。
URI样例
 GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/920ec36cef814a8b830a5bed50d9a088in01/proxy-list

响应消息

正常响应要素说明

表2 字段说明
名称	参数类型	说明
proxy_query_info_list	Array of objects	数据库实例下的数据库代理信息列表。请参见表3。
max_proxy_num	Integer	支持同时开启的数据库代理的最大数量。
max_proxy_node_num	Integer	单个数据库代理支持选择的最大节点数量。
support_balance_route_mode_for_favored_version	Boolean	是否支持创建数据库代理时设置负载均衡路由模式。

表3 proxy_query_info_list字段数据结构说明
名称	参数类型	说明
proxy	Object	数据库代理信息。请参见表4。
master_instance	Object	数据库主实例信息。请参见表7。
readonly_instances	Array of objects	数据库只读实例信息。请参见表7。
proxy_security_group_check_result	Boolean	安全组是否放通该数据库代理到数据库的网络地址。

表4 proxy字段数据结构说明
参数	参数类型	描述
pool_id	String	数据库代理实例ID。
status	String	数据库代理状态。取值： ENABLING：表示数据库代理正在开启。 DISABLING：表示数据库代理正在关闭。 CHANGING_NODE_NUM：表示数据库代理正在调整节点数量。 SCALING: 表示数据库代理正在规格变更。 UPGRADING: 表示数据库代理正在升级内核版本。 IPMODIFYING: 表示数据库代理正在修改读写分离地址。 RESTARTING: 表示数据库代理正在重启进程。 TRANSACTION_SPLITTING: 表示数据库代理正在变更事务拆分功能状态。 CONNECTION_POOL_SWITCH_OPERATING: 表示数据库代理正在变更会话连接池类型。 PORT_MODIFYING: 表示数据库代理正在修改端口。 PROXY_SSL_SWITCHING: 表示数据库代理正在变更SSL状态。 ALT_SWITCH_OPERATING: 表示数据库代理正在变更ALT状态。 CHANGING_RESOURCES: 表示数据库代理正在进行资源变更。 NORMAL: 表示数据库代理正常。 ABNORMAL: 表示数据库代理异常。 FAILED: 表示数据库代理创建失败。 FROZEN: 表示数据库代理已冻结。
address	String	读写分离地址。
port	Integer	端口号。
delay_threshold_in_seconds	Integer	延时阈值，单位：秒。
cpu	String	数据库代理规格的CPU大小。
mem	String	数据库代理规格的内存大小。
node_num	Integer	数据库代理节点个数。
nodes	Array of objects	数据库代理节点信息列表。请参见表5。
mode	String	数据库代理集群模式。取值： Cluster：集群模式 Ha：主备模式
flavor_info	Object	数据库代理规格信息。请参见表6。
transaction_split	String	数据库代理事务拆分开关状态。 true：开启。 false：关闭。
connection_pool_type	String	连接池类型。取值： CLOSED：关闭连接池。 SESSION：开启会话级连接池。
pay_mode	String	数据库代理计费模式。取值： 0：按需计费 1：包周期计费
name	String	数据库代理名称。
proxy_mode	String	数据库代理读写模式。取值： readwrite：读写模式 readonly：只读模式
dns_name	String	数据库代理读写分离地址内网域名。该字段为空表示未申请读写内网域名。
subnet_id	String	数据库代理实例所属子网ID。
seconds_level_monitor_fun_status	String	数据库代理秒级监控状态。枚举值： off on
alt_flag	Boolean	ALT开关状态。
force_read_only	Boolean	是否强制读路由到只读。
route_mode	Integer	数据库代理路由模式。取值： 0：表示权重负载模式。 1：表示负载均衡模式（数据库主实例不接受读请求）。 2：表示负载均衡模式（数据库主实例接受读请求）。
ssl_option	Boolean	ssl开关状态。
support_balance_route_mode	Boolean	数据库代理是否支持开启负载均衡路由模式。
support_proxy_ssl	Boolean	数据库代理是否支持开启ssl功能。
support_switch_connection_pool_type	Boolean	数据库代理是否支持切换会话连接池类型。
support_transaction_split	Boolean	数据库代理是否支持开启事务拆分。

表5 nodes字段数据结构说明
参数	参数类型	描述
id	String	数据库代理节点ID。
status	String	数据库代理节点状态。取值： NORMAL: 表示节点正常。 ABNORMAL: 表示节点节点状态异常。 CREATING: 表示节点正在创建中。 CREATEFAIL: 表示节点创建失败。
role	String	数据库代理节点角色。 master：主节点。 slave：备节点。
az_code	String	数据库代理节点所在可用区。
frozen_flag	Integer	数据库代理节点是否被冻结。取值： 0：未冻结。 1：冻结。

表6 flavor_info字段数据结构说明
参数	参数类型	描述
group_type	String	规格类型。枚举值： X86 ARM
code	String	规格码。

表7 readonly_instances字段数据结构说明
参数	参数类型	描述
id	String	数据库主实例或只读实例ID。
status	String	节点状态。
name	String	数据库实例名称。
weight	Integer	数据库实例读权重。
available_zones	Array of objects	可用区信息。请参见表8。

表8 available_zones字段数据结构说明
参数	参数类型	描述
code	String	可用区编码。
description	String	可用区描述。

正常响应样例

{ 
  "proxy_query_info_list" : [ { 
    "proxy" : { 
      "pool_id" : "e06ecf4dfea8409690c87a9ee6582b0dpo01", 
      "status" : "NORMAL", 
      "address" : "192.168.0.1", 
      "port" : 3306, 
      "delay_threshold_in_seconds" : 30, 
      "cpu" : "2", 
      "mem" : "4", 
      "node_num" : 2, 
      "nodes" : [ { 
        "id" : "3079919890f24fb8ab284571fc409058pn01", 
        "status" : "NORMAL", 
        "role" : "master", 
        "az_code" : "aaa", 
        "frozen_flag" : 0 
      }, { 
        "id" : "804430ac9068419fa5e49d5ca0684172pn01", 
        "status" : "NORMAL", 
        "role" : "master", 
        "az_code" : "aaa", 
        "frozen_flag" : 0 
      } ], 
      "mode" : "Cluster", 
      "flavor_info" : { 
        "group_type" : "X86", 
        "code" : "rds.proxy.large.2" 
      }, 
      "transaction_split" : "false", 
      "connection_pool_type" : "CLOSED", 
      "pay_mode" : "0", 
      "name" : "test-hll", 
      "proxy_mode" : "readwrite", 
      "route_mode" : 1, 
      "dns_name" : "", 
      "subnet_id" : "2f75f35c-62ca-43b7-9954-8fd1e6be4641", 
      "ssl_option" : false, 
      "force_read_only" : false, 
      "seconds_level_monitor_fun_status" : "off", 
      "alt_flag" : false, 
      "support_transaction_split" : true, 
      "support_switch_connection_pool_type" : true, 
      "support_balance_route_mode" : true, 
      "support_proxy_ssl" : true 
    }, 
    "master_instance" : { 
      "id" : "920ec36cef814a8b830a5bed50d9a088in01", 
      "status" : "normal", 
      "name" : "rds-2c54", 
      "weight" : 0, 
      "available_zones" : [ { 
        "code" : "aaa", 
        "description" : "az3" 
      } ] 
    }, 
    "readonly_instances" : [ { 
      "id" : "f9462b58982d484fb64fd9880504d863in01", 
      "status" : "abnormal", 
      "name" : "replica-f966", 
      "weight" : 0, 
      "available_zones" : [ { 
        "code" : "aaa", 
        "description" : "az3" 
      } ] 
    } ], 
    "proxy_security_group_check_result" : false 
  } ], 
  "max_proxy_num" : 4, 
  "max_proxy_node_num" : 4, 
  "support_balance_route_mode_for_favored_version" : true 
}

异常响应
 请参见异常请求结果。

状态码

正常
 200
异常
 请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理（MySQL）

上一篇：开启数据库代理

下一篇：查询数据库代理规格信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询数据库代理信息列表

功能介绍

调试

URI

请求消息

响应消息

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线