事件監控：查詢事件
更新時間 2024-09-25 16:20:49
最近更新時間: 2024-09-25 16:20:49
分享文章
事件監控
事件監控：查詢事件
接口功能介紹
獲取資源池下指定維度下的事件。
接口約束
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 | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
