接口功能介绍
查询节点列表。
接口约束
无
URI
GET /v1/open-api/instance/query-node-list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例id | 79a634b4e0ee4b30bf81d989bfb77759 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码取值范围:0 成功 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Array of Objects | 列表信息 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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 | 虚拟IP地址 | SSD | |
diskSpace | 是 | String | 磁盘大小 | ||
memory | 是 | String | 内存大小 | 单位GB |
请求示例
请求头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"
},
{
"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"
},
{
"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"
}
]
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |