华为云用户手册

响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数。 start_number Integer 查询的起始行号。 limit Integer 查询记录。 scaling_policies Array of scaling_policies objects 伸缩策略列表。详情请见表 scaling_policies字段数据结构说明。 表3 scaling_policies字段数据结构说明 参数 参数类型 描述 scaling_policy_name String 伸缩策略名称 scaling_policy_id String 伸缩策略ID scaling_resource_id String 伸缩资源ID scaling_resource_type string 伸缩资源类型 伸缩组：SCALING_GROUP 带宽：BANDW IDT H 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字段数据结构说明。 interval_alarm_actions Array of interval_alarm_actions objects 伸缩策略类型为INTERVAL_ALARM时的执行动作。详情请见表 interval_alarm_actions字段数据结构说明 cool_down_time Integer 冷却时间，单位秒。 create_time String 创建伸缩策略时间，遵循UTC时间。 meta_data meta_data object 附加信息。详情请见表 meta_data字段数据结构说明。 description String 伸缩策略描述。 表4 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 scaling_policy_action字段数据结构说明 参数 参数类型 描述 operation String 操作选项。 ADD：增加 REDUCE：减少 SET：设置为 size Integer 操作实例个数。 percentage Integer 操作实例百分比。 limits Integer 操作限制 表6 interval_alarm_actions字段数据结构说明 参数 是否必选 参数类型 描述 lower_bound 否 double 区间下限 upper_bound 否 double 区间上限 operation 否 String 操作选项 ADD：增加 REDUCE：减少 SET：设置为 size 否 Integer 操作大小 percentage 否 Integer 操作百分比 limits 否 Integer 操作限制 表7 meta_data字段数据结构说明 参数 参数类型 描述 metadata_bandwidth_share_type String 伸缩带宽策略中带宽对应的共享类型。 metadata_eip_id String 伸缩带宽策略中带宽对应的EIP的ID。 metadata_eip_address String 伸缩带宽策略中带宽对应的EIP地址。

响应示例 { "limit": 20, "total_number": 3, "start_number": 0, "scaling_policies": [ { "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8", "scaling_policy_name": "as-policy-7a75", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "SCALING_GROUP", "scaling_policy_type": "RECURRENCE", "scheduled_policy": { "launch_time": "03:30", "recurrence_type": "Daily", "start_time": "2017-08-28T03:08Z", "end_time": "2017-09-01T03:08Z" }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1 }, "policy_status": "INSERVICE", "create_time": "2017-08-31T03:02:41Z" }, { "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb", "scaling_policy_name": "as-policy-7a75", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "SCALING_GROUP", "scaling_policy_type": "RECURRENCE", "scheduled_policy": { "launch_time": "21:30", "recurrence_type": "Daily", "start_time": "2017-08-27T21:08Z", "end_time": "2017-08-31T21:08Z" }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1 }, "policy_status": "INSERVICE", "create_time": "2017-08-31T07:35:05Z","meta_data": { "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e", "metadata_eip_address": "255.255.255.255" } }, { "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1", "scaling_policy_name": "as-policy-7a75", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "SCALING_GROUP", "scaling_policy_type": "RECURRENCE", "scheduled_policy": { "launch_time": "22:30", "recurrence_type": "Daily", "start_time": "2017-08-27T22:08Z", "end_time": "2017-08-31T22:08Z" }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1 }, "policy_status": "INSERVICE", "create_time": "2017-08-31T07:41:06Z","meta_data": { "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e", "metadata_eip_address": "255.255.255.255" } } ]}

返回值 正常 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 网关超时。

响应示例 { "limit": 20, "total_number": 3, "start_number": 0, "scaling_policies": [ { "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8", "scaling_policy_name": "as-policy-7a75", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "SCALING_GROUP", "scaling_policy_type": "RECURRENCE", "scheduled_policy": { "launch_time": "03:30", "recurrence_type": "Daily", "start_time": "2017-08-28T03:08Z", "end_time": "2017-09-01T03:08Z" }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1 }, "policy_status": "INSERVICE", "create_time": "2017-08-31T03:02:41Z" }, { "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb", "scaling_policy_name": "as-policy-7a75", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "SCALING_GROUP", "scaling_policy_type": "RECURRENCE", "scheduled_policy": { "launch_time": "21:30", "recurrence_type": "Daily", "start_time": "2017-08-27T21:08Z", "end_time": "2017-08-31T21:08Z" }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1 }, "policy_status": "INSERVICE", "create_time": "2017-08-31T07:35:05Z" }, { "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1", "scaling_policy_name": "as-policy-7a75", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "SCALING_GROUP", "scaling_policy_type": "RECURRENCE", "scheduled_policy": { "launch_time": "22:30", "recurrence_type": "Daily", "start_time": "2017-08-27T22:08Z", "end_time": "2017-08-31T22:08Z" }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1 }, "policy_status": "INSERVICE", "create_time": "2017-08-31T07:41:06Z" } ]}

