创建告警策略
更新时间 2025-08-06 17:52:06
最近更新时间: 2025-08-06 17:52:06
创建一个告警策略
接口功能介绍
创建一个告警策略
接口约束
无
URI
POST /v4/scaling/rule/create-alarm
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| groupID | 是 | Integer | 伸缩组ID | 511 | |
| name | 是 | String | 伸缩策略名称 | as-policy-xudcdcfccd | |
| operateUnit | 是 | Integer | 操作单位。 取值范围：1：个数。2：百分比。 | 1 | |
| operateCount | 是 | Integer | 调整值 | 1 | |
| action | 是 | Integer | 执行动作。取值范围：1：增加2：减少3：设置为 | 1 | |
| cooldown | 是 | Integer | 冷却时间，告警策略时必填，单位：秒 | 300 | |
| triggerObj | 是 | Object | 告警规则 | triggerObj |
表 triggerObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 告警规则名称 | as-alarm-f8d8fdf | |
| metricName | 是 | String | 监控指标名称 | cpu_util | |
| statistics | 是 | String | 聚合方法。取值范围：avg：平均值。max：最大值。min：最小值。 | max | |
| comparisonOperator | 是 | String | 比较符。取值范围：ge：大于等于。le：小于等于。gt：大于。lt：小于。 | ge | |
| threshold | 是 | Integer | 阈值 | 50 | |
| period | 是 | String | 监控周期，单位：分钟 | 5m | |
| evaluationCount | 是 | Integer | 连续出现次数 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码：800表示成功，900表示失败 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | Scaling.Group.NotFound | 错误码 |
| message | String | 失败时的错误描述，一般为英文描述 | scaling group info not found | |
| description | String | 失败时的错误描述，一般为中文描述 | 未找到弹性伸缩组信息 | |
| returnObj | Object | 成功时返回的数据，参见表returnObj | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleID | Integer | 伸缩策略ID | 412 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"operateUnit": 1,
"triggerObj": {
"statistics": "max",
"name": "as-alarm-f8d8fdf",
"period": "5m",
"threshold": 50,
"evaluationCount": 1,
"comparisonOperator": "ge",
"metricName": "cpu_util"
},
"cooldown": 300,
"operateCount": 1,
"action": 1,
"groupID": 511,
"name": "as-policy-xudcdcfccd"
}
响应示例
{
"returnObj": {
"ruleID": 412
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
| errorCode | 描述 |
|---|---|
| Scaling.Group.NotFound | 未找到弹性伸缩组信息 |
| Scaling.Rule.RuleNumberMoreThanLimit | 伸缩组中的伸缩策略数量超过限制 |
| Scaling.Parameter.InvalidError | 请求参数错误 |
