一键告警
一键告警：产品启用
接口功能介绍
此接口用于启用一个产品的一键告警规则，通知策略只对已启用的一键告警规则生效。
接口约束
无。
URI
POST /v4/monitor/alert-onekey/enable-service
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| alarmType | 是 | String | 本参数表示告警类型。 取值范围：series：时序指标。event：事件。 根据以上范围取值。 | series | |
| service | 是 | String | 本参数表示产品名称。取值范围：ecs：云主机。evs：云硬盘。...详见“[一键告警：产品列表]”接口返回。 | ecs | |
| alarmConfigList | 是 | Array of Objects | 各个产品的初始化规则 | alarmConfig | |
| repeatTimes | 否 | Integer | 重复告警通知次数，默认值：0 | 0 | |
| silenceTime | 否 | Integer | 告警接收策略静默时间，多久重复通知一次，单位为秒。 默认值：300 | 300 | |
| recoverNotify | 否 | Integer | 本参数表示恢复是否通知。默认值：0。取值范围：0：否。1：是。根据以上范围取值。 | 0 | |
| notifyType | 否 | Array of Strings | 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 | ['email'] | |
| contactGroupList | 否 | Array of Strings | 告警联系人组 | ['000f0322-1f4d-8cc8-bb2e-1c30fb751ccc'] | |
| notifyWeekdays | 否 | Array of Integers | 本参数表示通知周期。默认值[0,1,2,3,4,5,6]。取值范围：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。根据以上范围取值。 | [0,1,2,3,4,5,6] | |
| notifyStart | 否 | String | 通知起始时段，默认值：00:00:00 | 00:00:00 | |
| notifyEnd | 否 | String | 通知结束时段，默认值：23:59:59 | 23:59:59 | |
| webhookUrl | 否 | Array of Strings | 告警状态变更webhook推送地址 | ['https://www.ctyun.cn'] |
表 alarmConfig
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dimension | 是 | String | 本参数表示维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| name | 是 | String | 规则名 | test_name | |
| evaluationCount | 否 | Integer | 连续出现次数，默认值：0 | 0 | |
| metric | 是 | String | 指标名 | cpu_util | |
| status | 否 | Integer | 本参数表示告警规则启用状态，默认值：0。取值范围：0：启用。1：停用。根据以上范围取值。 | 0 | |
| operator | 是 | String | 注意：一键告警规则的告警类型（alarmType）为事件类型（event）时，不需要传入此参数；为其它告警类型时，是必填参数。 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | eq | |
| value | 是 | String | 注意：一键告警规则的告警类型（alarmType）为事件类型（event）时，不需要传入此参数；为其它告警类型时，是必填参数。 此参数表示告警阈值，可以是整数、小数或百分数格式字符串 | 20 | |
| unit | 否 | String | 单位 | % |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/enable-service
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"alarmType":"series",
"alarmConfigList":[
{
"dimension":"ecs",
"name":"CPU使用率一键告警",
"metric":"cpu_util",
"evaluationCount":5,
"operator":"ge",
"value":"5%",
"status":0
},
{
"dimension":"ecs",
"name":"内存使用率一键告警",
"metric":"mem_util",
"evaluationCount":5,
"operator":"ge",
"value":"5%",
"status":0
}
],
"repeatTimes":0,
"silenceTime":300,
"recoverNotify":0,
"notifyType":[
"email"
],
"contactGroupList":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751ccc"
],
"notifyWeekdays":[
0,
1,
2,
3,
4,
5,
6
],
"notifyStart":"00:00:00",
"notifyEnd":"23:59:59",
"webhookUrl":["https://www.ctyun.cn"]
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlertOnekey.ServiceAlreadyEnabled | 服务已启用 |
| 其他 | 参见公共错误码说明 |
