# 查询伸缩组绑定的伸缩策略 - ListScalingPolicies #### 功能介绍 根据输入条件过滤查询弹性伸缩策略。查询结果分页显示。 - 可根据伸缩策略名称，策略类型，伸缩策略ID，起始行号，记录数进行条件过滤查询。 - 若不加过滤条件默认查询租户下指定伸缩组内最多20条伸缩策略信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AS/doc?api=ListScalingPolicies)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-as/as_07_0200.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | as:scalingPolicy:list | list | - | [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) | as:policies:list | - | #### URI GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list ![](https://support.huaweicloud.com/api-as/public_sys-resources/note_3.0-zh-cn.png) 可以在URI后面用'?'和'\&'添加不同的查询条件组合。支持参数说明中所有非必选参数过滤，请参考请求示例。 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-as/as_04_0106.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | scaling_group_id | 是 | String | **参数解释：** 伸缩组ID。获取方式请参见[查询弹性伸缩组列表 - ListScalingGroups](https://support.huaweicloud.com/api-as/as_06_0102.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | scaling_policy_name | 否 | String | **参数解释：** 伸缩策略名称。 **约束限制：** 不涉及 **取值范围：** 1-64个字符，只能包含中文、字母、数字、下划线或中划线。 **默认取值：** 不涉及 | | scaling_policy_type | 否 | String | **参数解释：** 策略类型 **约束限制：** 不涉及 **取值范围：** - ALARM：告警策略 - SCHEDULED：定时策略 - RECURRENCE：周期策略 **默认取值：** 不涉及 | | scaling_policy_id | 否 | String | **参数解释：** 伸缩策略ID。获取方式请参见[查询弹性伸缩策略全量列表（V2版本） - ListAllScalingV2Policies](https://support.huaweicloud.com/api-as/as_06_0407.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | start_number | 否 | Integer | **参数解释：** 查询的起始行号。 **约束限制：** 最小值为0。 **取值范围：** 不涉及 **默认取值：** 默认为0。 | | limit | 否 | Integer | **参数解释：** 查询的记录条数。 **约束限制：** 不涉及 **取值范围：** 0\~100。 **默认取值：** 默认为20。 | #### 请求参数 无 #### 请求示例 查询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 ``` #### 响应参数 表2响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_number | Integer | **参数解释：** 总记录数 **取值范围：** 不涉及 | | start_number | Integer | **参数解释：** 查询的起始行号 **取值范围：** 最小值为0，最大值没有限制。 | | limit | Integer | **参数解释：** 查询记录数 **取值范围：** 0\~100。 | | scaling_policies | Array of [scaling_policies] objects | **参数解释：** 伸缩策略列表，详情请见[表 scaling_policies字段数据结构说明]。 | 表3scaling_policies字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | scaling_group_id | String | **参数解释：** 伸缩组ID。 **取值范围：** 不涉及 | | scaling_policy_name | String | **参数解释：** 伸缩策略名称。 **取值范围：** 1-64个字符，只能包含中文、字母、数字、下划线或中划线。 | | scaling_policy_id | String | **参数解释：** 伸缩策略ID。 **取值范围：** 不涉及 | | policy_status | String | **参数解释：** 伸缩策略状态 **取值范围：** - INSERVICE：已启用 - PAUSED：已停用 - EXECUTING：执行中 | | scaling_policy_type | 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_action | [scaling_policy_action] object | **参数解释：** 策略执行具体动作。详情请见[表 scaling_policy_action字段数据结构说明]。 | | cool_down_time | Integer | **参数解释：** 冷却时间，单位秒。 **取值范围：** 0-86400秒。 | | create_time | String | **参数解释：** 创建伸缩策略时间，遵循UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ，如2015-07-24T01:09:30Z。 **取值范围：** 不涉及 | 表4scheduled_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。 **取值范围：** 不涉及 | 表5scaling_policy_action字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | operation | String | **参数解释：** 操作选项。 **取值范围：** - 当scaling_resource_type为SCALING_GROUP，支持如下操作： - ADD：增加 - REMOVE/REDUCE：减少 - SET：设置为 - 当scaling_resource_type为BANDWIDTH，支持如下操作： - ADD：增加 - REDUCE：减少 - SET：设置为 | | instance_number | Integer | **参数解释：** 操作实例个数。 **取值范围：** - operation为SET时，取值范围为：0\~300。 - operation为ADD或REMOVE/REDUCE时，取值范围为：1\~300。 | | instance_percentage | Integer | **参数解释：** 操作实例百分比。 **取值范围：** - 操作为ADD或REMOVE/REDUCE时取值范围为1到20000的整数。 - 操作为SET时取值范围为0到20000的整数。 | #### 响应示例 ``` { "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", "scaling_policy_type": "SCHEDULED", "scheduled_policy": { "launch_time": "2015-07-24T01:21Z" }, "cool_down_time": 300, "scaling_policy_action": { "operation": "REMOVE", "instance_number": 1 }, "policy_status": "INSERVICE", "create_time": "2015-07-24T01:09:30Z" } ] } ``` #### 返回值 - 正常 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 | 网关超时。 | #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-as/as_07_0102.html)。