接口功能介绍
根据筛选条件查询资源池下云主机的列表。
接口约束
regionID（资源池）存在。
URI
GET /v4/monitor/query-ecs-list
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 1 | 页大小，默认为10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| page | Integer | 页码 | 1 | |
| pageSize | Integer | 页大小 | 3 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 2 | |
| totalCount | Integer | 云主机总记录数 | 30 | |
| list | Array of Objects | 云主机资源列表 | ecs |
表ecs
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceUUID | String | 唯一标识ID | 478349bf-5576-26d2-3612-d47d72aa4d85 | |
| instanceID | String | 实例ID | 478349bf-5576-26d2-3612-d47d72aa4d85 | |
| instanceName | String | 云主机实例名称 | ecm-120fxstset |
请求示例
GET /v4/monitor/query-ecs-list?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=3
响应示例
{
"statusCode": 800,
"returnObj": {
"page": 1,
"pageSize": 3,
"totalPage":10,
"currentCount":3,
"totalCount": 30,
"list": [
{
"deviceUUID": "478349bf-5576-26d2-3612-d47d72aa4d85",
"instanceID": "478349bf-5576-26d2-3612-d47d72aa4d85",
"instanceName": "ecm-120fxstset"
},
{
"deviceUUID": "6bad8880-c9dc-6f86-2494-725351eab69a",
"instanceID": "6bad8880-c9dc-6f86-2494-725351eab69a",
"instanceName": "ecm-7626"
},
{
"deviceUUID": "8603be6c-57d7-bc22-a5e0-bb42cbe69281",
"instanceID": "8603be6c-57d7-bc22-a5e0-bb42cbe69281",
"instanceName": "ecm-7626"
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
