创建一条伸缩策略
接口功能介绍
创建一个弹性伸缩策略
接口约束
无
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 | 未找到弹性伸缩组信息 |