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 | Enables or disables deletion protection for a scaling group. |
DeleteScalingGroup | DeleteScalingGroup | Deletes a scaling group. |
DescribeScalingGroups | DescribeScalingGroups | Queries scaling groups. You can call the DescribeScalingGroups operation to query the basic information about, number of instances in, and scaling configuration of your scaling group. |
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 processes in a scaling group. |
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 one or more vServer groups of a Classic Load Balancer (CLB) instance from a 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. |
Scaling configurations
API | Title | Description |
---|---|---|
CreateScalingConfiguration | CreateScalingConfiguration | Creates a scaling configuration. |
DescribeScalingConfigurations | DescribeScalingConfigurations | Queries scaling configurations of the Elastic Compute Service (ECS) type. You can call this operation to learn about the details of scaling configurations that are used as templates to scale out ECS instances. |
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. |
ModifyEciScalingConfiguration | ModifyEciScalingConfiguration | Modifies a scaling configuration for a scaling group that contains elastic container instances. |
DeleteEciScalingConfiguration | DeleteEciScalingConfiguration | Deletes a scaling configuration that is used to create elastic container instances. |
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. |
DisableAlarm | DisableAlarm | Disables an event-triggered task. |
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 a lifecycle hook ahead of schedule. |
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 | Configures the health check feature for Elastic Compute Service (ECS) instances. |
SetInstancesProtection | SetInstancesProtection | Puts one or more Elastic Compute Service (ECS) instances into the Protected state. |
Regions
API | Title | Description |
---|---|---|
DescribeRegions | DescribeRegions | Queries the regions in which Auto Scaling is available. |
Tags
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 the specified Auto Scaling resources. If you remove a tag and the tag is not added to other resources, the tag is automatically deleted. |
ListTagKeys | ListTagKeys | Queries tag keys. |
ListTagValues | ListTagValues | Queries tag values. |