5.4 弹性伸缩策略
5.4.3 修改弹性伸缩策略
功能介绍
修改指定弹性伸缩策略。
调试
您可以在API Explorer中调试该接口。
URI
PUT /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}
表5-88 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
scaling_policy_id 是 String 伸缩策略ID,可参 考查询弹性伸缩策 略列表获取。
请求消息
● 请求参数
表5-89 请求参数
参数 是否必
选
参数类型 描述
scaling_policy_nam
e 否 String 伸缩策略名称(1-64个字
符),只能包含中文、字 母、数字、下划线或中划 线。
scaling_policy_type 否 String 策略类型
● 告警策略:ALARM(与 alarm_id对应)
● 定时策略:
SCHEDULED(与 scheduled_policy对应)
● 周期策略:
RECURRENCE(与 scheduled_policy对应) alarm_id 否 String 告警ID,即告警规则的ID,
当scaling_policy_type为 ALARM时该项必选,此时 scheduled_policy不生效。
修改成功后,会自动为该告 警ID对应的告警规则的 alarm_actions字段增加类型 为autoscaling的告警触发动 作。
告警ID通过查询云监控告警 规则列表获取,请参考《云 监控API参考》的“查询告警 规则列表”。
参数 是否必 选
参数类型 描述
scheduled_policy 否 scheduled_p
olicy object 定时、周期任务策略,当 scaling_policy_type为 SCHEDULED或RECURRENCE 时该项必选,此时alarm_id 不生效。请参考表
scheduled_policy字段数据 结构说明。
scaling_policy_actio
n 否 scaling_polic
y_action object
策略执行具体动作。请参考 表 scaling_policy_action字 段数据结构说明。
cool_down_time 否 Integer 冷却时间,取值范围 0-86400,单位是秒。
表5-90 scheduled_policy 字段数据结构说明
参数 是否必
选
参数类型 描述
launch_time 是 String 触发时间,遵循UTC时间。
● 如果scaling_policy_type为 SCHEDULED,则格式为:
YYYY-MM-DDThh:mmZ。
● 如果scaling_policy_type为 RECURRENCE,则格式 为:hh:mm。
recurrence_type 否 String 周期触发类型,
scaling_policy_type为 RECURRENCE时该项必选。
● Daily:每天执行一次
● Weekly:每周指定天执行 一次。
● Monthly:每月指定天执行 一次。
参数 是否必 选
参数类型 描述
recurrence_value 否 String 周期触发任务数值,
scaling_policy_type为 RECURRENCE时该项必选。
● 类型为Daily时,该字段为 null,表示每天执行
● 类型为Weekly时,该字段 取值范围为1-7,1表示星 期日,以此类推,以“,”
分割,例如:1,3,5。
● 类型为Monthly时,该字段 取值范围为1-31,分别表 示每月的日期,以“,”分 割,例如:1,10,13,28。
start_time 否 String 周期策略重复执行开始时间,
遵循UTC时间。
格式为:YYYY-MM-DDThh:mmZ。
end_time 否 String 周期策略重复执行结束时间,
遵循UTC时间,
scaling_policy_type为 RECURRENCE时该项必选。
当为周期类型策略时,不得早 于当前时间和开始时间 格式为:YYYY-MM-DDThh:mmZ。
表5-91 scaling_policy_action 字段数据结构说明
参数 是否必
选
参数类 型
描述
operation 否 String 操作选项,默认为ADD。
● ADD:增加实例
● REMOVE/REDUCE:减少实例
● SET:设置实例数为
参数 是否必
● operation为SET时,取值范围为:
0~300。
● operation为ADD或REMOVE/
REDUCE时,取值范围为:1~300。
说明配置参数时,instance_number和 instance_percentage参数只能选其中一个 进行配置。
instance_perce
ntage 否 Integer 操作实例百分比,将伸缩组容量增加、
减少或设置为伸缩组当前实例个数的百
PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/
0h327883-324n-4dzd-9c61-68d03ee191dd { "scaling_policy_type": "RECURRENCE", "scaling_policy_name": "policy_01", "scheduled_policy": {
"launch_time": "16:00", "recurrence_type": "Daily", "end_time": "2016-02-08T17:31Z", "start_time": "2016-01-08T17:31Z"
},
"scaling_policy_action": { "operation": "SET",
参数 参数类型 描述 scaling_policy_id String 伸缩策略ID
● 响应样例
{ "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"
}
返回值
● 正常 200
● 异常
返回值 说明
400 Bad Request 服务器未能处理请求。
401 Unauthorized 被请求的页面需要用户名和密码。
403 Forbidden 对被请求的页面访问禁止。
404 Not Found 服务器无法找到被请求的页面。
405 Method Not Allowed 请求中指定的方法不被允许。
406 Not Acceptable 服务器生成的响应无法被客户端所接受。
407 Proxy Authentication
Required 用户必须首先使用代理服务器进行验证,
这样请求才会被处理。
408 Request Timeout 请求超出了服务器的等待时间。
409 Conflict 由于冲突,请求无法被完成。
500 Internal Server Error 请求未完成。服务异常。
501 Not Implemented 请求未完成。服务器不支持所请求的功 能。
502 Bad Gateway 请求未完成。服务器从上游服务器收到一 个无效的响应。
503 Service Unavailable 请求未完成。系统暂时异常。
504 Gateway Timeout 网关超时。
错误码
请参考错误码。