List of operations by function - Auto Scaling - Alibaba Cloud Documentation Center

This product(Ess/2022-02-22) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Scaling groups

API	Title	Description
CreateScalingGroup	CreateScalingGroup	Creates a scaling group.
ModifyScalingGroup	ModifyScalingGroup	Modifies a scaling group.
EnableScalingGroup	EnableScalingGroup	Enables a scaling group.
DisableScalingGroup	DisableScalingGroup	Disables a scaling group.
SetGroupDeletionProtection	SetGroupDeletionProtection	Sets deletion protection for a scaling group. If you enable deletion protection for a scaling group, you cannot delete the scaling group. If you disable deletion protection for a scaling group, you can directly delete the scaling group. You can call the SetGroupDeletionProtection operation to enable or disable deletion protection.
DeleteScalingGroup	DeleteScalingGroup	Deletes a scaling group.
DescribeScalingGroups	DescribeScalingGroups	Queries scaling groups. If you want to query the basic information, instances, and scaling configurations of a scaling group, you can call the DescribeScalingGroups operation.
DescribeScalingGroupDetail	DescribeScalingGroupDetail	Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to yaml, a Kubernetes Deployment file that is in the YAML format is returned.
DescribeScalingInstances	DescribeScalingInstances	Queries the Elastic Compute Service (ECS) instances in a scaling group
DescribeScalingActivities	DescribeScalingActivities	Queries scaling activities.
DescribeScalingActivityDetail	DescribeScalingActivityDetail	Queries the details about a scaling activity.
AttachLoadBalancers	AttachLoadBalancers	Attaches load balancers to a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups. Load balancers help distribute the access traffic to the instances in scaling groups, which effectively improves the service performance of the scaling groups. You can call the AttachLoadBalancers operation to attach one or more load balancers to your scaling group.
DetachLoadBalancers	DetachLoadBalancers	Detaches one or more Classic Load Balancer (CLB) instances from a scaling group.
AttachDBInstances	AttachDBInstances	Associates one or more ApsaraDB RDS instances with a scaling group.
DetachDBInstances	DetachDBInstances	Disassociates one or more ApsaraDB RDS instances from a scaling group.
SuspendProcesses	SuspendProcesses	Suspends scaling processes. This operation empowers you to selectively pause distinct scaling processes within a particular scaling group, enabling you to carry out alternative tasks and achieve more granular management over your scaling operations.
ResumeProcesses	ResumeProcesses	Resumes suspended processes in a scaling group.
AttachVServerGroups	AttachVServerGroups	Associates Sever Load Balancer (SLB) vServer groups with a scaling group.
DetachVServerGroups	DetachVServerGroups	Detaches vServer groups from a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups to improve service performance. If the load balancer currently attached to your scaling group is no longer needed to distribute the access traffic to the instances in your scaling group, you can call the DetachVServerGroups operation to detach one or more vServer groups of this load balancer from the scaling group.
AttachAlbServerGroups	AttachAlbServerGroups	Associates Application Load Balancer (ALB) server groups with a scaling group.
DetachAlbServerGroups	DetachAlbServerGroups	Disassociates one or more Application Load Balancer (ALB) server groups from a scaling group.
AttachServerGroups	AttachServerGroups	Attaches one or more server groups to a scaling group. You can attach the following server groups to a scaling group: Application Load Balancer (ALB) and Network Load Balancer (NLB) server groups.
DetachServerGroups	DetachServerGroups	Detaches one or more server groups from a scaling group. You can attach and detach the following server groups from a scaling group: Application Load Balancer (ALB) and Network Load Balancer (NLB) server groups.
ChangeResourceGroup	ChangeResourceGroup	Adds a scaling group to a resource group.
ApplyScalingGroup	ApplyScalingGroup	Creates and manages scaling groups with ease by using configuration files.

Scaling configurations

