查询弹性伸缩组列表 - ListScalingGroups

project_id

是

String

参数解释：

项目ID。获取方式请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scaling_group_name

否

String

参数解释：

伸缩组名称。支持模糊匹配。

约束限制：

不涉及

取值范围：

1-64个字符，只能包含中文、字母、数字、下划线或中划线。

默认取值：

不涉及

scaling_configuration_id

否

String

参数解释：

伸缩配置ID，通过查询弹性伸缩配置列表接口获取，请参考查询弹性伸缩配置列表 - ListScalingConfigs。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

scaling_group_status

否

String

参数解释：

伸缩组状态。

约束限制：

不涉及

取值范围：

取值如下：

• INSERVICE：正常状态
• PAUSED：停用状态
• ERROR：异常状态
• DELETING：删除中
• FREEZED：已冻结

默认取值：

不涉及

start_number

否

Integer

参数解释：

查询的起始行号。

约束限制：

不涉及

取值范围：

最小值为0，最大值没有限制。

默认取值：

默认为0

limit

否

Integer

参数解释：

查询的记录条数。

约束限制：

不涉及

取值范围：

取值范围为：0~100。

默认取值：

默认为20。

enterprise_project_id

否

String

参数解释：

企业项目ID，当传入all_granted_eps时表示查询该用户所有授权的企业项目下的伸缩组列表，如何获取企业项目ID，请参考查询企业项目列表。

约束限制：

当伸缩组配置企业项目时，由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。

取值范围：

• 取值为0或无该值，表示属于default企业项目。
• 取值为UUID，表示属于该UUID对应的企业项目。

默认取值：

不涉及

total_number

Integer

参数解释：

总记录数。

取值范围：

不涉及

start_number

Integer

参数解释：

查询的开始记录号。

取值范围：

最小值为0，最大值没有限制。

limit

Integer

参数解释：

查询记录数。

取值范围：

不涉及

scaling_groups

Array of scaling_groups objects

参数解释：

伸缩组列表。

scaling_group_name

String

参数解释：

伸缩组名称。

取值范围：

1-64个字符，只能包含中文、字母、数字、下划线或中划线。

scaling_group_id

String

参数解释：

伸缩组ID。

取值范围：

不涉及

scaling_group_status

String

参数解释：

伸缩组状态

取值范围：

取值如下：

• INSERVICE：正常状态
• PAUSED：停用状态
• ERROR：异常状态
• DELETING：删除中
• FREEZED：已冻结

scaling_configuration_id

String

参数解释：

伸缩配置ID。

取值范围：

不涉及

scaling_configuration_name

String

参数解释：

伸缩配置名称。

取值范围：

1-64个字符，只能包含中文、字母、数字、下划线或中划线。

current_instance_number

Integer

参数解释：

伸缩组中当前实例数。

取值范围：

不涉及

desire_instance_number

Integer

参数解释：

伸缩组中期望实例数。

取值范围：

不涉及

min_instance_number

Integer

参数解释：

伸缩组中最小实例数。

取值范围：

不涉及

max_instance_number

Integer

参数解释：

伸缩组中最大实例数。

取值范围：

0-300的整数。

cool_down_time

Integer

参数解释：

冷却时间，单位是秒。

取值范围：

0-86400秒。

lb_listener_id

String

参数解释：

经典型负载均衡监听器ID，多个负载均衡监听器ID以逗号分隔。

取值范围：

不涉及

lbaas_listeners

Array of lbaas_listeners objects

参数解释：

增强型负载均衡器信息，详情请见表 lbaas_listeners字段数据结构说明。

available_zones

Array of strings

参数解释：

可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区，会由系统自动指定可用区。详情请参考地区和终端节点。

约束限制：

仅当伸缩组中无伸缩活动时，才可以修改可用区配置。

networks

Array of networks objects

参数解释：

网络信息，详情请见表5

security_groups

Array of security_groups objects

参数解释：

安全组信息，详情请见表8

create_time

String

参数解释：

创建伸缩组时间，遵循UTC时间。

取值范围：

不涉及

vpc_id

String

参数解释：

伸缩组所在的VPC ID。

取值范围：

不涉及

detail

String

参数解释：

伸缩组详情。当伸缩活动失败时，在此处记录错误信息。

取值范围：

不涉及

is_scaling

Boolean

参数解释：

伸缩组伸缩标志。

取值范围：

不涉及

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秒级健康检查。