响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_policies Array of scaling_policies objects 伸缩策略列表。详情请见表 scaling_policies字段数据结构说明。 表3 scaling_policies字段数据结构说明 名称 参数类型 说明 scaling_policy_name String 伸缩策略名称。 支持模糊匹配。 scaling_policy_id String 伸缩策略ID scaling_resource_id String 伸缩资源ID scaling_resource_type string 伸缩资源类型 伸缩组：SCALING_GROUP 带宽：BANDWIDTH 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字段数据结构说明。 interval_alarm_actions Array of interval_alarm_actions objects 伸缩策略类型为INTERVAL_ALARM时的执行动作。详情请见表 interval_alarm_actions字段数据结构说明 cool_down_time Integer 冷却时间，单位秒。 create_time String 创建伸缩策略时间，遵循UTC时间。 meta_data meta_data object 附加信息。详情请见表 meta_data字段数据结构说明。 description String 伸缩策略描述。 表4 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 scaling_policy_action字段数据结构说明 参数 参数类型 描述 operation String 操作选项。 ADD：增加 REDUCE：减少 SET：设置为 size Integer 操作实例个数。 percentage Integer 操作实例百分比。 limits Integer 操作限制 表6 interval_alarm_actions字段数据结构说明 参数 是否必选 参数类型 描述 lower_bound 否 double 区间下限 upper_bound 否 double 区间上限 operation 否 String 操作选项 ADD：增加 REDUCE：减少 SET：设置为 size 否 Integer 操作大小 percentage 否 Integer 操作百分比 limits 否 Integer 操作限制 表7 meta_data字段数据结构说明 参数 参数类型 描述 metadata_bandwidth_share_type String 伸缩带宽策略中带宽对应的共享类型。 metadata_eip_id String 伸缩带宽策略中带宽对应的EIP的ID。 metadata_eip_address String 伸缩带宽策略中带宽对应的EIP地址。

请求示例 查询ID为8ade64b5-d685-40b8-8582-4ce306ea37a6的资源下策略类型为周期策略的伸缩策略列表信息。 GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/8ade64b5-d685-40b8-8582-4ce306ea37a6/list?scaling_policy_type=RECURRENCE

返回值 正常 204 异常 返回值 说明 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 网关超时。

URI DELETE /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_group_id 是 String 伸缩组ID。 force_delete 否 String 是否强制删除伸缩组。取值如下： no：不强制删除伸缩组，默认为no。 yes：强制删除伸缩组。

功能介绍 删除一个指定弹性伸缩组。 force_delete属性表示如果伸缩组存在E CS 实例或正在进行伸缩活动，是否强制删除伸缩组并移出和释放ECS实例。默认值为no，表示不强制删除伸缩组。 如果force_delete的值为no，必须满足以下两个条件，才能删除伸缩组： 条件一：伸缩组没有正在进行的伸缩活动。 条件二：伸缩组当前的ECS实例数量（current_instance_number）为0。 如果force_delete的值为yes，伸缩组会被置于DELETING状态，拒绝接收新的伸缩活动请求，然后等待已有的伸缩活动完成，最后将伸缩组内所有ECS实例移出伸缩组（用户手动添加的ECS实例会被移出伸缩组，弹性伸缩自动创建的ECS实例会被自动删除）并删除伸缩组。 如果强制删除弹性伸缩组，可能会导致虚拟机残留。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_policy_name 是 String 伸缩策略名称（1-64个字符），只能包含中文、字母、数字、下划线或中划线。 scaling_group_id 是 String 伸缩组ID，通过查询弹性伸缩组列表获取，请参考查询弹性伸缩组列表。 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_policy object 定时、周期任务策略，当scaling_policy_type为SCHEDULED或RECURRENCE时该项必选，此时alarm_id不生效。详情请见表 scheduled_policy字段数据结构说明。 scaling_policy_action 否 scaling_policy_action object 策略执行具体动作。详情请见表 scaling_policy_action字段数据结构说明。 cool_down_time 否 Integer 冷却时间，取值范围0-86400，默认为300，单位是秒。 表3 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。 表4 scaling_policy_action字段数据结构说明 参数 是否必选 参数类型 描述 operation 否 String 操作选项，默认为ADD。 ADD：增加实例 REMOVE/REDUCE：减少实例 SET：设置实例数为 instance_number 否 Integer 操作实例个数，默认为1。当配额为默认配额时，取值范围如下： operation为SET时，取值范围为：0~300。 operation为ADD或REMOVE/REDUCE时，取值范围为：1~300。 说明： 配置参数时，instance_number和instance_percentage参数只能选其中一个进行配置。 instance_percentage 否 Integer 操作实例百分比，将伸缩组容量增加、减少或设置为伸缩组当前实例个数的百分比。操作为ADD或REMOVE/REDUCE时取值范围为1到20000的整数，操作为SET时取值范围为0到20000的整数。 当instance_number和instance_percentage参数均无配置时，则操作实例个数为1。 配置参数时，instance_number和instance_percentage参数只能选其中一个进行配置。

