All Products
Search
Document Center

Auto Scaling:List of operations by function

Last Updated:May 29, 2024
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

APITitleDescription
CreateScalingGroupCreateScalingGroupCreates a scaling group.
ModifyScalingGroupModifyScalingGroupModifies a scaling group.
EnableScalingGroupEnableScalingGroupEnables a scaling group.
DisableScalingGroupDisableScalingGroupDisables a scaling group.
SetGroupDeletionProtectionSetGroupDeletionProtectionSets 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.
DeleteScalingGroupDeleteScalingGroupDeletes a scaling group. If you want to enable policy-based automatic addition or removal of instances of a specific type to meet evolving business requirements, you can create scaling groups to manage your computing power with ease. The computing power refers to the instances that provide the computing capability. If you no longer require a scaling group, you can call the DeleteScalingGroup operation to delete it to free up the scaling group quota.
DescribeScalingGroupsDescribeScalingGroupsQueries scaling groups. If you want to query the basic information, instances, and scaling configurations of a scaling group, you can call the DescribeScalingGroups operation.
DescribeScalingGroupDetailDescribeScalingGroupDetailQueries 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.
DescribeScalingInstancesDescribeScalingInstancesQueries the Elastic Compute Service (ECS) instances in a scaling group
DescribeScalingActivitiesDescribeScalingActivitiesQueries scaling activities.
DescribeScalingActivityDetailDescribeScalingActivityDetailQueries the details about a scaling activity.
AttachLoadBalancersAttachLoadBalancersAttaches 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.
DetachLoadBalancersDetachLoadBalancersDetaches one or more Classic Load Balancer (CLB) instances from a scaling group.
AttachDBInstancesAttachDBInstancesAssociates one or more ApsaraDB RDS instances with a scaling group.
DetachDBInstancesDetachDBInstancesDisassociates one or more ApsaraDB RDS instances from a scaling group.
SuspendProcessesSuspendProcessesSuspends 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.
ResumeProcessesResumeProcessesResumes suspended processes in a scaling group.
AttachVServerGroupsAttachVServerGroupsAttaches vServer groups to a scaling group. After a Classic Load Balancer (CLB) instance is attached to your scaling group, the instances in the scaling group are automatically added as backend servers of the CLB instance. These servers then handle requests forwarded by the CLB instance, streamlining the processing of incoming traffic. To direct varying access requests to separate backend servers or to distribute requests based on domain names or URLs, you can call the AttachVServerGroups operation. This operation enables the addition of multiple vServer groups, allowing for efficient management of various backend server configurations tailored to your routing preferences.
DetachVServerGroupsDetachVServerGroupsDetaches 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.
AttachAlbServerGroupsAttachAlbServerGroupsAssociates Application Load Balancer (ALB) server groups with a scaling group.
DetachAlbServerGroupsDetachAlbServerGroupsDisassociates one or more Application Load Balancer (ALB) server groups from a scaling group.
AttachServerGroupsAttachServerGroupsAttaches 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.
DetachServerGroupsDetachServerGroupsDetaches 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.
ChangeResourceGroupChangeResourceGroupChanges a resource group. Resource groups are a means to categorize and manage cloud resources, such as scaling groups, based on specific objectives, permissions, or ownership. In large, multifaceted organizations that manage numerous projects and users, this feature adopts a tiered management approach, simplifying management tasks and improving the effectiveness and oversight of resource allocation. You can call the ChangeResourceGroup operation to move your scaling groups from one resource group to another resource group, which facilitates streamlined monitoring and management within the context of the new group. This operation eliminates the need for repetitive and time-consuming cross-service resource queries, thereby enhancing operational efficiency.
ApplyScalingGroupApplyScalingGroupCreates and manages scaling groups with ease by using configuration files.

Scaling configurations

APITitleDescription
CreateScalingConfigurationCreateScalingConfigurationCreates a scaling configuration.
DescribeScalingConfigurationsDescribeScalingConfigurationsQueries scaling configurations.
ModifyScalingConfigurationModifyScalingConfigurationModifies scaling configurations of the Elastic Compute Service (ECS) type. A scaling configuration is a template based on which ECS instances are scaled out. If your scaling configuration does not meet your business requirements, you can call the ModifyScalingConfiguration operation to modify your scaling configuration.
DeleteScalingConfigurationDeleteScalingConfigurationDeletes a scaling configuration that is used to create Elastic Compute Service (ECS) instances.
CreateEciScalingConfigurationCreateEciScalingConfigurationCreates 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.
DescribeEciScalingConfigurationsDescribeEciScalingConfigurationsQueries 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.
DescribeEciScalingConfigurationDetailDescribeEciScalingConfigurationDetailQueries 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.
ModifyEciScalingConfigurationModifyEciScalingConfigurationModifies a scaling configuration for a scaling group that contains elastic container instances.
ApplyEciScalingConfigurationApplyEciScalingConfigurationManages 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.
DeleteEciScalingConfigurationDeleteEciScalingConfigurationDeletes 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