API	Title	Description
CreateScalingConfiguration	CreateScalingConfiguration	Creates a scaling configuration.
DescribeScalingConfigurations	DescribeScalingConfigurations	Queries scaling configurations.
ModifyScalingConfiguration	ModifyScalingConfiguration	Modifies a scaling configuration.
DeleteScalingConfiguration	DeleteScalingConfiguration	Deletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
CreateEciScalingConfiguration	CreateEciScalingConfiguration	Creates a scaling configuration of the Elastic Container Instance type. Auto Scaling uses the scaling configuration as a template to create elastic container instances to meet your business requirements during scale-outs.
DescribeEciScalingConfigurations	DescribeEciScalingConfigurations	Queries scaling configurations of the Elastic Container Instance type to learn the scaling configuration details. This allows you to select an appropriate template when you create elastic container instances.
DescribeEciScalingConfigurationDetail	DescribeEciScalingConfigurationDetail	Queries scaling configurations of the Elastic Container Instance type to learn the scaling configuration details. This allows you to select an appropriate template when you create elastic container instances. If you set OutputFormat to yaml, the output is a Kubernetes Deployment file in the YAML format.
ModifyEciScalingConfiguration	ModifyEciScalingConfiguration	Modifies a scaling configuration for a scaling group that contains elastic container instances.
ApplyEciScalingConfiguration	ApplyEciScalingConfiguration	Manages scaling configurations of the Elastic Container Instance type. If you want to efficiently create or update a scaling configuration of the Elastic Container Instance type by using a configuration file, you can call the ApplyEciScalingConfiguration operation.
DeleteEciScalingConfiguration	DeleteEciScalingConfiguration	Deletes a scaling configuration of the Elastic Container Instance type. If the scaling configuration of a scaling group is in the Inactive state and the scaling group contains no elastic container instances created from the scaling configuration, you can call the DeleteEciScalingConfiguration operation to delete the scaling configuration to free up the scaling configuration quota.

Scaling rules

API	Title	Description
CreateScalingRule	CreateScalingRule	Creates a scaling rule.
ModifyScalingRule	ModifyScalingRule	Modifies a scaling rule.
DescribeScalingRules	DescribeScalingRules	Queries all scaling rules in a scaling group.
DeleteScalingRule	DeleteScalingRule	Deletes a scaling rule.

Scaling tasks

API	Title	Description
ExecuteScalingRule	ExecuteScalingRule	Executes a scaling rule.
ScaleWithAdjustment	ScaleWithAdjustment	Scales instances in a scaling group based on the specified scaling policy.
AttachInstances	AttachInstances	Adds instances to a scaling group. You can call the AttachInstances operation to add independent Elastic Compute Service (ECS) instances, elastic container instances, or non-Alibaba Cloud instances to your scaling group to provide services. You can also call this operation to change the state of ECS instances in your scaling group from Economical Mode to In Service.
RemoveInstances	RemoveInstances	Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.
DetachInstances	DetachInstances	Removes one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.

Scheduled tasks

API	Title	Description
CreateScheduledTask	CreateScheduledTask	Creates a scheduled task. A scheduled task is a type of scaling task that enables automatic execution of a specific scaling rule at a specified point in time. You can call the CreateScheduledTask operation to create a scheduled task to implement automatic scaling of computing resources. This ensures your business continuity and minimizes resource costs.
ModifyScheduledTask	ModifyScheduledTask	Modifies a scheduled task.
DescribeScheduledTasks	DescribeScheduledTasks	Queries scheduled tasks.
DeleteScheduledTask	DeleteScheduledTask	Deletes a scheduled task.

Event-triggered tasks

API	Title	Description
CreateAlarm	CreateAlarm	Creates an event-triggered task.
DescribeAlarms	DescribeAlarms	Queries event-triggered tasks.
ModifyAlarm	ModifyAlarm	Modifies an event-triggered task.
EnableAlarm	EnableAlarm	Enables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you want to reuse an event-triggered task that is in the Disabled state, you can call the EnableAlarm operation to enable it.
DisableAlarm	DisableAlarm	Disables an event-triggered task. If your business pattern is unpredictable or prone to unforeseen traffic spikes, you can create event-triggered tasks by associating CloudMonitor metrics to effectively monitor fluctuations in your business workload. Upon detecting that the criteria for alerts, as specified in event-triggered tasks, are fulfilled, Auto Scaling promptly issues alerts and executes the scaling rules predefined within those tasks. This process occurs within the predefined effective time windows of the tasks, thereby facilitating the automatic increase or decrease of Elastic Compute Service (ECS) instances or elastic container instances within your scaling groups. Ultimately, this mechanism ensures the dynamic optimization of resources based on real-time workload demands. If you currently do not need an event-triggered task, you can call the DisableAlarm operation to disable it.
DeleteAlarm	DeleteAlarm	Deletes an event-triggered task.

Lifecycle hooks

API	Title	Description
CreateLifecycleHook	CreateLifecycleHook	Creates one or more lifecycle hooks.
ModifyLifecycleHook	ModifyLifecycleHook	Modifies a lifecycle hook.
DescribeLifecycleHooks	DescribeLifecycleHooks	Queries lifecycle hooks.
RecordLifecycleActionHeartbeat	RecordLifecycleActionHeartbeat	Prolongs a lifecycle hook for Elastic Compute Service (ECS) instances.
DescribeLifecycleActions	DescribeLifecycleActions	Queries lifecycle actions.
CompleteLifecycleAction	CompleteLifecycleAction	Ends the timeout period of a lifecycle hook ahead of schedule. If you have created a lifecycle hook for your scaling group, you can call the CompleteLifecycleAction operation to end the timeout period of the lifecycle hook ahead of schedule based on your business requirements.
DeleteLifecycleHook	DeleteLifecycleHook	Deletes a lifecycle hook.