请求示例 创建一个名称为as-policy-7a75的周期策略，该策略的生效时间为2015-12-14T03:34Z到2015-12-27T03:34Z，每天16:00在ID为5bc3aa02-b83e-454c-aba1-4d2095c68f8b的伸缩组中增加一个实例。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy{ "scaling_policy_name": "as-policy-7a75", "scaling_policy_action": { "operation": "ADD", "instance_number": 1 }, "cool_down_time": 900, "scheduled_policy": { "launch_time": "16:00", "recurrence_type": "Daily", "start_time": "2015-12-14T03:34Z", "end_time": "2015-12-27T03:34Z" }, "scaling_policy_type": "RECURRENCE", "scaling_group_id": "5bc3aa02-b83e-454c-aba1-4d2095c68f8b"}

返回值 正常 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 网关超时。

请求示例 批量添加实例ID为instance_id_1和instance_id_2的两个实例到ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组中。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "ADD", "instances_id": [ "instance_id_1", "instance_id_2" ]} 批量移出并删除ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组中，实例ID为instance_id_1和instance_id_2的两个实例。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "REMOVE", "instances_id": [ "instance_id_1", "instance_id_2" ], "instance_delete": "yes"} 批量对ID为instance_id_1和instance_id_2的两个实例设置实例保护属性。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "PROTECT", "instances_id": [ "instance_id_1", "instance_id_2" ]} 批量对ID为instance_id_1和instance_id_2的两个实例取消实例保护属性。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "UNPROTECT", "instances_id": [ "instance_id_1", "instance_id_2" ]} 批量将ID为instance_id_1和instance_id_2的两个实例转入实例备用状态。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "ENTER_STANDBY", "instances_id": [ "instance_id_1", "instance_id_2" ], "instance_append": "yes"} 批量将ID为instance_id_1和instance_id_2的两个实例移出实例备用状态。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "EXIT_STANDBY", "instances_id": [ "instance_id_1", "instance_id_2" ]}

返回值 正常 204 异常 返回值 说明 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 网关超时。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 instances_id 是 Array of strings 云服务器ID instance_delete 否 String 从伸缩组中移出实例时，是否删除云服务器。 取值如下： no：不删除实例，默认情况为no。 yes：删除实例。 如果是手动添加到伸缩组的实例，只能从伸缩组中移出，不支持移出并删除。 只有action为REMOVE时，这个字段才生效。 instance_append 否 String 将实例移入备用状态时，是否补充新的云服务器。 取值如下： no：不补充新的实例，默认情况为no。 yes：补充新的实例。 只有action为ENTER_STANDBY时，这个字段才生效。 action 是 String 批量操作实例action标识： 添加：ADD 移除：REMOVE 设置实例保护：PROTECT 取消实例保护：UNPROTECT 转入备用状态：ENTER_STANDBY 移出备用状态：EXIT_STANDBY

功能介绍 批量移出伸缩组中的实例或批量添加伸缩组外的实例。 批量移出伸缩组时，如果是手动添加到伸缩组的实例，只能从伸缩组中移出，不支持移出并删除。 批量对伸缩组中的实例设置或取消其实例保护属性。 批量将伸缩组中的实例转入或移出备用状态。 单次最多批量移出实例个数为50，其他批量操作单次最多操作实例个数为10。批量添加后实例数不能大于伸缩组的最大实例数，批量移出后实例数不能小于伸缩组的最小实例数。 当伸缩组处于INSERVICE状态且没有伸缩活动时，才能添加实例。 当伸缩组没有伸缩活动时，才能移出实例。 向伸缩组中添加实例时，必须保证实例所在的可用区包含于伸缩组的可用区内。 实例处于INSERVICE状态时才可以进行移出、设置或取消实例保护属性等操作。 当伸缩组发生自动缩容活动时，设置了实例保护的实例不会被移出伸缩组。 批量移出弹性伸缩组中的实例时，若该实例加入伸缩组时绑定的监听器和伸缩组本身的监听器相同，会解绑定实例和监听器。若该实例加入伸缩组时绑定的监听器和伸缩组本身的监听器不同，会保留实例和监听器的绑定关系。

