告警规则
自定义监控告警规则：修改
接口功能介绍
修改自定义监控的告警规则配置信息。
接口约束
调用此接口可修改指定告警规则基本信息，支持全量字段修改。
URI
POST /v4/monitor/update-custom-alarm-rule
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| alarmRuleID | 是 | String | 告警规则ID | 2c2472df-f633-5b4b-be45-9609fc9f8154 | |
| regionID | 是 | String | ctyun资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 规则名 | 自定义告警规则测试 | |
| desc | 否 | String | 描述 | test | |
| evaluationCount | 否 | Integer | 持续周期数，默认5次 | 2 | |
| customItemID | 是 | String | 自定义监控指标 | ITEM63cb8954325480a3202307071801 | |
| fun | 是 | String | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 | avg | |
| operator | 是 | String | 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | eq | |
| value | 是 | String | 告警阈值，可以是整数、小数或百分数格式字符串 | 0 | |
| period | 是 | String | 本参数表示算法统计周期。参数fun为last时可不传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | 5m | |
| dimensions | 否 | Array of Objects | 自定义监控项维度 | dimValue | |
| webhookUrl | 否 | Array of Strings | 告警状态变更webhook推送地址 | ['https://www.ctyun.cn/'] | |
| repeatTimes | 否 | Integer | 重复告警通知次数，默认为0 | 0 | |
| silenceTime | 否 | Integer | 告警接收策略静默时间，多久重复通知一次，单位为秒 | 300 | |
| recoverNotify | 否 | Integer | 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 | 0 | |
| notifyType | 否 | Array of Strings | 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 | ['email','sms'] | |
| contactGroupList | 否 | Array of Strings | 告警联系人组 | ['test'] | |
| 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 |
表 dimValue
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 维度名称 | host | |
| value | 是 | Array of Strings | 维度值 | ['自定义值1','自定义值2'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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/update-custom-alarm-rule
请求头header
无
请求体body
{
"alarmRuleID": "83bd7537-9e06-5a45-a3b5-f4b13a7e81ea",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "自定义告警规则测试",
"desc": "test",
"repeatTimes": 0,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": ["email"],
"contactGroupList": [],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": ["https://www.ctyun.cn/"],
"evaluationCount": 5,
"customItemID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"fun": "avg",
"operator": "ge",
"value": "0",
"period": "5m",
"dimensions": [
{
"name" : "dim1",
"value": ["value1"]
}
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Monitor.CustomAlarmRule.RuleNotFound | 告警规则不存在 |
| Monitor.CustomAlarmRule.ContactGroupNotFound | 告警联系组不存在 |
| Monitor.CustomAlarmRule.CustomItemNotFound | 自定义监控项不存在 |
| 其他 | 参见公共错误码说明 |
