功能介绍
修改一个指定 弹性伸缩 组中的信息。
调试
您可以在API Explorer中调试该接口。
URI
PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
scaling_group_id |
是 |
String |
伸缩组ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
scaling_group_name |
否 |
String |
伸缩组名称(1-64个字符),只能包含中文、字母、数字、下划线或中划线。 |
desire_instance_number |
否 |
Integer |
期望实例数量。 最小实例数≤期望实例数≤最大实例数。 |
min_instance_number |
否 |
Integer |
最小实例数量。 |
max_instance_number |
否 |
Integer |
最大实例数量,大于等于最小实例数。 |
cool_down_time |
否 |
Integer |
冷却时间,取值范围0-86400,默认为300,单位是秒。 |
available_zones |
否 |
Array of strings |
可用区信息。弹性伸缩活动中自动添加的 云服务 器会被创建在指定的可用区中。如果没有指定可用区,会由系统自动指定可用区。 仅当伸缩组中无伸缩活动时,才可以修改可用区配置。 |
networks |
否 |
Array of networks objects |
网络信息,最多支持选择5个子网,传入的第一个子网默认作为云服务器的主网卡。获取子网信息请参考查询子网列表。数据结构信息请参考表4。 仅当同时满足以下条件时,才可以修改:
|
security_groups |
否 |
安全组信息,仅支持选择1个安全组。获取安全组信息请参考查询安全组列表。数据结构信息请参考表7。 当伸缩配置和伸缩组同时指定安全组时,将以伸缩配置中的安全组为准;当伸缩配置和伸缩组都没有指定安全组时,增加的弹性云服务器将使用默认安全组。为了使用灵活性更高,推荐在伸缩配置中指定安全组。仅当同时满足以下条件时,才可以修改:
|
|
lb_listener_id |
否 |
String |
弹性负载均衡 监听器ID,最多支持绑定6个负载均衡监听器,多个负载均衡监听器ID以逗号分隔。获取监听器ID的方法请参考查询负载均衡器列表。 仅当同时满足以下条件时,才可以修改:
|
lbaas_listeners |
否 |
弹性负载均衡器信息,最多支持绑定6个负载均衡。列表数据结构请参考表3。获取负载均衡器的信息请参考查询后端云服务器组。 |
|
health_periodic_audit_method |
否 |
String |
伸缩组实例健康检查方式:ELB_AUDIT和NOVA_AUDIT。当伸缩组设置负载均衡时,默认为ELB_AUDIT;否则默认为NOVA_AUDIT。
|
health_periodic_audit_time |
否 |
Integer |
伸缩组实例健康检查周期(分钟):1、5、15、60、180。 若设置为0,可以实现10秒级健康检查。 |
instance_terminate_policy |
否 |
String |
伸缩组实例移除策略:
|
health_periodic_audit_grace_period |
否 |
Integer |
伸缩组实例健康状况检查宽限期,取值范围0-86400,单位是秒,默认为600。 当实例加入伸缩组并且进入已启用状态后,健康状况检查宽限期才会启动,伸缩组会等健康状况检查宽限期结束后才检查实例的运行状况。 当伸缩组实例健康检查方式为ELB_AUDIT时,该参数生效。 |
scaling_configuration_id |
否 |
String |
伸缩配置ID,通过查询弹性伸缩配置列表接口获取,请参考查询弹性伸缩配置列表。 |
notifications |
否 |
Array of strings |
通知方式: EMAIL为发送邮件通知。 该通知方式已经被废除,建议给弹性伸缩组配置通知功能。请参考通知。 |
delete_publicip |
否 |
Boolean |
配置删除云服务器是否删除云服务器绑定的弹性IP。如果选择不删除,则系统仅做解绑定操作,保留弹性IP资源。
|
delete_volume |
否 |
Boolean |
配置删除云服务器时是否删除云服务器绑定的数据盘。取值为true或false,默认为false。
|
ent erp rise_project_id |
否 |
String |
企业项目ID,用于指定伸缩组归属的企业项目。
当伸缩组配置企业项目时,由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。 说明:
关于企业项目特性的详细信息,请参见企业项目管理。 |
multi_az_priority_policy |
否 |
String |
伸缩组扩缩容时目标AZ选择的优先级策略:
|
description |
否 |
String |
伸缩组描述(1-256个字符)。 |
iam_agency_name |
否 |
String |
委托(1-64个字符)。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pool_id |
是 |
String |
后端云服务器组ID。 仅当同时满足以下条件时,才可以修改:
|
protocol_port |
是 |
Integer |
后端协议号,指后端云服务器监听的端口,取值范围[1, 65535]。 |
weight |
是 |
Integer |
权重,指后端云服务器经分发得到的请求数量的比例,取值范围[0, 100]。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
子网的网络ID。 |
ipv6_enable |
否 |
Boolean |
是否启用IPv6。 true:标识此网卡已启用ipv6。 false:标识此网卡未启用ipv6。默认取值为false。 |
ipv6_bandwidth |
否 |
ipv6_bandwidth object |
绑定的IPv6共享带宽。默认为空,表示未绑定IPv6的共享带宽。 |
allowed_address_pairs |
否 |
Array of allowed_address_pairs objects |
是否开启源/目的检查开关。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
IPv6共享带宽的ID |
参数 |
参数类型 |
描述 |
---|---|---|
ip_address |
String |
是否开启源/目的检查开关。 默认是开启,不允许置空。
|
请求示例
PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1 { "scaling_group_name": "group_1", "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2", "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "desire_instance_number": 1, "min_instance_number": 1, "max_instance_number": 3, "cool_down_time": 200, "multi_az_priority_policy": "PICK_FIRST", "iam_agency_name":"test" }
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
scaling_group_id |
String |
伸缩组ID。 |
响应示例
{ "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1" }
返回值
- 正常
- 异常
返回值
说明
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
网关超时。
错误码
请参考错误码。