接口功能介绍
创建一个或多个告警规则。
接口约束
regionID（资源池）存在，service（服务）、dimension（维度）、level（报警级别）、rules（告警规则）满足取值范围，具体范围见请求参数说明。
URI
POST /v4/monitor/create-alarm-rule
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | ctyun资源池ID | |
| name | String | 是 | 告警规则lyc123 | 规则名 | |
| service | String | 是 | ecs | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | |
| dimension | String | 是 | ecs | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | |
| level | Integer | 是 | 1 | 本参数表示报警级别。取值范围：1：灾难告警。2：严重告警。3：一般告警。4：警告告警。根据以上范围取值。 | |
| rules | Array of Objects | 是 | 具体匹配规则 | rule | |
| desc | String | 否 | test | 描述 | |
| repeatTimes | Integer | 否 | 0 | 重复告警通知次数，默认为0 | |
| silenceTime | Integer | 否 | 300 | 告警接收策略静默时间，多久重复通知一次，单位为秒 | |
| recoverNotify | Integer | 否 | 0 | 本参数表示恢复是否通知。默认值0。取值范围：0：否。1：是。根据以上范围取值。 | |
| notifyType | Array of String | 否 | ["email","sms"] | 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 | |
| contactGroupList | Array of String | 否 | ["test"] | 告警联系人组 | |
| notifyWeekdays | Array of Integer | 否 | [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 |
表rule
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| for | Integer | 否 | 120 | 持续时间，当规则执行结果持续多久符合条件时报警（防抖），默认120s | |
| metric | String | 是 | cpu_util | 监控指标 | |
| fun | String | 是 | avg | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 | |
| operator | String | 是 | eq | 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | |
| value | String | 是 | 0 | 告警阈值，可以是整数、小数或百分数格式字符串 | |
| period | String | 是 | 5m | 本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | |
| deviceUUID | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 资源唯一值 | |
| deviceType | String | 是 | vm | 资源类型 | |
| instanceID | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 资源ID | |
| instanceName | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 资源名称 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmRuleIDList | Array of String | 告警规则ID（alarmRuleID）列表 | ["83bd7537-9e06-5a45-a3b5-f4b13a7e81ea","02591baf-175f-5905-94fb-99b93df48e0b"] |
请求示例
POST /v4/monitor/create-alarm-rule
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "告警规则lyc123",
"desc": "test",
"repeatTimes": 0,
"service": "ecs",
"dimension": "ecs",
"level": 1,
"silenceTime": 300,
"recoverNotify": 0,
"notifyType": ["email"],
"contactGroupList": [],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"rules": [
{
"for": 300,
"metric": "mem_util",
"fun": "avg",
"operator": "ge",
"value": "0",
"period": "5m",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceType": "vm",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
},
{
"for": 300,
"metric": "cpu_util",
"fun": "avg",
"operator": "ge",
"value": "1000",
"period": "5m",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"deviceType": "vm",
"instanceID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"instanceName": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"alarmRuleID": [
"83bd7537-9e06-5a45-a3b5-f4b13a7e81ea",
"02591baf-175f-5905-94fb-99b93df48e0b"
]
},
"errorCode": "",
"message": "Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
