接口功能介绍
查看弹性 IP 历史监控。
接口约束
无。
URI
POST /v4/eip/query-history-monitor
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池 ID | |
| deviceIDs | Array of String | 是 | 负载均衡的 IP 地址列表，仅支持 IP 地址 | |
| metricNames | Array of String | 是 | 监控指标 | |
| startTime | String | 是 | 开始时间，YYYY-mmm-dd HH:MM:SS | |
| endTime | String | 是 | 开始时间，YYYY-mmm-dd HH:MM:SS | |
| period | Integer | 否 | 可选参数，聚合周期，单位：秒，不能低于300，例14400 | |
| pageNumber | Integer | 否 | 列表的页码，默认值为 1 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 每页数据量大小，取值 1-50 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object of Array | object | 返回结果 |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
表 returnObj
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| lastUpdated | String | 最近更新时间 | |
| regionID | String | 资源池 ID | |
| deviceID | String | 弹性公网 IP | |
| itemAggregateList | Object of Array | 监控项值列表 |
表 itemAggregateList
这里 itemAggregateList 是一个数组，每个数组是一个字典，每个字典的对应一个数组，每个字典的 key 对应 metricNames 中的一个元素.
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| metricName | Object of Array | ingress_throughput |
表 metricName
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| samplingTime | String | 采样时间 | |
| value | String | 监控项值，有百分数，浮点数和整数三种类型 |
请求示例
POST /v4/eip/query-realtime-monitor
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"deviceIDs": ["102.23.56.110"],
"metricNames": ["ingress_throughput"],
"startTime": "2022-11-07 00:00:00",
"endTime": "2022-11-08 00:00:00"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"deviceID": "102.23.56.110",
"lastUpdated": "2022-11-07 17:42:27",
"itemAggregateList": {
"ingressThroughput": []
}
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