返回值 正常 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 网关超时。

请求示例 创建一个名称为hth_aspolicy_1的告警策略，使用的告警规则ID为al1513822380493GvlJKZwA8，每当告警规则达到告警阈值后，该策略会使ID为8ade64b5-d685-40b8-8582-4ce306ea37a6的带宽增加1Mbit/s，直到带宽值达到限制10Mbit/s。 POST https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy{ "alarm_id": "al1513822380493GvlJKZwA8", "cool_down_time": 900, "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "BANDWIDTH", "scaling_policy_action": { "size": 1, "operation": "ADD", "limits": 10 }, "scaling_policy_name": "hth_aspolicy_1", "scaling_policy_type": "ALARM"}

返回值 正常 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 网关超时。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_policy_name 否 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_policy object 定时、周期任务策略，当scaling_policy_type为SCHEDULED或RECURRENCE时该项必选，此时alarm_id不生效。请参考表 scheduled_policy字段数据结构说明。 scaling_policy_action 否 scaling_policy_action object 策略执行具体动作。请参考表 scaling_policy_action字段数据结构说明。 cool_down_time 否 Integer 冷却时间，取值范围0-86400，单位是秒。 表3 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。 表4 scaling_policy_action字段数据结构说明 参数 是否必选 参数类型 描述 operation 否 String 操作选项，默认为ADD。 ADD：增加实例 REMOVE/REDUCE：减少实例 SET：设置实例数为 instance_number 否 Integer 操作实例个数，默认为1。当配额为默认配额时，取值范围如下： operation为SET时，取值范围为：0~300。 operation为ADD或REMOVE/REDUCE时，取值范围为：1~300。 说明： 配置参数时，instance_number和instance_percentage参数只能选其中一个进行配置。 instance_percentage 否 Integer 操作实例百分比，将伸缩组容量增加、减少或设置为伸缩组当前实例个数的百分比。操作为ADD或REMOVE/REDUCE时取值范围为1到20000的整数，操作为SET时取值范围为0到20000的整数。 当instance_number和instance_percentage参数均无配置时，则操作实例个数为1。 配置参数时，instance_number和instance_percentage参数只能选其中一个进行配置。

请求示例 修改ID为0h327883-324n-4dzd-9c61-68d03ee191dd的伸缩策略，修改其名称为policy_01，修改其生效时间为从2016-01-08T17:31Z到2016-02-08T17:31Z且每天下午四点执行，设置实例数为2的周期性策略。 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", "instance_number": 2 }}

返回值 正常 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 网关超时。

响应示例 { "scaling_configuration": { "tenant": "ce061903a53545dcaddb300093b477d2", "scaling_configuration_id": "6afe46f9-7d3d-4046-8748-3b2a1085ad86", "scaling_configuration_name": " config_name_1", "instance_config": { "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS" }, { "size": 100, "volume_type": "SATA", "disk_type": "DATA" } ], "adminPass": "***", "personality": null, "instance_name": null, "instance_id": null, "flavorRef": "103", "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c", "key_name": "keypair01", "key_fingerprint" : "SHA256:qlvdUkYgSjKUxcr2uJgJJRMCKMLkJO5BPLooBcgsF8k", "public_ip": null, "user_data": null, "metadata": {}, "security_groups": [{ "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" }], "multi_flavor_priority_policy": "PICK_FIRST" }, "create_time": "2015-07-23T01:04:07Z" }}

