com.aliyun.ess20220222.models.DescribeScalingInstancesRequest Maven / Gradle / Ivy
Show all versions of ess20220222 Show documentation
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.ess20220222.models;
import com.aliyun.tea.*;
public class DescribeScalingInstancesRequest extends TeaModel {
/**
* The instance creation method. Valid values:
*
* - AutoCreated: The ECS instances are created by Auto Scaling based on the instance configuration source.
* - Attached: The ECS instances are manually added to the scaling group.
* - Managed: The Alibaba Cloud-managed third-party instances are manually added to the scaling group.
*
*
* example:
* AutoCreated
*/
@NameInMap("CreationType")
public String creationType;
/**
* The instance creation methods. If you specify this parameter, you cannot specify CreationType.
*/
@NameInMap("CreationTypes")
public java.util.List creationTypes;
/**
* The health status of the ECS instance in the scaling group. If an ECS instance is not in the Running state, the instance is considered unhealthy. Valid values:
*
* - Healthy
* - Unhealthy
*
* Auto Scaling automatically removes unhealthy ECS instances from the scaling group and then releases the automatically created instances among the unhealthy instances.
* Unhealthy ECS instances that are manually added to the scaling group are released based on the management mode of the lifecycles of the instances. If the lifecycles of the ECS instances are not managed by the scaling group, Auto Scaling removes the instances from the scaling group but does not release the instances. If the lifecycles of the ECS instances are managed by the scaling group, Auto Scaling removes the instances from the scaling group and releases the instances.
*
* Make sure that you have sufficient balance within your Alibaba Cloud account. If your Alibaba Cloud account has an overdue payment, all pay-as-you-go ECS instances, including preemptible instances, may be stopped or even released. For information about how the status of ECS instances changes when you have an overdue payment in your Alibaba Cloud account, see Overdue payments.
*
*
* example:
* Healthy
*/
@NameInMap("HealthStatus")
public String healthStatus;
/**
* The IDs of the ECS instances.
* The IDs of inactive instances are not displayed in the query result, and no errors are returned.
*/
@NameInMap("InstanceIds")
public java.util.List instanceIds;
/**
* The lifecycle status of the ECS instance in the scaling group. Valid values:
*
* - InService: The ECS instance is added to the scaling group and provides services as expected.
* - Pending: The ECS instance is being added to the scaling group. When an ECS instance is being added to the scaling group, Auto Scaling also adds the instance to the backend server groups of the attached load balancers and adds the private IP address of the instance to the IP address whitelists of the attached ApsaraDB RDS instances.
* - Pending:Wait: The ECS instance is waiting to be added to the scaling group. If a scale-out lifecycle hook is in effect, the ECS instance remains in the Pending:Wait state until the timeout period for the lifecycle hook expires.
* - Protected: The ECS instance is protected. Protected ECS instances can continue to provide services as expected, but Auto Scaling does not manage the lifecycles of the ECS instances. You must manually manage the lifecycles of the ECS instances.
* - Standby: The ECS instance is on standby. Standby ECS instances do not provide services as expected, and the weights of the ECS instances as backend servers are reset to zero. Auto Scaling does not manage the lifecycles of the ECS instances. Therefore, you must manually manage the lifecycles of the ECS instances.
* - Stopped: The ECS instance is stopped. Stopped ECS instances no longer provide services.
* - Removing: The ECS instance is being removed from the scaling group. When an ECS instance is being removed from the scaling group, Auto Scaling also removes the instance from the backend server groups of the attached load balancers and removes the private IP address of the instance from the IP address whitelists of the attached ApsaraDB RDS instances.
* - Removing:Wait: The ECS instance is waiting to be removed from the scaling group. If a scale-in lifecycle hook is in effect, the ECS instance remains in the Removing:Wait state until the timeout period for the lifecycle hook expires.
*
*
* example:
* InService
*/
@NameInMap("LifecycleState")
public String lifecycleState;
/**
* The lifecycle status of the ECS instances in the scaling group. You can specify only one of LifecycleStates and LifecycleState at a time. We recommend that you specify this parameter.
*/
@NameInMap("LifecycleStates")
public java.util.List lifecycleStates;
@NameInMap("OwnerAccount")
public String ownerAccount;
@NameInMap("OwnerId")
public Long ownerId;
/**
* The page number. Pages start from page 1.
* Default value: 1.
*
* example:
* 1
*/
@NameInMap("PageNumber")
public Integer pageNumber;
/**
* The number of entries per page. Maximum value: 100.
* Default value: 10.
*
* example:
* 10
*/
@NameInMap("PageSize")
public Integer pageSize;
/**
* The region ID of the scaling group.
* This parameter is required.
*
* example:
* cn-hangzhou
*/
@NameInMap("RegionId")
public String regionId;
@NameInMap("ResourceOwnerAccount")
public String resourceOwnerAccount;
@NameInMap("ResourceOwnerId")
public Long resourceOwnerId;
/**
* The ID of the scaling activity.
*
* example:
* asa-bp1c9djwrgxjyk31****
*/
@NameInMap("ScalingActivityId")
public String scalingActivityId;
/**
* The ID of the scaling configuration.
*
* example:
* asc-bp1i65jd06v04vdh****
*/
@NameInMap("ScalingConfigurationId")
public String scalingConfigurationId;
/**
* The ID of the scaling group.
*
* example:
* asg-bp1igpak5ft1flyp****
*/
@NameInMap("ScalingGroupId")
public String scalingGroupId;
public static DescribeScalingInstancesRequest build(java.util.Map map) throws Exception {
DescribeScalingInstancesRequest self = new DescribeScalingInstancesRequest();
return TeaModel.build(map, self);
}
public DescribeScalingInstancesRequest setCreationType(String creationType) {
this.creationType = creationType;
return this;
}
public String getCreationType() {
return this.creationType;
}
public DescribeScalingInstancesRequest setCreationTypes(java.util.List creationTypes) {
this.creationTypes = creationTypes;
return this;
}
public java.util.List getCreationTypes() {
return this.creationTypes;
}
public DescribeScalingInstancesRequest setHealthStatus(String healthStatus) {
this.healthStatus = healthStatus;
return this;
}
public String getHealthStatus() {
return this.healthStatus;
}
public DescribeScalingInstancesRequest setInstanceIds(java.util.List instanceIds) {
this.instanceIds = instanceIds;
return this;
}
public java.util.List getInstanceIds() {
return this.instanceIds;
}
public DescribeScalingInstancesRequest setLifecycleState(String lifecycleState) {
this.lifecycleState = lifecycleState;
return this;
}
public String getLifecycleState() {
return this.lifecycleState;
}
public DescribeScalingInstancesRequest setLifecycleStates(java.util.List lifecycleStates) {
this.lifecycleStates = lifecycleStates;
return this;
}
public java.util.List getLifecycleStates() {
return this.lifecycleStates;
}
public DescribeScalingInstancesRequest setOwnerAccount(String ownerAccount) {
this.ownerAccount = ownerAccount;
return this;
}
public String getOwnerAccount() {
return this.ownerAccount;
}
public DescribeScalingInstancesRequest setOwnerId(Long ownerId) {
this.ownerId = ownerId;
return this;
}
public Long getOwnerId() {
return this.ownerId;
}
public DescribeScalingInstancesRequest setPageNumber(Integer pageNumber) {
this.pageNumber = pageNumber;
return this;
}
public Integer getPageNumber() {
return this.pageNumber;
}
public DescribeScalingInstancesRequest setPageSize(Integer pageSize) {
this.pageSize = pageSize;
return this;
}
public Integer getPageSize() {
return this.pageSize;
}
public DescribeScalingInstancesRequest setRegionId(String regionId) {
this.regionId = regionId;
return this;
}
public String getRegionId() {
return this.regionId;
}
public DescribeScalingInstancesRequest setResourceOwnerAccount(String resourceOwnerAccount) {
this.resourceOwnerAccount = resourceOwnerAccount;
return this;
}
public String getResourceOwnerAccount() {
return this.resourceOwnerAccount;
}
public DescribeScalingInstancesRequest setResourceOwnerId(Long resourceOwnerId) {
this.resourceOwnerId = resourceOwnerId;
return this;
}
public Long getResourceOwnerId() {
return this.resourceOwnerId;
}
public DescribeScalingInstancesRequest setScalingActivityId(String scalingActivityId) {
this.scalingActivityId = scalingActivityId;
return this;
}
public String getScalingActivityId() {
return this.scalingActivityId;
}
public DescribeScalingInstancesRequest setScalingConfigurationId(String scalingConfigurationId) {
this.scalingConfigurationId = scalingConfigurationId;
return this;
}
public String getScalingConfigurationId() {
return this.scalingConfigurationId;
}
public DescribeScalingInstancesRequest setScalingGroupId(String scalingGroupId) {
this.scalingGroupId = scalingGroupId;
return this;
}
public String getScalingGroupId() {
return this.scalingGroupId;
}
}