事件监控
事件监控：查询事件
接口功能介绍
获取资源池下指定维度下的事件。
接口约束
regionID（资源池）、service（服务）、dimension（维度）存在。
URI
GET /v4/monitor/events/query-events
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 服务，见事件监控：查询服务维度接口返回。 | ecs | |
| dimension | 是 | String | 维度，见事件监控：查询服务维度接口返回。 | ecs |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| events | Array of Objects | 事件列表 | eventObj |
表 eventObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| eventName | String | 事件指标 | migration_event_start | |
| description | String | 事件中文描述 | 云主机迁移发生 |
请求示例
请求url
/v4/monitor/events/query-events?regionID=81f7728662dd11ec810800155d307d5b&dimension=ecs&service=ecs
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"events": [
{
"eventName": "migration_event_start",
"description": "云主机迁移发生"
},
{
"eventName": "migration_event_complete",
"description": "云主机迁移完成"
},
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
