接口功能介绍
调用此接口可修改指定告警规则的告警条件。
接口约束
告警规则存在。
URI
POST /v4/monitor/update-alarm-rule-conditions
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| alarmRuleID | String | 是 | 2c2472df-f633-5b4b-be45-9609fc9f8154 | 告警规则ID | |
| dimension | String | 是 | ecs | 本参数表示告警维度。取值范围：ecs：云主机。disk：磁盘。pms：物理机。...详见“告警规则：获取告警服务维度关系”接口返回。 | |
| metric | String | 是 | cpu_util | 监控指标 | |
| fun | String | 是 | avg | 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 | |
| operator | String | 是 | eq | 本参数表示比较符。默认值le。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。根据以上范围取值。 | |
| value | String | 是 | 300 | 告警阈值，整数、小数或百分数格式字符串 | |
| period | String | 是 | 10m | 本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 | |
| deviceUUID | String | 是 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 | 资源唯一值 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
请求示例
POST /v4/monitor/update-alarm-rule-conditions
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"alarmRuleID": "2c2472df-f633-5b4b-be45-9609fc9f8154",
"metric": "cpu_util",
"fun": "avg",
"operator": "ge",
"value": "300",
"period": "10m",
"deviceUUID": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"dimension": "ecs"
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.AlarmRule.AlarmRuleNotFoundError | 告警规则不存在错误 |
| 其他 | 参见公共错误码说明 |
