华为云用户手册

返回值 正常 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 请求参数 参数 是否必选 参数类型 描述 tags 是 Array of ResourceTag objects 标签列表。详情请见表 ResourceTag字段数据结构说明。 action为delete时，tags结构体不能缺失，key不能为空，或者空字符串。 action 是 String 操作标识（区分大小写）： delete：删除。 create：创建。若已经存在相同的key值则会覆盖对应的value值。 表3 ResourceTag字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 资源标签键。同一资源的key值不能重复。 最大长度36个字符。字符集：A-Z，a-z，0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value 否 String 资源标签值。 每个值最大长度43个字符，可以为空字符串。字符集：A-Z，a-z，0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

URI POST /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID resource_type 是 String 资源类型，枚举类： scaling_group_tag：资源类型为伸缩组。 resource_id 是 String 资源ID

请求示例 创建资源标签，在ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组下，一组资源键值对为key=ENV15，value=ENV15，另一组资源键值对key=ENV151，value=ENV151。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action{ "tags": [ { "key": "ENV15", "value": "ENV15" }, { "key": "ENV151", "value": "ENV151" } ], "action": "create" }

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

响应示例 { "scaling_policy": { "scaling_policy_id": "906f73ff-56e8-41b2-a005-8157d0c60361", "scaling_policy_name": "hth_aspolicy_1", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "BANDW IDT H", "scaling_policy_type": "ALARM", "alarm_id": "al1513822380493GvlJKZwA8", "scheduled_policy": { }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1, "limits": 111 }, "policy_status": "INSERVICE", "create_time": "2018-03-21T08:03:35Z", "meta_data": { "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e", "metadata_eip_address": "255.255.255.255" } }}

响应参数 表2 响应参数 参数 参数类型 描述 scaling_policy scaling_policy object 伸缩策略详情。详情请见表 scaling_policy字段数据结构说明。 表3 scaling_policy字段数据结构说明 参数 参数类型 描述 scaling_resource_id String 伸缩资源ID scaling_resource_type string 伸缩资源类型 伸缩组：SCALING_GROUP 带宽：BANDWIDTH scaling_policy_name String 伸缩策略名称。 支持模糊匹配。 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字段数据结构说明。 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地址。

响应示例 { "tags": [ { "key": "ENV15", "values": [ "ENV15" ] }, { "key": "111", "values": [ "" ] }, { "key": "environment", "values": [ "DEV" ] }, { "key": "ENV151", "values": [ "ENV151" ] }, { "key": "ENV152", "values": [ "ENV152" ] } ] }

返回值 正常 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_policy": { "scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "scaling_policy_name": "定时1", "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 网关超时。

响应参数 表2 响应参数 参数 参数类型 描述 scaling_policy scaling_policy object 伸缩策略详情。详情请见表 scaling_policy字段数据结构说明。 表3 scaling_policy字段数据结构说明 参数 参数类型 描述 scaling_group_id String 伸缩组ID scaling_policy_name String 伸缩策略名称。 支持模糊匹配。 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 冷却时间，单位秒。 create_time String 创建伸缩策略时间，遵循UTC时间。 表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：增加实例 REMOVE：减少实例 SET：设置实例数为 instance_number Integer 操作实例个数。 instance_percentage 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", "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 网关超时。

请求示例 查询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

URI GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤，请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 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。

