創建告警策略
更新時間 2025-03-24 17:52:06
最近更新時間: 2025-03-24 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 | 請求參數錯誤 |
