查询节点列表
更新时间 2025-09-26 16:17:38
最近更新时间: 2025-09-26 16:17:38
接口功能介绍
查询节点列表
接口约束
无
URI
GET /RDS2/v1/open-api/instance/query-node-list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| outerProdInstId | 是 | String | 实例id | 79a634b4e0ee4b30bf81d989bfb77759 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| inst-id | 否 | String | 实例id （和参数outerProdInstId保持一致） | 264729201196525109 | |
| regionId | 是 | String | 资源池regionId，比如实例在资源池A，则需要填写A资源池的regionId。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码取值范围：0 成功 | 0 | |
| message | String | 返回消息 | ||
| returnObj | Array of Objects | 列表信息 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resId | Integer | 资源id | 1 | |
| hostInstId | String | 主机id | ||
| host | String | 主机ip | 172.31.205.176 | |
| subnetName | String | 子网名称 | 1 | |
| subnetId | String | 子网id | ||
| role | String | 节点角色 m:主 s:从 | m | |
| createTime | Long | 创建时间 | 1668735838000 | |
| cpu | String | CPU核心数 | 1 | |
| diskType | String | 磁盘类型 | SSD | |
| diskSpace | Integer | 磁盘大小 | ||
| memory | String | 内存大小 | 单位GB |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/instance/query-node-list?outerProdInstId=b829cb71308746a094853c21d5aac0a1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"subnetId": "9258fc75-37e1-45e9-8eb6-5b77f3ee98a4",
"memory": "4",
"role": "m",
"createTime": 1668735838000,
"diskSpace": 100,
"host": "172.31.207.230",
"hostInstId": "646ddd14-ffdc-4efc-9815-45664efb3e97",
"cpu": "1",
"diskType": "SSD",
"subnetName": "subnet-a3ca",
"resId": 1
},
{
"subnetId": "9258fc75-37e1-45e9-8eb6-5b77f3ee98a4",
"memory": "4",
"role": "s",
"createTime": 1668735838000,
"diskSpace": 100,
"host": "172.31.205.176",
"hostInstId": "17421985-e310-48c5-a47d-c94e5013568e",
"cpu": "1",
"diskType": "SSD",
"subnetName": "subnet-a3ca",
"resId": 2
},
{
"subnetId": "9258fc75-37e1-45e9-8eb6-5b77f3ee98a4",
"memory": "4",
"role": "s",
"createTime": 1668735838000,
"diskSpace": 100,
"host": "172.31.205.22",
"hostInstId": "54cb418a-4720-4d25-9a22-a33467c58127",
"cpu": "1",
"diskType": "SSD",
"subnetName": "subnet-a3ca",
"resId": 3
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
