查询RDS实例的数据库独享代理详情
更新时间 2025-09-25 18:01:32
最近更新时间: 2025-09-25 18:01:32
接口功能介绍
查询RDS实例的数据库独享代理详情
接口约束
存在已开通的代理实例
URI
GET /RDS2/v1/open-api/proxy/proxy-detail
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| outerProdInstId | 是 | String | 实例id | eddf4d2c6d67407ba39e3453ee0776ca |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 否 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源池regionId，比如实例在资源池A，则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功; 2001 参数异常；3001 业务异常；5001 请求响应失败 | 0 | |
| returnObj | Object | 返回对象 | returnObj | |
| message | String | 返回信息 | success | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceCount | Integer | 代理数量 | 0 | |
| proxyInstanceVoList | Array of Objects | 代理实例信息 | proxyInstanceVo | |
| proxyConfigOutputVoList | Array of Objects | 代理实例配置信息 | proxyConfigOutputVo | |
| 表 proxyInstanceVo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| outerProxyInstId | String | 代理id | ||
| vpcId | String | vpc网络id | ||
| proxyType | Integer | 代理规格 '0: 单实例, 1:一主一从, 目前暂时只支持一主一从' | 1 | |
| masterAzName | String | 主节点 AZ名称 | ||
| masterAzId | String | 主节点 AZ Id | ||
| proxyInstName | String | 代理实例名称 | ||
| proxyRunningStatus | Integer | 0 正常 1 创建中 8 删除中 9已删除 26 白名单配置中 | 0 | |
| machineSpec | String | 机器规格 | 2C4G | |
| 表 proxyConfigOutputVo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backendServerCount | Integer | 代理的后端数据库节点数量 | 1 | |
| featureAttribute | String | -1: 表示从未配置过; 0：ReadWriteSpliting 读写分离加密方式 | 0 | |
| transactionReadSqlRouteOptimizeStatus | String | 事务拆分: 0：功能未开通 1：功能已开通 | 1 | |
| readOnlyInstanceDistributionType | String | 读权重分配模式: 自动分配(Standard), 自定义分配权重(Custom) | ||
| connectionPersist | String | 连接池类型: 0：功能未开通 连接池类型: 1：事务级连接池 2：会话级连接池 | 1 | |
| readOnlyInstanceMaxDelayTime | String | 读写分离中只读实例的最大延迟阈值 | 0 | |
| readOnlyInstanceWeight | Array of Objects | 后端数据库服务节点的只读权重配置列表 | readOnlyInstanceWeight | |
| proxyInstId | Integer | 代理实例主键Id | 3 | |
| eipStatus | Integer | 是否绑定弹性IP，0：未绑定，1：已绑定 | 0 | |
| eip | String | 绑定的弹性IP | 10.0.0.1 | |
| 表 readOnlyInstanceWeight |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| outerProdInstId | String | 实例id | eddf4d2c6d67407ba39e3453ee0776ca | |
| resId | Integer | 数据库实例的节点ID | 123 | |
| weight | Integer | 节点对应的只读权重 | 0 | |
| prodInstId | Integer | 实例id | 12 |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api//proxy/proxy-detail?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"instanceCount": 1,
"proxyInstanceVoList": [{
"outerProxyInstId": "08497110e1b8463a89da2f1a510be6b8",
"vpcId": "vd00001",
"proxyType": 1,
"masterAzName": "西北-内蒙演示3",
"masterAzId": "az3",
"proxyInstName": "proxy-xianlan-3",
"proxyRunningStatus": 1,
"machineSpec": "2C4G"
}],
"proxyConfigOutputVoList": [{
"backendServerCount": 1,
"readOnlyInstanceWeight": [{
"outerProdInstId": "59f8efa8fb564f57b271a2dc5351d6aa",
"weight": 200,
"prodInstId": 1254,
"resId": 1138
}],
"featureAttribute": "0",
"connectionPersist": "1",
"readOnlyInstanceDistributionType": "Standard",
"readOnlyInstanceMaxDelayTime": "5",
"proxyInstId": 1,
"transactionReadSqlRouteOptimizeStatus": "1",
"eipStatus": 0,
"eip": null
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