响应消息 响应参数 表2 响应参数 参数 参数类型 描述 scaling_configuration scaling_configurations object 伸缩配置详情 表3 scaling_configurations字段数据结构说明 参数 参数类型 描述 scaling_configuration_id String 伸缩配置ID，全局唯一。 tenant String 租户ID。 scaling_configuration_name String 伸缩配置名称。 支持模糊匹配。 instance_config instance_config object 实例配置信息。 create_time String 创建伸缩配置时间，遵循UTC时间。 scaling_group_id String 绑定该伸缩配置的伸缩组ID。 表4 instance_config字段数据结构说明 参数 参数类型 描述 flavorRef String 云服务器的规格ID。 imageRef String 镜像ID，同image_id。 disk Array of disk objects 磁盘组信息。 key_name String 登录云服务器的SSH密钥名称。 key_fingerprint String 登录云服务器的SSH密钥指纹。 instance_name String 该参数为预留字段。 说明： 使用已有云服务器规格为模板创建的伸缩配置，查询伸缩配置和列表接口时instance_name为空 instance_id String 该参数为预留字段。 adminPass String 该参数为预留字段。 personality Array of personality objects 注入文件信息。 public_ip public_ip object 云服务器的弹性IP信息。 user_data String cloud-init用户数据，base64格式编码。 metadata metadata object 创建云服务器元数据，详情见表11。 security_groups Array of security_groups objects 安全组信息。 server_group_id String 云服务器组ID。 tenancy String 在专属主机上创建弹性云服务器。 dedicated_host_id String 专属主机的ID。 market_type String 云服务器的计费模式，可以选择竞价计费或按需计费。 multi_flavor_priority_policy String 使用伸缩配置创建云主机的时候，多规格使用的优先级策略。 。 表5 disk字段数据结构说明 参数 参数类型 描述 size Integer 磁盘大小，容量单位为GB。 volume_type String 磁盘类型。 disk_type String 系统盘还是数据盘，DATA表示为数据盘，SYS表示为系统盘。 dedicated_storage_id String 磁盘所属的专属存储ID。 data_disk_image_id String 导入数据盘的数据盘镜像ID。 snapshot_id String 磁盘备份的快照ID。 metadata metadata object 创建磁盘的元数据，详情见表6。 iops Integer 云硬盘的iops。当“volume_type”设置为GPSSD2、ESSD2类型的云硬盘时，该参数可以设置。 说明： 了解GPSSD2、ESSD2类型云硬盘的iops，请参见磁盘类型及性能介绍。 仅支持按需计费。 throughput Integer 云硬盘的吞吐量，单位是MiB/s。当“volume_type”设置为GPSSD2类型的云硬盘时，该参数可以设置。 说明： 了解GPSSD2类型云硬盘的吞吐量大小范围，请参见磁盘类型及性能介绍。 仅支持按需计费。 表6 personality字段数据结构说明 参数 参数类型 描述 path String 注入文件路径信息。 content String 注入文件内容，base64格式编码。 表7 public_ip字段数据结构说明 参数 参数类型 描述 eip eip object 云服务器自动分配弹性IP时，创建弹性IP的配置参数。 表8 eip字段数据结构说明 参数 参数类型 描述 ip_type String IP地址类型 bandwidth bandwidth object IP地址带宽参数 表9 bandwidth字段数据结构说明 参数 参数类型 描述 size Integer 带宽（Mbit/s）。 share_type String 带宽的共享类型。 共享类型枚举： PER：独享型。 WHOLE：共享型。 charging_mode String 带宽的计费类型。 bandwidth：按带宽计费。 traffic：按流量计费。 id String 带宽ID，创建WHOLE类型带宽的弹性IP时指定的共享带宽。 表10 metadata字段数据结构说明 参数 参数类型 描述 admin_pass String Windows弹性云服务器Administrator用户的密码。 表11 security_groups字段数据结构说明 参数 参数类型 描述 id String 安全组ID

URI GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_configuration_id 是 String 伸缩配置ID，该ID对应全局唯一配置。可参考查询弹性伸缩配置详情获取。

返回值 正常 204 异常 返回值 说明 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 网关超时。

URI DELETE /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_ configuration _id 是 String 伸缩配置ID，可参考查询弹性伸缩配置列表获取。

返回值 正常 204 异常 返回值 说明 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 网关超时。

返回值 正常 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 网关超时。

请求示例 创建一个名称为as-config-tlzp，镜像ID为627a1223-2ca3-46a7-8d5f-7aef22c74ee6，规格ID为s3.xlarge.4，系统盘为40G的SATA盘，且SSH密钥名称为100vm_key的伸缩配置。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration{ "scaling_configuration_name": "as-config-tlzq", "instance_config": { "flavorRef": "s3.xlarge.4", "imageRef": "627a1223-2ca3-46a7-8d5f-7aef22c74ee6", "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS" } ], "key_name": "100vm_key" ,"security_groups": [{"id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"}], "multi_flavor_priority_policy": "PICK_FIRST" } }