弹性伸缩 AS-创建弹性伸缩组:请求参数

时间：2024-09-06 15:26:17

弹性伸缩 AS

请求参数

表2 请求参数
参数	是否必选	参数类型	描述
scaling_group_name	是	String	伸缩组名称(1-64个字符)，只能包含中文、字母、数字、下划线或中划线。
scaling_configuration_id	是	String	伸缩配置ID，通过查询弹性伸缩配置列表接口获取，请参考查询弹性伸缩配置列表。
desire_instance_number	否	Integer	期望实例数量，默认值为最小实例数。最小实例数≤期望实例数≤最大实例数。
min_instance_number	否	Integer	最小实例数量，默认值为0。
max_instance_number	否	Integer	最大实例数量，默认值为1。取值范围为0-300的整数。
cool_down_time	否	Integer	冷却时间，取值范围0-86400，默认为300，单位是秒。在每次伸缩活动完成之后，系统开始计算冷却时间。伸缩组在冷却时间内，会拒绝告警策略的触发，其他类型的伸缩策略（如定时策略和周期策略）及手动触发不受限制。说明：伸缩组在进行扩容活动过程中，允许缩容策略的触发，扩容活动结束后执行缩容活动，不受冷却时间影响。伸缩组在进行缩容活动过程中，允许扩容策略的触发，缩容活动结束后执行扩容活动，不受冷却时间影响。
lb_listener_id	否	String	弹性负载均衡监听器ID，最多支持绑定6个负载均衡监听器，多个负载均衡监听器ID以逗号分隔。获取监听器ID的方法请参考查询负载均衡器列表。该字段与lbaas_listeners互斥。
lbaas_listeners	否	Array of lbaas_listeners objects	弹性负载均衡器信息，最多支持绑定6个负载均衡。列表数据结构请参考表3。获取负载均衡器的信息请参考查询后端云服务器组。该字段与lb_listener_id互斥。
available_zones	否	Array of strings	可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区，会由系统自动指定可用区。详情请参考地区和终端节点。
networks	是	Array of networks objects	网络信息，最多支持选择5个子网，传入的第一个子网默认作为云服务器的主网卡。获取子网信息请参考查询子网列表。数据结构信息请参考表4。
security_groups	否	Array of security_groups objects	安全组信息，仅支持选择1个安全组。获取安全组信息请参考查询安全组列表。数据结构信息请参考表7。当伸缩配置和伸缩组同时指定安全组时，将以伸缩配置中的安全组为准；当伸缩配置和伸缩组都没有指定安全组时，增加的弹性云服务器将使用默认安全组。为了使用灵活性更高，推荐在伸缩配置中指定安全组。
vpc_id	是	String	虚拟私有云（VPC）信息，获取VPC信息具体操作请参考查询VPC列表。
health_periodic_audit_method	否	String	伸缩组实例健康检查方式：ELB_AUDIT和NOVA_AUDIT。当伸缩组设置负载均衡时，默认为ELB_AUDIT；否则默认为NOVA_AUDIT。 ELB_AUDIT：负载均衡健康检查方式，在有监听器的伸缩组中有效。 NOVA_AUDIT：云服务器健康检查方式，是弹性伸缩自带的健康检查方式。
health_periodic_audit_time	否	Integer	伸缩组实例的健康检查周期，可设置为1、5、15、60、180（分钟），若不设置该参数，默认为5。若设置为0，可以实现10秒级健康检查。
health_periodic_audit_grace_period	否	Integer	伸缩组实例健康状况检查宽限期，取值范围0-86400，单位是秒，默认为600。当实例加入伸缩组并且进入已启用状态后，健康状况检查宽限期才会启动，伸缩组会等健康状况检查宽限期结束后才检查实例的运行状况。当伸缩组实例健康检查方式为ELB_AUDIT时，该参数生效。
instance_terminate_policy	否	String	伸缩组实例移除策略： OLD_CONFIG_OLD_INSTANCE（默认）：从“较早创建的配置”创建的实例中选择较早创建的实例进行优先移除。 OLD_CONFIG_NEW_INSTANCE：从“较早创建的配置”创建的实例中选择较晚创建的实例进行优先移除。 OLD_INSTANCE：较早创建的实例被优先移除。 NEW_INSTANCE：较晚创建的实例将被优先移除。
notifications	否	Array of strings	通知方式： EMAIL为发送邮件通知。该通知方式已经被废除，建议给弹性伸缩组配置通知功能。请参考通知。
delete_publicip	否	Boolean	配置删除云服务器时（即进行实例缩容时，将云服务器从伸缩组中移出）是否删除云服务器绑定的弹性IP。取值为true或false，默认为false。 true：删除云服务器时，会同时删除绑定在云服务器上的弹性IP。当弹性IP的计费方式为包年包月时，不会被删除。 false：删除云服务器时，仅解绑定在云服务器上的弹性IP，不删除弹性IP。
delete_volume	否	Boolean	配置删除云服务器时（即进行实例缩容时，将云服务器从伸缩组中移出）是否删除云服务器绑定的数据盘。取值为true或false，默认为false。 true：删除云服务器时，会同时删除绑定在云服务器上的数据盘。当数据盘的计费方式为包年包月时，不会被删除。 false：删除云服务器时，仅解绑定在云服务器上的数据盘，不删除数据盘。
enterprise_project_id	否	String	企业项目ID，用于指定伸缩组归属的企业项目。取值为0或无该值，表示属于default企业项目。取值为UUID，表示属于该UUID对应的企业项目，如何获取企业项目ID，请参考查询企业项目列表。当伸缩组配置企业项目时，由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。说明：关于企业项目特性的详细信息，请参见企业项目管理。
multi_az_priority_policy	否	String	伸缩组扩缩容时目标AZ选择的优先级策略： EQUILIBRIUM_DISTRIBUTE（默认）：均衡分布，云服务器扩缩容时优先保证available_zones列表中各AZ下虚拟机数量均衡，当无法在目标AZ下完成虚拟机扩容时，按照PICK_FIRST原则选择其他可用AZ。 PICK_FIRST：选择优先，虚拟机扩缩容时目标AZ的选择按照available_zones列表的顺序进行优先级排序。
description	否	String	伸缩组描述（1-256个字符）。
iam_agency_name	否	String	委托（1-64个字符）。 iam_agency_name为空或者无值则不传递该字段。 iam_agency_name不为空则向下传递。
tags	否	Array of tags objects	创建特定标签并将其添加到伸缩组。每个伸缩组最多添加10个标签。详情请参考表8。

