查詢伸縮組策略表
更新時間 2024-03-21 17:19:49
最近更新時間: 2024-03-21 17:19:49
分享文章
查詢彈性伸縮組內的策略列表
接口功能介紹
查詢彈性伸縮組內的策略列表
接口約束
無
URI
POST /v4/scaling/rule/list
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5 | |
| groupID | 是 | Integer | 伸縮組ID | 471 | |
| pageNo | 否 | Integer | 頁碼 | 5 | |
| page | 否 | Integer | 【Deprecated】頁碼 | 5 | |
| pageSize | 否 | Integer | 分頁查詢時設置的每頁行數,取值范圍:[1~100],默認值為10 | 10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回碼:800表示成功,900表示失敗 | 800 | |
| errorCode | String | 業務細分碼,為product.module.code三段式碼 | Scaling.Rule.NotFound | 錯誤碼 |
| message | String | 失敗時的錯誤描述,一般為英文描述 | scaling rule info not found | |
| description | String | 失敗時的錯誤描述,一般為中文描述 | 未找到彈性伸縮策略信息 | |
| returnObj | Object | 成功時返回的數據,參見表returnObj | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| numberOfAll | Integer | 伸縮策略總數量 | 1 | |
| totalCount | Integer | 本次查詢返回的伸縮策略數量 | 1 | |
| ruleList | Array of Objects | 伸縮策略列表信息 | ruleObj |
表 ruleObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ruleID | Integer | 伸縮策略ID | 72 | |
| name | String | 伸縮策略名稱 | as-policy-5a5c | |
| ruleType | Integer | 策略類型。取值范圍:1:告警。2:定時。 3:周期。 | 1 | |
| status | Integer | 啟用狀態。取值范圍:1:啟用。2:停用 | 1 | |
| action | Integer | 執行動作。取值范圍:1:增加2:減少3:設置為 | 1 | |
| operateCount | Integer | 調整值 | 1 | |
| operateUnit | Integer | 操作單位。 取值范圍:1:個數。2:百分比。 | 1 | |
| cooldown | Integer | 冷卻時間,單位:秒 | 300 | |
| executionTime | String | 觸發時間 | 2022-10-08 22:25:55 | |
| cycle | Integer | 循環方式,取值范圍:1:按月循環。2:按周循環。3:按天循環。 | 1 | |
| effectiveFrom | String | 周期策略生效開始時間 | 2022-10-08 22:25:55 | |
| effectiveTill | String | 周期策略生效截止時間 | 2022-10-08 22:25:55 | |
| day | Array of Strings | 執行日期 | ['1','2'] | |
| scalingGroupID | Integer | 伸縮組ID | 2 | |
| projectIDEcs | String | 企業項目ID | 573e | |
| createDate | String | 創建時間 | 2022-10-08 22:25:55 | |
| updateDate | String | 更新時間 | 2022-10-08 22:25:55 | |
| triggerObj | Object | 告警規則 | triggerObj |
表 triggerObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| triggerID | String | 告警規則ID | 6341887339fa5e04c4a33584 | |
| name | String | 告警規則名稱 | as-alarm-5a5c | |
| metricName | String | 監控指標名稱 | cpu_util | |
| statistics | String | 聚合方法。取值范圍:avg:平均值。max:最大值。min:最小值。 | avg | |
| comparisonOperator | String | 比較符。取值范圍:ge:大于等于。le:小于等于。gt:大于。lt:小于。 | ge | |
| threshold | Integer | 閾值 | 10 | |
| period | String | 監控周期,例:5m、10m | 5m | |
| evaluationCount | Integer | 連續出現次數 | 1 | |
| cooldown | Integer | 冷卻時間,單位:秒 | 300 | |
| status | Integer | 告警規則狀態:0:啟用。1:停用。 | 0 |
請求示例
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"groupID": 471,
"pageSize": 10,
"page": 1
}
響應示例
{
"returnObj": {
"numberOfAll": 1,
"totalCount": 1,
"ruleList": [
{
"ruleType": 1,
"status": 1,
"createDate": "2022-10-08 22:25:55",
"name": "as-policy-5a5c",
"effectiveTill": null,
"executionTime": null,
"operateUnit": 1,
"triggerActionID": "b0b5df31-d4e5-573e-9724-de070fb27dbb",
"scalingGroupID": 468,
"projectIDEcs": "0",
"triggerObj": {
"status": 0,
"statistics": "avg",
"name": "as-alarm-5a5c",
"period": "",
"triggerID": "6341887339fa5e04c4a33584",
"cooldown": 300,
"threshold": 10,
"evaluationCount": 1,
"comparisonOperator": "ge",
"metricName": "cpu_util"
},
"cooldown": 300,
"ruleID": 72,
"operateCount": 1,
"action": 1,
"effectiveFrom": null,
"updateDate": "2022-10-08 22:25:55",
"day": null,
"cycle": null
}
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
錯誤碼
| errorCode | 描述 |
|---|---|
| Scaling.Group.NotFound | 未找到彈性伸縮組信息 |
| Scaling.Parameter.InvalidError | 請求參數錯誤 |