告警规则
告警规则：创建
接口功能介绍
创建一个或多个告警规则。
接口约束
regionID（资源池）存在，service（服务）、dimension（维度）、rules（告警规则）满足取值范围，具体范围见请求参数说明。
URI
POST /v4.1/monitor/create-alarm-rule
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 规则名 | 告警规则示例 | |
| service | 是 | String | 本参数表示服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 | ecs | |
| dimension | 是 | String | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | ecs | |
| conditions | 是 | Array of Objects | 具体告警匹配策略 | condition | |
| desc | 否 | String | 规则描述 | 规则描述 | |
| 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 | 告警联系组 | ['fe7f0cdc-4692-5516-8d3a-b06355482090'] | |
| 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消息推送url | ['www.ctyun.cn'] | |
| resGroupID | 否 | String | 资源分组ID，与resources字段互斥。 1.以资源分组为资源对象的告警规则，不需要传入resources。2.非资源分组为资源对象的告警规则，resources为必填项。 | eec4a76a-35ba-57b8-91c6-c4fd923351d6 | |
| resources | 是 | Array of Objects | 具体告警匹配资源 | resources | |
| projectID | 否 | String | 项目ID | 0 | |
| conditionType | 否 | Integer | 本参数表示告警策略触发类型。默认值0。取值范围：0：或，任一条件触发。1：全部条件满足触发。根据以上范围取值。 | 0 | 0 |
表 conditions
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| evaluationCount | 是 | Integer | 持续次数，当规则执行结果持续多久符合条件时报警（防抖），默认2次 | 2 | |
| metric | 是 | String | 监控指标 | cpu_util | |
| fun | 是 | String | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。sum：求和算法。根据以上范围取值。 | avg | |
| operator | 是 | String | 本参数表示比较符。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。rg：环比上升。cf：环比下降。rc：环比变化。根据以上范围取值。 | eq | |
| value | 是 | String | 告警阈值，可以是整数、小数或百分数格式字符串 | 0 | |
| period | 是 | String | 本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | 5m | |
| unit | 是 | String | 单位，部分资源池不支持，默认为空 | bit |
表 resources
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resource | 是 | Array of Objects | 资源信息 | resource |
表 resource
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | 是 | String | 资源实例标签键 | uuid |
| value | 是 | 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 Strings | 告警规则ID列表 | ['83bd7537-9e06-5a45-a3b5-f4b13a7e81ea'] |
请求示例
请求url
/v4.1/monitor/create-alarm-rule
请求头header
无
请求体body
{
"name": "告警规则名称",
"desc": "描述",
"service": "ecs",
"dimension": "ecs",
"repeatTimes": 0,
"silenceTime": 300,
"notifyType": ["sms"],
"contactGroupList": ["096f8c1d-b905-57fd-aefe-f485f396722d"],
"notifyWeekdays": [0, 1, 2, 3, 4, 5, 6],
"notifyStart": "00:00:00",
"notifyEnd": "23:59:59",
"webhookUrl": ["www.ctyun.cn"],
"conditions": [{
"evaluationCount": 2,
"fun": "last",
"operator": "ge",
"unit": "%",
"value": "0",
"metric": "cpu_util"
}],
"resources": [{
"resource": [{
"name": "uuid",
"value": "7dd744ea-5a02-61d3-e627-38f82f5fd3e1"
}, {
"name": "instancename",
"value": "ecm-af97"
}]
}],
"conditionType": 1,
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"alarmRuleIDList": [
"83bd7537-9e06-5a45-a3b5-f4b13a7e81ea"
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