表3 lbaas_listeners字段数据结构说明
参数	是否必选	参数类型	描述
pool_id	是	String	后端云服务器组ID
protocol_port	是	Integer	后端协议号，指后端云服务器监听的端口，取值范围[1, 65535]。
weight	是	Integer	权重，指后端云服务器经分发得到的请求数量的比例，取值范围[0, 100]。
protocol_version	否	String	绑定到负载均衡云服务器组的IP地址版本，枚举值支持ipv4和ipv6。说明：伸缩组实例不支持多网卡双栈，仅支持首网卡双栈，其他网卡地址会被忽略。首网卡是指从弹性云服务器查询到的第一张支持所选IP地址版本的网卡，可能是主网卡，也可能是扩展网卡。只有选择支持IPv6的弹性云服务器，才可以使用IPv4/IPv6双栈网络，请务必选择支持的区域和规格。当pool_id、protocol_port、protocol_version均一致时，会进行去重。

表4 networks字段数据结构说明
参数	是否必选	参数类型	描述
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	是否开启源/目的检查开关。

表5 ipv6_bandwidth字段数据结构说明
参数	是否必选	参数类型	描述
id	是	String	IPv6共享带宽的ID

表6 allowed_address_pairs字段数据结构说明
参数	是否必选	参数类型	描述
ip_address	否	String	是否开启源/目的检查开关。默认是开启，不允许置空。关闭：1.1.1.1/0 开启：除“1.1.1.1/0”以外的其余值均按开启处理

表7 security_groups字段数据结构说明
参数	是否必选	参数类型	描述
id	是	String	安全组ID

表8 tags字段数据结构说明
参数	是否必选	参数类型	描述
key	是	String	键。最大长度36个unicode字符。key不能为空。同一资源的key值不能重复。只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）以及中文字符。
value	否	String	值。每个值最大长度43个unicode字符，可以为空字符串。 value值只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）、小数点（.）以及中文字符。