接口功能介绍
根据事件类型，统计指定时间段事件。
接口约束
eventType目前只能是virtual_machine_events。
events目前只能是migration。
events内容如下：
| 事件名 | 事件类型 | 状态说明 |
|---|---|---|
| migration | virtual_machine_events | 0表示事件发生，1表示事件恢复 |
URI
POST /v4/monitor/events/summary
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池 ID | |
| events | Array of String | 否 | ["migration"] | 本参数表示事件类型列表。默认是所有事件。取值范围：migration：事件状态。根据以上范围取值。 | |
| startTime | String | 是 | 1647424660 | 查询起始时间戳 | |
| endTime | String | 是 | 1647424660 | 查询截止时间戳 | |
| eventType | String | 是 | virtual_machine_events | 本参数表示事件类型。取值范围：virtual_machine_events：云主机事件。根据以上范围取值。 | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 2 | 页大小，默认为10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | Integer | 获取对象数据条数 | 14 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 14 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 | |
| data | Array of Objects | 具体设备的事件 | data |
表data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceType | String | 本参数表示事件类型。取值范围：virtual_machine_events：云主机事件。根据以上范围取值。 | virtual_machine_events | |
| fuserLastUpdated | String | 最后发生事件时间 | 2022-11-09 11:34:42 | |
| regionID | String | 资源池ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| regionName | String | 资源池名称 | nm8 | |
| fuid | String | 设备唯一ID | c7aa07b4-5567-462d-9146-12b29fdc02ec | |
| deviceID | String | fuid别名 | c7aa07b4-5567-462d-9146-12b29fdc02ec | |
| events | Object | 具体事件发生列表 | events |
表events
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| {event} | Array of Objects | 事件发生情况 | eventObject |
表eventObject
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| {eventStatus} | String | 本参数表示事件发生状态。取值范围：0：事件发生。1：事件恢复。根据以上范围取值。 | 0 | |
| {eventCount} | Integer | 事件发生次数 | 10 |
请求示例
POST /v4/monitor/events
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"eventType":"virtual_machine_events",
"events":[
"migration"
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"totalCount":1,
"totalPage":1,
"currentCount":1,
"page":1,
"pageSize":10,
"data":[
{
"deviceType":"virtual_machine_events",
"fuserLastUpdated":"2022-11-09 11:29:37",
"regionID":"73f321ea-62ff-11ec-a8bc-005056898fe0",
"regionName":"nm8",
"fuid":"c7aa07b4-5567-462d-9146-12b29fdc02ec",
"deviceID":"c7aa07b4-5567-462d-9146-12b29fdc02ec",
"events":{
"migration":{
"0":288,
"1":288
}
}
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Events.QueryError | 查询数据失败 |
| 其他 | 参见公共错误码说明 |
