# 查询数据库代理信息列表 - ListRdSforMySqlProxy #### 功能介绍 查询数据库代理信息列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListRdSforMySqlProxy)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:getDBProxy | read | instance | g:EnterpriseProjectId g:ResourceTag/\ | rds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/proxy-list - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"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 | **参数解释**： 是否支持创建数据库代理时设置负载均衡路由模式。 **取值范围**： - true：支持创建数据库代理时设置负载均衡路由模式。 - false：不支持创建数据库代理时设置负载均衡路由模式。 | 表3proxy_query_info_list字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | proxy | Object | **参数解释**： 数据库代理信息。 请参见[表4]。 | | master_instance | Object | **参数解释**： 数据库主实例信息。 请参见[表7]。 | | readonly_instances | Array of objects | **参数解释**： 数据库只读实例信息。 请参见[表7]。 | | proxy_security_group_check_result | Boolean | **参数解释**： 安全组是否放通该数据库代理到数据库的网络地址。 **取值范围**： - true：放通该数据库代理到数据库的网络地址。 - false：不放通该数据库代理到数据库的网络地址。 | 表4proxy字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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开关状态。 **取值范围**： - true：开关开启。 - false：开关关闭。 | | force_read_only | Boolean | **参数解释**： 是否强制读路由到只读。 **取值范围**： - true：强制读路由到只读。 - false：不强制读路由到只读。 | | route_mode | Integer | **参数解释**： 数据库代理路由模式。 **取值范围**： - 0：表示权重负载模式。 - 1：表示负载均衡模式（数据库主实例不接受读请求）。 - 2：表示负载均衡模式（数据库主实例接受读请求）。 | | ssl_option | Boolean | **参数解释**： ssl开关状态。 **取值范围**： - true：开关开启。 - false：开关关闭。 | | support_balance_route_mode | Boolean | **参数解释**： 数据库代理是否支持开启负载均衡路由模式。 **取值范围**： - true：支持开启负载均衡路由模式。 - false：不支持开启负载均衡路由模式。 | | support_proxy_ssl | Boolean | **参数解释**： 数据库代理是否支持开启ssl功能。 **取值范围**： - true：支持开启ssl功能。 - false：不支持开启ssl功能。 | | support_switch_connection_pool_type | Boolean | **参数解释**： 数据库代理是否支持切换会话连接池类型。 **取值范围**： - true：支持切换会话连接池类型。 - false：不支持切换会话连接池类型。 | | support_transaction_split | Boolean | **参数解释**： 数据库代理是否支持开启事务拆分。 **取值范围**： - true：支持开启事务拆分。 - false：不支持开启事务拆分。 | 表5nodes字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 数据库代理节点ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 数据库代理节点状态。 **取值范围**： - NORMAL：表示节点正常。 - ABNORMAL：表示节点状态异常。 - CREATING：表示节点正在创建中。 - CREATEFAIL：表示节点创建失败。 | | role | String | **参数解释**： 数据库代理节点角色。 **取值范围**： - master：主节点。 - slave：备节点。 | | az_code | String | **参数解释**： 数据库代理节点所在可用区。 **取值范围**： 不涉及。 | | frozen_flag | Integer | **参数解释**： 数据库代理节点是否被冻结。 **取值范围**： - 0：未冻结。 - 1：冻结。 | 表6flavor_info字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_type | String | **参数解释**： 规格类型。 **取值范围**： - X86 - ARM | | code | String | **参数解释**： 规格码。 **取值范围**： 不涉及。 | 表7readonly_instances字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 数据库主实例或只读实例ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 节点状态。 **取值范围**： - NORMAL：表示节点正常。 - ABNORMAL：表示节点状态异常。 - CREATING：表示节点正在创建中。 - CREATEFAIL：表示节点创建失败。 | | name | String | **参数解释**： 数据库实例名称。 **取值范围**： 不涉及。 | | weight | Integer | **参数解释**： 数据库实例读权重。 **取值范围**： 不涉及。 | | available_zones | Array of objects | **参数解释**： 可用区信息。 请参见[表8]。 | 表8available_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 } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。