創建伸縮策略
更新時間 2025-03-12 10:58:47
最近更新時間: 2025-03-12 10:58:47
分享文章
創建一條伸縮策略
接口功能介紹
創建一個彈性伸縮策略
接口約束
無
URI
POST /v4/scaling/rule/create
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| groupID | 是 | Integer | 伸縮組ID | 499 | |
| name | 是 | String | 伸縮策略名稱 | zjy-policy-test1-4 | |
| type | 是 | Integer | 策略類型。取值范圍：1：告警策略，2：定時策略，3：周期策略 | 1 | |
| operateUnit | 是 | Integer | 操作單位。 取值范圍：1：個數，2：百分比 | 1 | |
| operateCount | 是 | Integer | 調整值 | 1 | |
| action | 是 | Integer | 執行動作。取值范圍：1：增加，2：減少，3：設置為 | 1 | |
| cycle | 否 | Integer | 循環方式，取值范圍：1：按月循環，2：按周循環，3：按天循環 | 3 | |
| day | 否 | Array of Integers | 執行日期。 當cycle為1時必填，且Array元素限制為[1-31]中的整數且不重復； 當cycle為2時必填，且Array元素限制為[1-7]中的整數且不重復 |
||
| effectiveFrom | 否 | String | 周期策略生效開始時間，type=3時必填 | ||
| effectiveTill | 否 | String | 周期策略生效截止時間，type=3時必填 | ||
| executionTime | 否 | String | 執行時間，type=2、type=3時必填 | ||
| cooldown | 否 | Integer | 冷卻時間，type=1時必填，單位：秒 | 300 | |
| triggerObj | 否 | Object | 告警規則，type=1時必填 | triggerObj |
表 triggerObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 告警規則名稱 | as-alarm-f88f | |
| 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.RegionInfo.Empty | 錯誤碼 |
| message | String | 失敗時的錯誤描述，一般為英文描述 | scaling group info not found | |
| description | String | 失敗時的錯誤描述，一般為中文描述 | 未找到彈性伸縮組信息 | |
| returnObj | Object | 成功時返回的數據，參見表returnObj | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ruleID | Integer | 伸縮策略ID | 107 |
請求示例
請求頭header
無
請求體body
創建告警策略
cooldown必選，triggerObj必選
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"operateUnit": 1,
"triggerObj": {
"statistics": "max",
"name": "as-alarm-f88f",
"period": "5m",
"threshold": 50,
"evaluationCount": 1,
"comparisonOperator": "ge",
"metricName": "cpu_util"
},
"cooldown": 300,
"operateCount": 1,
"action": 1,
"type": 1,
"groupID": 499,
"name": "zjy-policy-test1-4"
}
創建定時策略
executionTime必選
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"operateUnit": 1,
"executionTime": "2022-10-13 15:05:00",
"operateCount": 1,
"action": 1,
"type": 2,
"groupID": 499,
"name": "zjy-policy-test1-4"
}
創建周期策略
executionTime、effectiveFrom、effectiveTill、cycle必選
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"operateUnit": 1,
"executionTime": "2022-10-13 15:21:00",
"effectiveFrom": "2022-10-13 15:44:00",
"effectiveTill": "2022-10-15 15:44:00",
"operateCount": 1,
"action": 1,
"type": 3,
"groupID": 499,
"name": "zjy-policy-test1-5",
"cycle": 3
}
響應示例
{
"returnObj": {
"ruleID": 107
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
錯誤碼
| errorCode | 描述 |
|---|---|
| Scaling.Group.NotFound | 未找到彈性伸縮組信息 |
