Package com.tencentcloudapi.as.v20180419.models

Class ModifyAutoScalingGroupRequest

  • public class ModifyAutoScalingGroupRequest
extends AbstractModel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getAutoScalingGroupId()
      Get 伸缩组ID
      String getAutoScalingGroupName()
      Get 伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超55个字节。
      Boolean getCapacityRebalance()
      Get 容量重平衡功能，仅对伸缩组内的竞价实例有效。取值范围：
      TRUE，开启该功能，当伸缩组内的竞价实例即将被竞价实例服务自动回收前，AS 主动发起竞价实例销毁流程，如果有配置过缩容 hook，则销毁前 hook 会生效。销毁流程启动后，AS 会异步开启一个扩容活动，用于补齐期望实例数。
      FALSE，不开启该功能，则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。
      Long getDefaultCooldown()
      Get 默认冷却时间，单位秒，默认值为300
      Long getDesiredCapacity()
      Get 期望实例数，大小介于最小实例数和最大实例数之间
      String getHealthCheckType()
      Get 伸缩组实例健康检查类型，取值如下：
      CVM：根据实例网络状态判断实例是否处于不健康状态，不健康的网络状态即发生实例 PING 不可达事件，详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)
      CLB：根据 CLB 的健康检查状态判断实例是否处于不健康状态，CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)
      String getInstanceAllocationPolicy()
      Get 实例分配策略，取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。
      LAUNCH_CONFIGURATION，代表传统的按照启动配置模式。
      SPOT_MIXED，代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式，混合模式下，伸缩组将根据设定扩容按量或竞价机型。使用混合模式时，关联的启动配置的计费类型不可被修改。
      Long getIpv6AddressCount()
      Get 实例具有IPv6地址数量的配置，取值包括0、1。
      String getLaunchConfigurationId()
      Get 启动配置ID
      Long getLoadBalancerHealthCheckGracePeriod()
      Get CLB健康检查宽限期。
      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列表
      String[] getTerminationPolicies()
      Get 销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。
      OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。
      NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。
      String getVpcId()
      Get VPC ID，基础网络则填空字符串。修改为具体VPC ID时，需指定相应的SubnetIds；修改为基础网络时，需指定相应的Zones。
      String[] getZones()
      Get 可用区列表
      String getZonesCheckPolicy()
      Get 可用区校验策略，取值包括 ALL 和 ANY，默认取值为ANY。在伸缩组实际变更资源相关字段时（启动配置、可用区、子网）发挥作用。
      ALL，所有可用区（Zone）或子网（SubnetId）都可用则通过校验，否则校验报错。
      ANY，存在任何一个可用区（Zone）或子网（SubnetId）可用则通过校验，否则校验报错。 可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。 如果 Zones/SubnetIds 中可用区或者子网不存在，则无论 ZonesCheckPolicy 采用何种取值，都会校验报错。
      void setAutoScalingGroupId​(String AutoScalingGroupId)
      Set 伸缩组ID
      void setAutoScalingGroupName​(String AutoScalingGroupName)
      Set 伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超55个字节。
      void setCapacityRebalance​(Boolean CapacityRebalance)
      Set 容量重平衡功能，仅对伸缩组内的竞价实例有效。取值范围：
      TRUE，开启该功能，当伸缩组内的竞价实例即将被竞价实例服务自动回收前，AS 主动发起竞价实例销毁流程，如果有配置过缩容 hook，则销毁前 hook 会生效。销毁流程启动后，AS 会异步开启一个扩容活动，用于补齐期望实例数。
      FALSE，不开启该功能，则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。
      void setDefaultCooldown​(Long DefaultCooldown)
      Set 默认冷却时间，单位秒，默认值为300
      void setDesiredCapacity​(Long DesiredCapacity)
      Set 期望实例数，大小介于最小实例数和最大实例数之间
      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)
      void setInstanceAllocationPolicy​(String InstanceAllocationPolicy)
      Set 实例分配策略，取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。
      LAUNCH_CONFIGURATION，代表传统的按照启动配置模式。
      SPOT_MIXED，代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式，混合模式下，伸缩组将根据设定扩容按量或竞价机型。使用混合模式时，关联的启动配置的计费类型不可被修改。
      void setIpv6AddressCount​(Long Ipv6AddressCount)
      Set 实例具有IPv6地址数量的配置，取值包括0、1。
      void setLaunchConfigurationId​(String LaunchConfigurationId)
      Set 启动配置ID
      void setLoadBalancerHealthCheckGracePeriod​(Long LoadBalancerHealthCheckGracePeriod)
      Set CLB健康检查宽限期。
      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列表
      void setTerminationPolicies​(String[] TerminationPolicies)
      Set 销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。
      OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。
      NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。
      void setVpcId​(String VpcId)
      Set VPC ID，基础网络则填空字符串。修改为具体VPC ID时，需指定相应的SubnetIds；修改为基础网络时，需指定相应的Zones。
      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.

    • Constructor Detail

      • ModifyAutoScalingGroupRequest

        public ModifyAutoScalingGroupRequest()

      • ModifyAutoScalingGroupRequest

        public ModifyAutoScalingGroupRequest​(ModifyAutoScalingGroupRequest 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.

    • Method Detail

      • getAutoScalingGroupId

        public String getAutoScalingGroupId()
        Get 伸缩组ID
        Returns:
        AutoScalingGroupId 伸缩组ID

      • setAutoScalingGroupId

        public void setAutoScalingGroupId​(String AutoScalingGroupId)
        Set 伸缩组ID
        Parameters:
        AutoScalingGroupId - 伸缩组ID

      • getAutoScalingGroupName

        public String getAutoScalingGroupName()
        Get 伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超55个字节。
        Returns:
        AutoScalingGroupName 伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超55个字节。

      • setAutoScalingGroupName

        public void setAutoScalingGroupName​(String AutoScalingGroupName)
        Set 伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超55个字节。
        Parameters:
        AutoScalingGroupName - 伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超55个字节。

      • getDefaultCooldown

        public Long getDefaultCooldown()
        Get 默认冷却时间，单位秒，默认值为300
        Returns:
        DefaultCooldown 默认冷却时间，单位秒，默认值为300

      • setDefaultCooldown

        public void setDefaultCooldown​(Long DefaultCooldown)
        Set 默认冷却时间，单位秒，默认值为300
        Parameters:
        DefaultCooldown - 默认冷却时间，单位秒，默认值为300

      • getDesiredCapacity

        public Long getDesiredCapacity()
        Get 期望实例数，大小介于最小实例数和最大实例数之间
        Returns:
        DesiredCapacity 期望实例数，大小介于最小实例数和最大实例数之间

      • setDesiredCapacity

        public void setDesiredCapacity​(Long DesiredCapacity)
        Set 期望实例数，大小介于最小实例数和最大实例数之间
        Parameters:
        DesiredCapacity - 期望实例数，大小介于最小实例数和最大实例数之间

      • getLaunchConfigurationId

        public String getLaunchConfigurationId()
        Get 启动配置ID
        Returns:
        LaunchConfigurationId 启动配置ID

      • setLaunchConfigurationId

        public void setLaunchConfigurationId​(String LaunchConfigurationId)
        Set 启动配置ID
        Parameters:
        LaunchConfigurationId - 启动配置ID

      • getMaxSize

        public Long getMaxSize()
        Get 最大实例数，取值范围为0-2000。
        Returns:
        MaxSize 最大实例数，取值范围为0-2000。

      • setMaxSize

        public void setMaxSize​(Long MaxSize)
        Set 最大实例数，取值范围为0-2000。
        Parameters:
        MaxSize - 最大实例数，取值范围为0-2000。

      • getMinSize

        public Long getMinSize()
        Get 最小实例数，取值范围为0-2000。
        Returns:
        MinSize 最小实例数，取值范围为0-2000。

      • setMinSize

        public void setMinSize​(Long MinSize)
        Set 最小实例数，取值范围为0-2000。
        Parameters:
        MinSize - 最小实例数，取值范围为0-2000。

      • getProjectId

        public Long getProjectId()
        Get 项目ID
        Returns:
        ProjectId 项目ID

      • setProjectId

        public void setProjectId​(Long ProjectId)
        Set 项目ID
        Parameters:
        ProjectId - 项目ID

      • getSubnetIds

        public String[] getSubnetIds()
        Get 子网ID列表
        Returns:
        SubnetIds 子网ID列表

      • setSubnetIds

        public void setSubnetIds​(String[] SubnetIds)
        Set 子网ID列表
        Parameters:
        SubnetIds - 子网ID列表

      • getTerminationPolicies

        public String[] getTerminationPolicies()
        Get 销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。
      • OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。
      • NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。
Returns:
TerminationPolicies 销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。
  • OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。
  • NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。
    • Parameters:
    TerminationPolicies - 销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。
  • OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。
  • NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。