5.4 弹性伸缩策略
5.4.5 查询弹性伸缩策略列表
功能介绍
根据输入条件过滤查询弹性伸缩策略。查询结果分页显示。
● 可根据伸缩策略名称，策略类型，伸缩策略ID，起始行号，记录数进行条件过滤 查询。
● 若不加过滤条件默认查询租户下指定伸缩组内最多20条伸缩策略信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list
说明
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过 滤，请参考请求样例。
表5-97 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID scaling_policy_name 否 String 伸缩策略名称。
支持模糊匹配。
scaling_policy_type 否 String 策略类型：
● 告警策略：ALARM
● 定时策略：SCHEDULED
● 周期策略：RECURRENCE scaling_policy_id 否 String 伸缩策略ID
start_number 否 Integer 查询的起始行号，默认为0。
最小值为0。
limit 否 Integer 查询的记录条数，默认为20。
取值范围为：0~100。
请求消息
● 请求参数 无
● 请求样例
本示例展示了查询ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组内，
伸缩策略名称为as-policy-test且策略类型为定时策略的伸缩策略列表。
GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?scaling_policy_name=as-policy-test&scaling_policy_type=SCHEDULED
响应消息
● 响应参数
表5-98 响应参数
参数 参数类型 描述
total_number Integer 总记录数 start_number Integer 查询的起始行号
limit Integer 查询记录数
参数 参数类型 描述 scaling_policies Array of
scaling_policies objects 伸缩策略列表，详情请 见表 scaling_policies字 段数据结构说明。
表5-99 scaling_policies 字段数据结构说明
参数 参数类型 描述
scaling_group_id String 伸缩组ID scaling_policy_na
me String 伸缩策略名称
scaling_policy_id String 伸缩策略ID policy_status String 伸缩策略状态
● INSERVICE：已启用
● PAUSED：已停用
● EXECUTING：执行中 scaling_policy_typ
e String 伸缩策略类型：
● ALARM：告警策略，此时alarm_id有返 回，scheduled_policy不会返回。
● SCHEDULED：定时策略，此时 alarm_id不会返回，scheduled_policy 有返回，并且recurrence_type、
recurrence_value、start_time和 end_time不会返回。
● RECURRENCE：周期策略，此时 alarm_id不会返回，scheduled_policy 有返回，并且recurrence_type、
recurrence_value、start_time和 end_time有返回。
alarm_id String 告警ID scheduled_policy scheduled_
policy object
定时、周期任务策略。详情请见表 scheduled_policy字段数据结构说明。
scaling_policy_acti
on scaling_pol
icy_action object
策略执行具体动作。详情请见表 scaling_policy_action字段数据结构说 明。
cool_down_time Integer 冷却时间，单位秒。
create_time String 创建伸缩策略时间，遵循UTC时间。
表5-100 scheduled_policy 字段数据结构说明
参数 参数类型 描述
launch_time String 触发时间，遵循UTC时间。
● 如果scaling_policy_type为
SCHEDULED，则格式为：YYYY-MM-DDThh:mmZ。
● 如果scaling_policy_type为
RECURRENCE，则格式为：hh:mm。
recurrence_type String 周期触发类型。
● Daily：每天执行一次
● Weekly：每周指定天执行一次。
● Monthly：每月指定天执行一次。
recurrence_value String 周期触发任务数值：
● 类型为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时 间。
格式为：YYYY-MM-DDThh:mmZ。
表5-101 scaling_policy_action 字段数据结构说明
名称 参数类型 说明
operation String 操作选项。
● ADD：增加实例
● REMOVE：减少实例
● SET：设置实例数为 instance_number Integer 操作实例个数。
instance_percenta
ge Integer 操作实例百分比。
● 响应样例
{ "limit": 20, "total_number": 1, "start_number": 0, "scaling_policies": [ {
"scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "scaling_policy_name": "as-policy-test",
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 网关超时。
错误码
请参考错误码。