接口功能介绍
调用此接口可根据筛选条件查询资源池下弹性ip的列表。
接口约束
regionID（资源池）存在。
URI
GET /v4/monitor/query-eip-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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| eipList | Array of Objects | 弹性ip资源列表 | eip | |
| totalCount | Integer | 获取对象数据条数 | 138 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 2 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 |
表eip
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceID | String | 弹性ip实例ID | eip-48rej8i7s6 | |
| instanceName | String | 弹性ip实例名称 | eip-9ed7 | |
| deviceUUID | String | 唯一标识ID | eip-48rej8i7s6 | |
| IP | String | 弹性ip地址 | 100.124.2.99 |
请求示例
GET /v4/monitor/query-eip-list?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=5
响应示例
{
"statusCode":800,
"returnObj":{
"eipList":[
{
"instanceID":"eip-48rej8i7s6",
"instanceName":"eip-9ed7",
"deviceUUID":"eip-48rej8i7s6",
"ipAddress":"100.124.2.99"
},
{
"instanceID":"eip-u14qi19bpj",
"instanceName":"eip-fa21",
"deviceUUID":"eip-u14qi19bpj",
"ipAddress":"100.124.1.166"
},
{
"instanceID":"eip-0fxol66mk0",
"instanceName":"eip-97db",
"deviceUUID":"eip-0fxol66mk0",
"ipAddress":"100.124.1.165"
},
{
"instanceID":"eip-bfq723ce5u",
"instanceName":"eip-2f84",
"deviceUUID":"eip-bfq723ce5u",
"ipAddress":"100.124.1.164"
},
{
"instanceID":"eip-wb8cmg81xp",
"instanceName":"eip-be96",
"deviceUUID":"eip-wb8cmg81xp",
"ipAddress":"100.124.1.27"
}
],
"totalCount":14,
"totalPage":3,
"currentCount":5,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
