事件監控：查詢列表
更新時間 2024-09-25 16:20:49
最近更新時間: 2024-09-25 16:20:49
分享文章
事件監控
事件監控：查詢列表
接口功能介紹
根據指定時間段查詢事件發生情況。
接口約束
regionID、startTime、endTime、eventNameList、dimension、service存在。
URI
POST /v4/monitor/events/query-list
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池 ID | 81f7728662dd11ec810800155d307d5b | |
| eventNameList | 否 | Array of Strings | 本參數表示事件指標列表，事件指標見查詢事件接口返回。不傳，默認全部事件指標 | ['migration_event_complete','migration_event_start'] | |
| service | 是 | String | 服務，見事件監控：查詢服務維度接口返回。 | ecs | |
| dimension | 是 | String | 維度，見事件監控：查詢服務維度接口返回。 | ecs | |
| startTime | 是 | Integer | 查詢起始時間戳 | 1647424660 | |
| endTime | 是 | Integer | 查詢截止時間戳 | 1647424660 | |
| pageNo | 否 | Integer | 頁碼，默認為1 | 1 | |
| pageSize | 否 | Integer | 頁大小，默認為20 | 2 | |
| resGroupID | 否 | String | 資源分組ID，在資源分組事件時傳入 | 9cb2b330-1dd8-5ec4-9c6d-b07fe65a9aca |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| totalCount | Integer | 獲取對象數據條數 | 14 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 14 | |
| eventList | Array of Objects | 事件列表 | eventObj |
表 eventObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| eventName | String | 事件指標 | migration_event_start | |
| description | String | 事件中文描述 | 云主機遷移發生 | |
| eventTime | Integer | 事件最后發生事件時間,秒級時間戳 | 1647424660 | |
| eventCount | Integer | 事件數量 | 5 |
請求示例
請求url
/v4/monitor/events/query-list
請求頭header
無
請求體body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"dimension":"ecs",
"service":"ecs",
"eventNameList":["migration_event_start","migration_event_complete"],
"startTime":1647424360,
"endTime":1647424660,
"pageNo":1,
"pageSize":10
}
響應示例
{
"statusCode":800,
"returnObj":{
"totalCount":2,
"totalPage":1,
"currentCount":2,
"eventList":[
{
"description":"云主機遷移完成",
"eventName":"migration_event_complete",
"eventTime":1647424660,
"eventCount":2
},
{
"description":"云主機遷移發生",
"eventName":"migration_event_start",
"eventTime":1647424660,
"eventCount":2
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.EventMonitor.DimensionNotSupport | 該維度的事件暫不支持 |
| 其他 | 參見公共錯誤碼說明 |