health_periodic_audit_grace_period

Integer

参数解释：

健康状况检查宽限期。

取值范围：

取值范围0-86400，单位为秒。

instance_terminate_policy

String

参数解释：

移除策略。

取值范围：

• OLD_CONFIG_OLD_INSTANCE（默认）：从“较早创建的配置”创建的实例中选择较早创建的实例进行优先移除。
• OLD_CONFIG_NEW_INSTANCE：从“较早创建的配置”创建的实例中选择较晚创建的实例进行优先移除。
• OLD_INSTANCE：较早创建的实例被优先移除。
• NEW_INSTANCE：较晚创建的实例将被优先移除。

delete_publicip

Boolean

参数解释：

删除云服务器是否删除云服务器绑定的弹性IP。

取值范围：

• true：删除云服务器时，会同时删除绑定在云服务器上的弹性IP。
• false：删除云服务器时，仅解绑定在云服务器上的弹性IP，不删除弹性IP。

delete_volume

Boolean

参数解释：

删除云服务器是否删除云服务器绑定的数据盘。

取值范围：

• true：删除云服务器时，会同时删除绑定在云服务器上的数据盘。当数据盘的计费方式为包年包月时，不会被删除。
• false：删除云服务器时，仅解绑定在云服务器上的数据盘，不删除数据盘。

cloud_location_id

String

参数解释：

伸缩组所属cloud_location，该参数为预留字段。

取值范围：

不涉及

enterprise_project_id

String

参数解释：

企业项目ID

取值范围：

不涉及

activity_type

String

参数解释：

伸缩组活动类型。

取值范围：

• NORMAL：普通伸缩活动
• MANNUAL_REMOVE：从伸缩组手动移除实例
• MANNUAL_DELETE：从伸缩组手动移除并删除实例
• MANNUAL_ADD：实例手动加入伸缩组。
• ELB_CHECK_DELETE：ELB检查移除并删除实例。
• AUDIT_CHECK_DELETE：通过审计移除并删除实例。
• DIFF：期望实例数与实际实例数不一致。
• MODIFY_ELB：ELB迁移。
• ENTER_STANDBY：实例转入备用。
• EXIT_STANDBY：实例移出备用。

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

参数解释：

委托的名称。委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的，可以为弹性云服务器提供访问云服务的临时凭证。

取值范围：

1-64个字符

tags

Array of tags objects

参数解释：

添加到伸缩组的标签。详情请见表9

listener_id

String

参数解释：

监听器ID

取值范围：

不涉及

pool_id

String

参数解释：

后端服务器组ID。如何获取请参见查询后端服务器组列表。

取值范围：

不涉及

protocol_port

Integer

参数解释：

后端协议号，指后端云服务器监听的端口。

取值范围：

[1, 65535]

weight

Integer

参数解释：

权重，指后端云服务器经分发得到的请求数量的比例。

取值范围：

[0, 100]

protocol_version

String

参数解释：

绑定到负载均衡云服务器组的IP地址版本。

取值范围：

• ipv4：表示使用IPv4地址版本。
• ipv6：表示使用IPv6地址版本。

id

String

参数解释：

子网的网络ID。

取值范围：

不涉及

ipv6_enable

Boolean

参数解释：

是否启用IPv6。取值为true时，表示此网卡已启用ipv6。

取值范围：

不涉及

ipv6_bandwidth

ipv6_bandwidth object

参数解释：

绑定的IPv6共享带宽，默认为空，表示不绑定IPv6的共享带宽。字段数据结构说明请参见表6。

allowed_address_pairs

Array of allowed_address_pairs objects

参数解释：

是否开启源/目的检查开关。字段数据结构说明请参见表7。

id

String

参数解释：

IPv6共享带宽的ID。

取值范围：

不涉及

ip_address

String

参数解释：

IP地址，用于控制是否开启源/目的检查开关。

默认是开启，不允许置空。

取值范围：

• 关闭：1.1.1.1/0
• 开启：除“1.1.1.1/0”以外的其余值均按开启处理

id

String

参数解释：

安全组ID

取值范围：

不涉及

key

是

String

参数解释：

键。

取值范围：

• 最大长度36个unicode字符。key不能为空。
• 同一资源的key值不能重复。

• 只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）以及中文字符。

value

否

String

参数解释：

值。

取值范围：

• 每个值最大长度43个unicode字符，可以为空字符串。
• value值只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）、小数点（.）以及中文字符。