查询弹性伸缩组内的策略列表
接口功能介绍
查询弹性伸缩组内的策略列表
接口约束
无
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 | 请求参数错误 |
