一键告警
一键告警:产品禁用
接口功能介绍
此接口用于禁用一个产品的一键告警规则。
接口约束
无。
URI
POST /v4/monitor/alert-onekey/disable-service
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
service | 是 | String | 本参数表示产品名称。取值范围:ecs:云主机。evs:云硬盘。...详见“[一键告警:产品列表]”接口返回。 | ecs | |
alarmType | 是 | String | 本参数表示告警类型。 取值范围:series:时序指标。event:事件。 根据以上范围取值。 | series |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
error | String | 错误码,请求成功时,不返回该字段 | Openapi.Parameter.Error | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
success | Boolean | 是否成功 | true |
请求示例
请求url
/v4/monitor/alert-onekey/disable-service
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"alarmType":"series"
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |