自定义事件
自定义事件：修改
接口功能介绍
调用此接口可修改自定义事件。
接口约束
自定义事件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不存在 |
| 其他 | 参见公共错误码说明 |