响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_policies Array of scaling_policies objects 伸缩策略列表，详情请见表 scaling_policies字段数据结构说明。 表3 scaling_policies字段数据结构说明 参数 参数类型 描述 scaling_group_id String 伸缩组ID scaling_policy_name String 伸缩策略名称 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 冷却时间，单位秒。 create_time String 创建伸缩策略时间，遵循UTC时间。 表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：增加实例 REMOVE：减少实例 SET：设置实例数为 instance_number Integer 操作实例个数。 instance_percentage Integer 操作实例百分比。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_policy_name 否 String 伸缩策略名称（1-64个字符），只能包含中文、字母、数字、下划线或中划线。 scaling_policy_type 否 String 策略类型 告警策略：ALARM(与alarm_id对应) 定时策略：SCHEDULED(与scheduled_policy对应) 周期策略：RECURRENCE(与scheduled_policy对应) scaling_resource_id 否 String 伸缩资源ID，伸缩组唯一标识或带宽唯一标识。 scaling_resource_type 否 string 伸缩资源类型 伸缩组：SCALING_GROUP 带宽：BANDWIDTH 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字段数据结构说明。 interval_alarm_actions 否 Array of interval_alarm_actions objects 伸缩策略告警区间，当scaling_policy_type为INTERVAL_ALARM时，该参数生效且必填。详情请见表 interval_alarm_actions字段数据结构说明。 cool_down_time 否 Integer 冷却时间，取值范围0-86400，单位是秒。 description 否 String 伸缩策略描述（1-256个字符）。 表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。 当scaling_resource_type为SCALING_GROUP，支持如下操作： ADD：增加 REMOVE/REDUCE：减少 SET：设置为 当scaling_resource_type为BANDWIDTH，支持如下操作： ADD：增加 REDUCE：减少 SET：设置为 size 否 Integer 操作大小，取值范围为0到300的整数，默认为1。只有操作为SET时取值可以为0，其余操作取值均不能为0。 当scaling_resource_type为SCALING_GROUP时，size为实例个数，取值范围为0到300的整数，默认为1。 当scaling_resource_type为BANDWIDTH时，size表示带宽大小，单位为Mbit/s，取值范围为1到300的整数，默认为1。 当scaling_resource_type为SCALING_GROUP时，size和percentage参数只能选其中一个进行配置。 percentage 否 Integer 操作百分比，操作为ADD或REMOVE/REDUCE时取值范围为1到20000的整数，操作为SET时取值范围为0到20000的整数。 当scaling_resource_type为SCALING_GROUP时，size和percentage参数只能选其中一个进行配置，如果size和percentage参数均无配置，则size默认为1。 当scaling_resource_type为BANDWIDTH时，不支持配置percentage参数。 limits 否 Integer 操作限制 当scaling_resource_type为BANDWIDTH，且operation不为SET时，limits参数生效，单位为Mbit/s。 当operation为ADD时，limits表示带宽可调整的上限； 当operation为REDUCE时，limits表示带宽可调整的下限。 表5 interval_alarm_actions字段数据结构说明 参数 是否必选 参数类型 描述 lower_bound 否 double 区间下限，默认为空。 区间下限为空时，区间上限必须小于等于0。 区间下限最小值为-1.174271E108。 upper_bound 否 double 区间上限，默认为空。 区间上限为空时，区间下限必须大于等于0。 区间上限最大值为1.174271E108。 operation 否 String 操作选项，默认为ADD。 当scaling_resource_type为SCALING_GROUP，支持如下操作： ADD：增加 REMOVE/REDUCE：减少 SET：设置为 当scaling_resource_type为BANDWIDTH，支持如下操作： ADD：增加 REDUCE：减少 SET：设置为 size 否 Integer 操作大小，取值范围为0到300的整数，默认为1。 只有操作为SET时，取值可以为0，其余操作取值均不能为0。 当scaling_resource_type为SCALING_GROUP时，size为实例个数，取值范围为0到300的整数，默认为1。 当scaling_resource_type为BANDWIDTH时，size表示带宽大小，单位为Mbit/s，取值范围为1到300的整数，默认为1。 当scaling_resource_type为SCALING_GROUP时，size和percentage参数只能选其中一个进行配置。 percentage 否 Integer 操作百分比，操作为ADD或REMOVE或REDUCE时，取值范围为1到20000的整数； 操作为SET时，取值范围为0到20000的整数。 当scaling_resource_type为SCALING_GROUP时，size和percentage参数只能选其中一个进行配置，若size和percentage参数均无配置，则size默认为1。 当scaling_resource_type为BANDWIDTH时，不支持配置percentage参数。 limits 否 Integer 操作限制 当scaling_resource_type为BANDWIDTH，且operation不为SET时，limits参数生效，单位为Mbit/s。 当operation为ADD时，limits表示带宽可调整的上限； 当operation为REDUCE时，limits表示带宽可调整的下限。

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

返回值 正常 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": 2, "start_number": 0, "scaling_configurations": [ { "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" } ], "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" }], }, "create_time": "2015-07-23T01:04:07Z" }, { "tenant": "ce061903a53545dcaddb300093b477d2", "scaling_configuration_id": "24a8c5f3-c713-4aba-ac29-c17101009e5d", "scaling_configuration_name": "config_name_2", "instance_config": { "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS" } ], "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-22T01:08:41Z" } ]}

