自定義事件：查詢
更新時間 2024-09-25 16:20:49
最近更新時間: 2024-09-25 16:20:49
分享文章
自定義事件
自定義事件：查詢
接口功能介紹
調用此接口可查詢自定義事件。
接口約束
資源池ID不能為空。
URI
GET /v4/monitor/query-custom-events
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customEventID | 否 | String | 自定義事件ID | ITEM793d5923652be6ce202306291409 | |
| name | 否 | String | 事件名稱，支持模糊搜索 | 我的CPU使用率 | |
| pageNo | 否 | Integer | 頁碼，不傳默認為1 | 1 | |
| pageSize | 否 | Integer | 每頁大小，不傳默認為20 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| customEventList | Array of Objects | 自定義事件列表 | customEvent | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前記錄數 | 2 |
表 customEvent
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customEventID | String | 自定義事件ID | ITEM793d5923652be6ce202306291409 | |
| name | String | 事件名稱 | 異常 | |
| description | String | 事件描述 | 用于描述主機在異常情況下被關閉的事件 | |
| createTime | Integer | 創建時間戳，精確到毫秒 | 1667815639000 | |
| updateTime | Integer | 修改時間戳，精確到毫秒 | 1667815659000 |
請求示例
請求url
/v4/monitor/query-custom-events?regionID=81f7728662dd11ec810800155d307d5b&name=異常&pageNo=1&pageSize=10
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"errorCode":"",
"message": "Success",
"msgDesc": "成功",
"returnObj": {
"customEventList": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customEventID": "EVENTacd8b6b4610b97d202306301808",
"name": "主機異常事件",
"description": "用于描述主機在異常情況下被關閉的事件",
"createTime": 1667815639000,
"updateTime": 1667827659000
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customEventID": "EVENT2345b6b4210b97d202306301809",
"name": "網絡異常事件",
"description": "用于描述網絡出現故障的異常事件",
"createTime": 1667824639000,
"updateTime": 1667827639000
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
