自定義事件：修改
更新時間 2024-09-25 16:20:49
最近更新時間: 2024-09-25 16:20:49
分享文章
自定義事件
自定義事件：修改
接口功能介紹
調用此接口可修改自定義事件。
接口約束
自定義事件ID ，事件名稱
URI
POST /v4/monitor/modify-custom-event
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customEventID | 是 | String | 自定義事件ID，必須是已存在的自定義事件ID | EVENTacd8b6b4610b97d202306301808 | |
| name | 是 | String | 事件名稱，必須4-20個字符，支持中英文、數字、下劃線，且不能以數字開頭。同一用戶在同一資源池下不能重復 | 主機異常事件 | |
| description | 否 | String | 事件描述，最多50個字符 | 用于描述主機在異常情況下被關閉的事件 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| customEventID | String | 自定義事件ID | EVENTacd8b6b4610b97d202306301808 |
請求示例
請求url
/v4/monitor/modify-custom-event
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customEventID": "Event793d5923652be6ce202306291409",
"name": "新的主機異常事件",
"description": "這是一條對主機異常關機事件的新描述"
}
響應示例
{
"statusCode":800,
"returnObj":{
"customEventID":"Event793d5923652be6ce202306291409"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.CustomEvent.NameAlreadyExist | 事件名稱已存在，不能重復 |
| Monitor.CustomEvent.EventIDNotFound | 事件ID不存在 |
| 其他 | 參見公共錯誤碼說明 |