响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数。 start_number Integer 查询的起始行号。 limit Integer 查询记录数。 scaling_configurations Array of scaling_configurations objects 伸缩配置列表。 表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 创建磁盘的metadata字段数据结构说明 参数 参数类型 描述 __system__encrypted String metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，云硬盘默认为不加密。 __system__cmkid String 用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。 说明： 请参考查询密钥列表，通过HTTPS请求获取密钥ID。 表7 personality字段数据结构说明 参数 参数类型 描述 path String 注入文件路径信息。 content String 注入文件内容，base64格式编码。 表8 public_ip字段数据结构说明 参数 参数类型 描述 eip eip object 云服务器自动分配弹性IP时，创建弹性IP的配置参数。 表9 eip字段数据结构说明 参数 参数类型 描述 ip_type String IP地址类型。 bandwidth bandwidth object IP地址带宽参数。 表10 bandwidth字段数据结构说明 参数 参数类型 描述 size Integer 带宽（Mbit/s）。 share_type String 带宽的共享类型。 共享类型枚举： PER：独享型。 WHOLE：共享型。 charging_mode String 带宽的计费类型。 bandwidth：按带宽计费。 traffic：按流量计费。 id String 带宽ID，创建WHOLE类型带宽的弹性IP时指定的共享带宽。 表11 metadata字段数据结构说明 参数 参数类型 描述 admin_pass String Windows弹性云服务器Administrator用户的密码。 表12 security_groups字段数据结构说明 参数 参数类型 描述 id String 安全组ID

URI GET /autoscaling-api/v1/{project_id}/scaling_configuration 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤，请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_configuration_name 否 String 伸缩配置名称。 支持模糊匹配。 image_id 否 String 镜像ID，同imageRef。 start_number 否 Integer 查询的起始行号，默认为0。最小值为0。 limit 否 Integer 查询的记录条数，默认为20。取值范围为：0~100。

URI DELETE /autoscaling-api/v1/{project_id}/scaling_group_instance/{instance_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID，可参考查询弹性伸缩组中的实例列表获取。 instance_delete 否 String 实例移出伸缩组时，是否删除该实例。 取值如下： 不删除实例：no，默认为no。 删除实例：yes

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

响应示例 { "limit": 10, "total_number": 1, "start_number": 0, "scaling_group_instances": [ { "instance_id": "b25c1589-c96c-465b-9fef-d06540d1945c", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "scaling_group_name": "discuz", "life_cycle_state": "INSERVICE", "health_status": "NORMAL", "scaling_configuration_name": "discuz", "scaling_configuration_id": "ca3dcd84-d197-4c4f-af2a-cf8ba39696ac", "create_time": "2015-07-23T06:47:33Z", "instance_name": "discuz_3D210808", "protect_from_scaling_down": false } ]}

响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_group_instances Array of scaling_group_instances objects 伸缩组实例详情 表3 scaling_group_instances字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID instance_name String 实例名称 scaling_group_id String 实例所在伸缩组ID scaling_group_name String 实例所在伸缩组名称。 支持模糊匹配。 life_cycle_state String 实例在伸缩组中的生命周期状态： INSERVICE：已启用 PENDING：正在加入伸缩组 PENDING_WAIT：等待（正在加入伸缩组） REMOVING：正在移出伸缩组 REMOVING_WAIT：等待（正在移出伸缩组） STANDBY：已备用 ENTERING_STANDBY：进入备用状态 health_status String 实例健康状态： INITAILIZING：初始化。 NORMAL：正常。 ERROR：错误。 scaling_configuration_name String 伸缩配置名称。 scaling_configuration_id String 伸缩配置ID。 若返回不为空，表示该实例为弹性伸缩自动创建的E CS 实例。 若返回为空，表示该实例为用户手动添加到伸缩组的ECS实例。 create_time String 实例加入伸缩组时间，遵循UTC时间。 protect_from_scaling_down Boolean 实例的实例保护属性。

返回值 正常 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为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组下已启用且处于健康状态的实例。 GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?life_cycle_state=INSERVICE&health_status=NORMAL