APITitleDescription
CreateScalingRuleCreateScalingRuleCreates a scaling rule.
ModifyScalingRuleModifyScalingRuleModifies a scaling rule.
DescribeScalingRulesDescribeScalingRulesQueries all scaling rules in a scaling group.
DeleteScalingRuleDeleteScalingRuleDeletes a scaling rule.

Scaling tasks

APITitleDescription
ExecuteScalingRuleExecuteScalingRuleExecutes a scaling rule.
ScaleWithAdjustmentScaleWithAdjustmentScales instances. The ScaleWithAdjustment operation differs from the ExecuteScalingRule operation in that ScaleWithAdjust can directly scale instances without requiring you to create a scaling rule in advance.
AttachInstancesAttachInstancesAdds 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.
RemoveInstancesRemoveInstances
DetachInstancesDetachInstancesRemoves one or more Elastic Compute Service (ECS) instances or elastic container instances from a scaling group.

Scheduled tasks

APITitleDescription
CreateScheduledTaskCreateScheduledTaskCreates 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.
ModifyScheduledTaskModifyScheduledTaskModifies a scheduled task.
DescribeScheduledTasksDescribeScheduledTasksQueries scheduled tasks.
DeleteScheduledTaskDeleteScheduledTaskDeletes scheduled tasks. For workloads with predictable patterns, you can create scheduled tasks to align with your business requirements and optimize resource utilization for cost savings. These tasks automatically ensure that sufficient computing resources are provisioned in anticipation of peak hours and efficiently release unused resources during off-peak hours, thereby streamlining operational efficiency and reducing expenses. If you no longer require a scheduled task, you can call the DeleteScheduledTask operation to delete it.

Event-triggered tasks

APITitleDescription
CreateAlarmCreateAlarmCreates an event-triggered task.
DescribeAlarmsDescribeAlarmsQueries event-triggered tasks.
ModifyAlarmModifyAlarmModifies an event-triggered task.
EnableAlarmEnableAlarmEnables 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.
DisableAlarmDisableAlarmDisables 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.
DeleteAlarmDeleteAlarmDeletes 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 no longer need an event-triggered task, you can call the DeleteAlarm operation to delete it.

Lifecycle hooks

APITitleDescription
CreateLifecycleHookCreateLifecycleHookCreates one or more lifecycle hooks.
ModifyLifecycleHookModifyLifecycleHookModifies a lifecycle hook.
DescribeLifecycleHooksDescribeLifecycleHooksQueries lifecycle hooks.
RecordLifecycleActionHeartbeatRecordLifecycleActionHeartbeatProlongs a lifecycle hook for Elastic Compute Service (ECS) instances.
DescribeLifecycleActionsDescribeLifecycleActionsQueries lifecycle actions.
CompleteLifecycleActionCompleteLifecycleActionEnds 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.
DeleteLifecycleHookDeleteLifecycleHookDeletes a lifecycle hook.

Event notifications

APITitleDescription
CreateNotificationConfigurationCreateNotificationConfigurationCreates 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.
ModifyNotificationConfigurationModifyNotificationConfigurationModifies a notification.
DescribeNotificationConfigurationsDescribeNotificationConfigurationsQueries event notifications.
DeleteNotificationConfigurationDeleteNotificationConfigurationDeletes event notification rules. The event notification feature facilitates efficient issue identification and event management by automatically forwarding notifications from Auto Scaling to designated endpoints such as CloudMonitor or Message Service (MNS) topics and queues. If you no longer require an event notification rule, you can call the DeleteNotificationConfiguration operation to delete it.
DescribeNotificationTypesDescribeNotificationTypesQueries notification types.

Instances

APITitleDescription
EnterStandbyEnterStandbyPuts an Elastic Compute Service (ECS) instance into the Standby state.
ExitStandbyExitStandbyMoves an Elastic Compute Service (ECS) instance out of the Standby state.
RebalanceInstancesRebalanceInstancesRebalances 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.
SetInstanceHealthSetInstanceHealthSets 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.
SetInstancesProtectionSetInstancesProtectionPuts 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

APITitleDescription
DescribeRegionsDescribeRegionsQueries 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.

Tags

APITitleDescription
TagResourcesTagResourcesCreates and attaches tags. You can call the TagResources operation to uniformly create and attach tags to your Auto Scaling resources, streamlining resource management. This capability empowers you to categorize resources based on tags, thereby enhancing the overall efficiency of resource allocation and utilization.
ListTagResourcesListTagResourcesQueries tags. You can call the ListTagResources operation to query tags that are added to Auto Scaling resources, thereby clarifying resource utilization and facilitating efficient management. This operation aids in the automation of resource categorization and permission management processes.
UntagResourcesUntagResourcesRemoves 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.
ListTagKeysListTagKeysQueries 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.
ListTagValuesListTagValuesQueries 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

APITitleDescription
VerifyUserVerifyUserVerifies 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.
VerifyAuthenticationVerifyAuthenticationChecks whether Auto Scaling is authorized to access Elastic Compute Service (ECS) and Elastic Container Instance resources.
DescribeLimitationDescribeLimitationQueries 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.
ModifyInstanceAttributeModifyInstanceAttributeModifies 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.