public class CreateAutoScalingGroupRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
CreateAutoScalingGroupRequest() |
CreateAutoScalingGroupRequest(CreateAutoScalingGroupRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String |
getAutoScalingGroupName()
Get 伸缩组名称,在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超55个字节。
|
Boolean |
getCapacityRebalance()
Get 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。 FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。 默认取 FALSE。 |
Long |
getDefaultCooldown()
Get 默认冷却时间,单位秒,默认值为300
|
Long |
getDesiredCapacity()
Get 期望实例数,大小介于最小实例数和最大实例数之间
|
ForwardLoadBalancer[] |
getForwardLoadBalancers()
Get 应用型负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
|
String |
getHealthCheckType()
Get 伸缩组实例健康检查类型,取值如下:
CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553) CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097) 如果选择了`CLB`类型,伸缩组将同时检查实例网络状态与CLB健康检查状态,如果出现实例网络状态不健康,实例将被标记为 UNHEALTHY 状态;如果出现 CLB 健康检查状态异常,实例将被标记为CLB_UNHEALTHY 状态,如果两个异常状态同时出现,实例`HealthStatus`字段将返回 UNHEALTHY|CLB_UNHEALTHY。默认值:CLB |
String |
getInstanceAllocationPolicy()
Get 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED,默认取 LAUNCH_CONFIGURATION。
LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。 SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。 |
InstanceNameIndexSettings |
getInstanceNameIndexSettings()
Get 实例名称序号相关设置。若不指定该参数,则默认不开启。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。
|
Long |
getIpv6AddressCount()
Get 实例具有IPv6地址数量的配置,取值包括 0、1,默认值为0。
|
String |
getLaunchConfigurationId()
Get 启动配置ID
|
Long |
getLoadBalancerHealthCheckGracePeriod()
Get CLB健康检查宽限期,当扩容的实例进入`IN_SERVICE`后,在宽限期时间范围内将不会被标记为不健康`CLB_UNHEALTHY`。
默认值:0。取值范围[0, 7200],单位:秒。 |
String[] |
getLoadBalancerIds()
Get 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
|
Long |
getMaxSize()
Get 最大实例数,取值范围为0-2000。
|
Long |
getMinSize()
Get 最小实例数,取值范围为0-2000。
|
String |
getMultiZoneSubnetPolicy()
Get 多可用区/子网策略,取值包括 PRIORITY 和 EQUALITY,默认为 PRIORITY。
PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。 EQUALITY:扩容出的实例会打散到多个可用区/子网,保证扩容后的各个可用区/子网实例数相对均衡。 与本策略相关的注意点: 当伸缩组为基础网络时,本策略适用于多可用区;当伸缩组为VPC网络时,本策略适用于多子网,此时不再考虑可用区因素,例如四个子网ABCD,其中ABC处于可用区1,D处于可用区2,此时考虑子网ABCD进行排序,而不考虑可用区1、2。 本策略适用于多可用区/子网,不适用于启动配置的多机型。多机型按照优先级策略进行选择。 按照 PRIORITY 策略创建实例时,先保证多机型的策略,后保证多可用区/子网的策略。例如多机型A、B,多子网1、2、3,会按照A1、A2、A3、B1、B2、B3 进行尝试,如果A1售罄,会尝试A2(而非B1)。 |
Long |
getProjectId()
Get 伸缩组内实例所属项目ID。不填为默认项目。
|
String |
getRetryPolicy()
Get 重试策略,取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY,默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。
IMMEDIATE_RETRY,立即重试,在较短时间内快速重试,连续失败超过一定次数(5次)后不再重试。 INCREMENTAL_INTERVALS,间隔递增重试,随着连续失败次数的增加,重试间隔逐渐增大,重试间隔从秒级到1天不等。 NO_RETRY,不进行重试,直到再次收到用户调用或者告警信息后才会重试。 |
ServiceSettings |
getServiceSettings()
Get 服务设置,包括云监控不健康替换等服务设置。
|
SpotMixedAllocationPolicy |
getSpotMixedAllocationPolicy()
Get 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。
|
String[] |
getSubnetIds()
Get 子网ID列表,VPC场景下必须指定子网。多个子网以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。
|
Tag[] |
getTags()
Get 标签描述列表。通过指定该参数可以支持绑定标签到伸缩组。同时绑定标签到相应的资源实例。每个伸缩组最多支持30个标签。
|
String[] |
getTerminationPolicies()
Get 销毁策略,目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE,默认取值为 OLDEST_INSTANCE。
OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。 NEWEST_INSTANCE,优先销毁伸缩组中最新的实例。 |
String |
getVpcId()
Get VPC ID,基础网络则填空字符串
|
String[] |
getZones()
Get 可用区列表,基础网络场景下必须指定可用区。多个可用区以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。
|
String |
getZonesCheckPolicy()
Get 可用区校验策略,取值包括 ALL 和 ANY,默认取值为ANY。
ALL,所有可用区(Zone)或子网(SubnetId)都可用则通过校验,否则校验报错。 ANY,存在任何一个可用区(Zone)或子网(SubnetId)可用则通过校验,否则校验报错。 可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。 如果 Zones/SubnetIds 中可用区或者子网不存在,则无论 ZonesCheckPolicy 采用何种取值,都会校验报错。 |
void |
setAutoScalingGroupName(String AutoScalingGroupName)
Set 伸缩组名称,在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超55个字节。
|
void |
setCapacityRebalance(Boolean CapacityRebalance)
Set 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。 FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。 默认取 FALSE。 |
void |
setDefaultCooldown(Long DefaultCooldown)
Set 默认冷却时间,单位秒,默认值为300
|
void |
setDesiredCapacity(Long DesiredCapacity)
Set 期望实例数,大小介于最小实例数和最大实例数之间
|
void |
setForwardLoadBalancers(ForwardLoadBalancer[] ForwardLoadBalancers)
Set 应用型负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
|
void |
setHealthCheckType(String HealthCheckType)
Set 伸缩组实例健康检查类型,取值如下:
CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553) CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097) 如果选择了`CLB`类型,伸缩组将同时检查实例网络状态与CLB健康检查状态,如果出现实例网络状态不健康,实例将被标记为 UNHEALTHY 状态;如果出现 CLB 健康检查状态异常,实例将被标记为CLB_UNHEALTHY 状态,如果两个异常状态同时出现,实例`HealthStatus`字段将返回 UNHEALTHY|CLB_UNHEALTHY。默认值:CLB |
void |
setInstanceAllocationPolicy(String InstanceAllocationPolicy)
Set 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED,默认取 LAUNCH_CONFIGURATION。
LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。 SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。 |
void |
setInstanceNameIndexSettings(InstanceNameIndexSettings InstanceNameIndexSettings)
Set 实例名称序号相关设置。若不指定该参数,则默认不开启。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。
|
void |
setIpv6AddressCount(Long Ipv6AddressCount)
Set 实例具有IPv6地址数量的配置,取值包括 0、1,默认值为0。
|
void |
setLaunchConfigurationId(String LaunchConfigurationId)
Set 启动配置ID
|
void |
setLoadBalancerHealthCheckGracePeriod(Long LoadBalancerHealthCheckGracePeriod)
Set CLB健康检查宽限期,当扩容的实例进入`IN_SERVICE`后,在宽限期时间范围内将不会被标记为不健康`CLB_UNHEALTHY`。
默认值:0。取值范围[0, 7200],单位:秒。 |
void |
setLoadBalancerIds(String[] LoadBalancerIds)
Set 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
|
void |
setMaxSize(Long MaxSize)
Set 最大实例数,取值范围为0-2000。
|
void |
setMinSize(Long MinSize)
Set 最小实例数,取值范围为0-2000。
|
void |
setMultiZoneSubnetPolicy(String MultiZoneSubnetPolicy)
Set 多可用区/子网策略,取值包括 PRIORITY 和 EQUALITY,默认为 PRIORITY。
PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。 EQUALITY:扩容出的实例会打散到多个可用区/子网,保证扩容后的各个可用区/子网实例数相对均衡。 与本策略相关的注意点: 当伸缩组为基础网络时,本策略适用于多可用区;当伸缩组为VPC网络时,本策略适用于多子网,此时不再考虑可用区因素,例如四个子网ABCD,其中ABC处于可用区1,D处于可用区2,此时考虑子网ABCD进行排序,而不考虑可用区1、2。 本策略适用于多可用区/子网,不适用于启动配置的多机型。多机型按照优先级策略进行选择。 按照 PRIORITY 策略创建实例时,先保证多机型的策略,后保证多可用区/子网的策略。例如多机型A、B,多子网1、2、3,会按照A1、A2、A3、B1、B2、B3 进行尝试,如果A1售罄,会尝试A2(而非B1)。 |
void |
setProjectId(Long ProjectId)
Set 伸缩组内实例所属项目ID。不填为默认项目。
|
void |
setRetryPolicy(String RetryPolicy)
Set 重试策略,取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY,默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。
IMMEDIATE_RETRY,立即重试,在较短时间内快速重试,连续失败超过一定次数(5次)后不再重试。 INCREMENTAL_INTERVALS,间隔递增重试,随着连续失败次数的增加,重试间隔逐渐增大,重试间隔从秒级到1天不等。 NO_RETRY,不进行重试,直到再次收到用户调用或者告警信息后才会重试。 |
void |
setServiceSettings(ServiceSettings ServiceSettings)
Set 服务设置,包括云监控不健康替换等服务设置。
|
void |
setSpotMixedAllocationPolicy(SpotMixedAllocationPolicy SpotMixedAllocationPolicy)
Set 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。
|
void |
setSubnetIds(String[] SubnetIds)
Set 子网ID列表,VPC场景下必须指定子网。多个子网以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。
|
void |
setTags(Tag[] Tags)
Set 标签描述列表。通过指定该参数可以支持绑定标签到伸缩组。同时绑定标签到相应的资源实例。每个伸缩组最多支持30个标签。
|
void |
setTerminationPolicies(String[] TerminationPolicies)
Set 销毁策略,目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE,默认取值为 OLDEST_INSTANCE。
OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。 NEWEST_INSTANCE,优先销毁伸缩组中最新的实例。 |
void |
setVpcId(String VpcId)
Set VPC ID,基础网络则填空字符串
|
void |
setZones(String[] Zones)
Set 可用区列表,基础网络场景下必须指定可用区。多个可用区以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。
|
void |
setZonesCheckPolicy(String ZonesCheckPolicy)
Set 可用区校验策略,取值包括 ALL 和 ANY,默认取值为ANY。
ALL,所有可用区(Zone)或子网(SubnetId)都可用则通过校验,否则校验报错。 ANY,存在任何一个可用区(Zone)或子网(SubnetId)可用则通过校验,否则校验报错。 可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。 如果 Zones/SubnetIds 中可用区或者子网不存在,则无论 ZonesCheckPolicy 采用何种取值,都会校验报错。 |
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public CreateAutoScalingGroupRequest()
public CreateAutoScalingGroupRequest(CreateAutoScalingGroupRequest source)
public String getAutoScalingGroupName()
public void setAutoScalingGroupName(String AutoScalingGroupName)
AutoScalingGroupName
- 伸缩组名称,在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超55个字节。public String getLaunchConfigurationId()
public void setLaunchConfigurationId(String LaunchConfigurationId)
LaunchConfigurationId
- 启动配置IDpublic Long getMaxSize()
public void setMaxSize(Long MaxSize)
MaxSize
- 最大实例数,取值范围为0-2000。public Long getMinSize()
public void setMinSize(Long MinSize)
MinSize
- 最小实例数,取值范围为0-2000。public String getVpcId()
public void setVpcId(String VpcId)
VpcId
- VPC ID,基础网络则填空字符串public Long getDefaultCooldown()
public void setDefaultCooldown(Long DefaultCooldown)
DefaultCooldown
- 默认冷却时间,单位秒,默认值为300public Long getDesiredCapacity()
public void setDesiredCapacity(Long DesiredCapacity)
DesiredCapacity
- 期望实例数,大小介于最小实例数和最大实例数之间public String[] getLoadBalancerIds()
public void setLoadBalancerIds(String[] LoadBalancerIds)
LoadBalancerIds
- 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个public Long getProjectId()
public void setProjectId(Long ProjectId)
ProjectId
- 伸缩组内实例所属项目ID。不填为默认项目。public ForwardLoadBalancer[] getForwardLoadBalancers()
public void setForwardLoadBalancers(ForwardLoadBalancer[] ForwardLoadBalancers)
ForwardLoadBalancers
- 应用型负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个public String[] getSubnetIds()
public void setSubnetIds(String[] SubnetIds)
SubnetIds
- 子网ID列表,VPC场景下必须指定子网。多个子网以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。public String[] getTerminationPolicies()
public void setTerminationPolicies(String[] TerminationPolicies)
TerminationPolicies
- 销毁策略,目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE,默认取值为 OLDEST_INSTANCE。
public String[] getZones()
public void setZones(String[] Zones)
Zones
- 可用区列表,基础网络场景下必须指定可用区。多个可用区以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。public String getRetryPolicy()
public void setRetryPolicy(String RetryPolicy)
RetryPolicy
- 重试策略,取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY,默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。
public String getZonesCheckPolicy()
public void setZonesCheckPolicy(String ZonesCheckPolicy)
ZonesCheckPolicy
- 可用区校验策略,取值包括 ALL 和 ANY,默认取值为ANY。
public Tag[] getTags()
public void setTags(Tag[] Tags)
Tags
- 标签描述列表。通过指定该参数可以支持绑定标签到伸缩组。同时绑定标签到相应的资源实例。每个伸缩组最多支持30个标签。public ServiceSettings getServiceSettings()
public void setServiceSettings(ServiceSettings ServiceSettings)
ServiceSettings
- 服务设置,包括云监控不健康替换等服务设置。public Long getIpv6AddressCount()
public void setIpv6AddressCount(Long Ipv6AddressCount)
Ipv6AddressCount
- 实例具有IPv6地址数量的配置,取值包括 0、1,默认值为0。public String getMultiZoneSubnetPolicy()
public void setMultiZoneSubnetPolicy(String MultiZoneSubnetPolicy)
MultiZoneSubnetPolicy
- 多可用区/子网策略,取值包括 PRIORITY 和 EQUALITY,默认为 PRIORITY。
public String getHealthCheckType()
public void setHealthCheckType(String HealthCheckType)
HealthCheckType
- 伸缩组实例健康检查类型,取值如下:public Long getLoadBalancerHealthCheckGracePeriod()
public void setLoadBalancerHealthCheckGracePeriod(Long LoadBalancerHealthCheckGracePeriod)
LoadBalancerHealthCheckGracePeriod
- CLB健康检查宽限期,当扩容的实例进入`IN_SERVICE`后,在宽限期时间范围内将不会被标记为不健康`CLB_UNHEALTHY`。public String getInstanceAllocationPolicy()
public void setInstanceAllocationPolicy(String InstanceAllocationPolicy)
InstanceAllocationPolicy
- 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED,默认取 LAUNCH_CONFIGURATION。
public SpotMixedAllocationPolicy getSpotMixedAllocationPolicy()
public void setSpotMixedAllocationPolicy(SpotMixedAllocationPolicy SpotMixedAllocationPolicy)
SpotMixedAllocationPolicy
- 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。public Boolean getCapacityRebalance()
public void setCapacityRebalance(Boolean CapacityRebalance)
CapacityRebalance
- 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
public InstanceNameIndexSettings getInstanceNameIndexSettings()
public void setInstanceNameIndexSettings(InstanceNameIndexSettings InstanceNameIndexSettings)
InstanceNameIndexSettings
- 实例名称序号相关设置。若不指定该参数,则默认不开启。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。Copyright © 2024. All rights reserved.