Event notifications

API	Title	Description
CreateNotificationConfiguration	CreateNotificationConfiguration	Creates a notification rule. You can call the CreateNotificationConfiguration operation to create a notification rule to stay informed about scaling events or resource changes. This helps you learn about the dynamic status of your scaling group in real time and further automates the management of scaling events.
ModifyNotificationConfiguration	ModifyNotificationConfiguration	Modifies a notification.
DescribeNotificationConfigurations	DescribeNotificationConfigurations	Queries event notifications.
DeleteNotificationConfiguration	DeleteNotificationConfiguration	Deletes a notification.
DescribeNotificationTypes	DescribeNotificationTypes	Queries notification types.

Instances

API	Title	Description
EnterStandby	EnterStandby	Puts an Elastic Compute Service (ECS) instance into the Standby state.
ExitStandby	ExitStandby	Moves an Elastic Compute Service (ECS) instance out of the Standby state.
RebalanceInstances	RebalanceInstances	Rebalances the distribution of Elastic Compute Service (ECS) instances across zones. If ECS instances are unevenly distributed across multiple zones, you can call the RebalanceInstances operation to rebalance the distribution of the ECS instances across the zones.
SetInstanceHealth	SetInstanceHealth	Sets instance health. At times, the automatic health check system might not sufficiently determine the precise health status of your Elastic Compute Service (ECS) instances or elastic container instances. To overcome this, you can call the SetInstanceHealth operation to swiftly pinpoint problematic instances and resolve issues. This operation is designed to more precisely align with real-world business requirements and tackle O\\\&M hurdles efficiently.
SetInstancesProtection	SetInstancesProtection	Puts Elastic Compute Service (ECS) instances into the Protected state. When ECS instances are put into the Protected state, they become immune to manual deletion attempts by using the Auto Scaling console or API operations. This operation serves as a robust safeguard, efficiently preventing any inadvertent instance release that could lead to irreversible consequences.

Regions

API	Title	Description
DescribeRegions	DescribeRegions	Queries regions. Before you activate Auto Scaling, you can call the DescribeRegions operation to query the regions where Auto Scaling is officially launched. This preliminary step facilitates the strategic selection of both the optimal region and availability zones for activating Auto Scaling, thereby guaranteeing the finest access speeds and operational efficiency within your chosen geographical area.

API	Title	Description
TagResources	TagResources	Adds tags to specified Auto Scaling resources.
ListTagResources	ListTagResources	Queries tags that are added to one or more Auto Scaling resources.
UntagResources	UntagResources	Removes tags from Auto Scaling resources simultaneously. This operation streamlines resource management activities, enhances system efficiency, and mitigates potential security vulnerabilities. Once a tag is removed from a particular resource, and if it is not re-added to any other resource, the system will automatically delete the unused tag.
ListTagKeys	ListTagKeys	Queries the tag keys added to Auto Scaling resources. Querying tag keys facilitates easier classification, identification, and monitoring of your Auto Scaling resources, thereby enhancing the flexibility and convenience of your resource management processes.
ListTagValues	ListTagValues	Queries the tag keys associated with Auto Scaling resources to facilitate a deeper comprehension of those resources. By doing so, you can categorize and manage your Auto Scaling resources more efficiently.

Other

API	Title	Description
VerifyUser	VerifyUser	Verifies whether Auto Scaling is activated. This operation guarantees that in response to shifts in business workloads or variations in incoming traffic, the system will automatically adjust resource provisioning. This auto-scaling capability enhances the overall system performance, ensuring high availability and improved flexibility to accommodate dynamic demands.
VerifyAuthentication	VerifyAuthentication	Checks whether Auto Scaling is authorized to access Elastic Compute Service (ECS) and Elastic Container Instance resources.
DescribeLimitation	DescribeLimitation	Queries resource quotas. You can call the DescribeLimitation operation to query the upper limits on resources such as scheduled tasks that can be created in a scaling group, load balancers that can be attached to a scaling group, instances that can be contained in a scaling group, and scaling configurations that can be created in a scaling group.
ModifyInstanceAttribute	ModifyInstanceAttribute	Modifies the attributes of an Elastic Compute Service (ECS) instance in a scaling group. You can call the ModifyInstanceAttribute operation to modify the lifecycle management attribute of a manually added ECS instance in a scaling group.

Auto Scaling:List of operations by function