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.
Operation description
-
If the scaling rule of a scheduled task fails to be executed due to an ongoing scaling activity in the scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the time window specified by
LaunchExpirationTime
. If the scheduled task still fails after the specified time window ends, the task is automatically skipped. -
If several scheduled tasks concurrently attempt to execute the same scaling rule within a scaling group, the following rules apply:
- Scaling groups with Expected Number of Instances configured: The scaling activities incurred by the scheduled tasks are parallel scaling activities. In a proximate time window, Auto Scaling can trigger several scheduled tasks and then execute multiple parallel scaling activities at the same time.
- Scaling groups with Expected Number of Instances not configured: The scaling activity incurred by the earliest scheduled task is executed. Considering that a scaling group allows for no more than one ongoing scaling activity simultaneously, other scheduled tasks will spontaneously invoke retries within the time window specified by
LaunchExpirationTime
. Upon completion of the first scheduled task, any retries invoked by other tasks within the time window specified byLaunchExpirationTime
lead to continuous enforcement of the scaling rule, with each iteration generating a distinct scaling activity.
-
You can use one of the following methods to specify the scaling mode:
- ScheduledAction: Specify an existing scaling rule that you want Auto Scaling to execute when the scheduled task is triggered.
- ScalingGroupId: Specify the minimum number, maximum number, or expected number of instances for the scaling group for which you create the scheduled task.
**
Note You cannot specify ScheduledAction and ScalingGroupId at the same time.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ess:CreateScheduledTask | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the scheduled task. | cn-qingdao |
ScheduledTaskName | string | No | The name of the scheduled task. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit. The name of the scheduled task must be unique in the region and within the Alibaba Cloud account. If you do not specify this parameter, the value of the | scheduled**** |
Description | string | No | The description of the scheduled task. The description must be 2 to 200 characters in length. | Test scheduled task. |
ScheduledAction | string | No | The scaling rule that you want to execute when the scheduled task is triggered. Specify the unique identifier of the scaling rule. If you specify | ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp12tcnol686y1ik**** |
RecurrenceEndTime | string | No | The end time of the scheduled task. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a point in time that is later than 365 days from the point in time at which the scheduled task is created. | 2014-08-17T16:55Z |
LaunchTime | string | No | The point in time at which the scheduled task is triggered. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a point in time that is later than 90 days from the point in time at which the scheduled task is created.
| 2014-08-17T16:52Z |
RecurrenceType | string | No | The interval at which the scheduled task is repeated. Valid values:
You must specify the | Daily |
RecurrenceValue | string | No | The number of recurrences of the scheduled task.
You must specify both the | 1 |
TaskEnabled | boolean | No | Specifies whether to enable the scheduled task.
Default value: true. | true |
LaunchExpirationTime | integer | No | The time period during which the failed scheduled task can be retried. Unit: seconds. Valid values: 0 to 1800. Default value: 600. | 600 |
MinValue | integer | No | The minimum number of instances in the scaling group if you specify the ScalingGroupId parameter. | 0 |
MaxValue | integer | No | The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter. | 10 |
DesiredCapacity | integer | No | The expected number of instances in the scaling group if you specify the ScalingGroupId parameter. Note
You must specify the DesiredCapacity parameter when you create a scaling group.
| 10 |
ScalingGroupId | string | No | The ID of the scaling group. If you specify this parameter, the number of instances in the scaling group will be changed when the scheduled task is triggered. If you specify | asg-bp18p2yfxow2dloq**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|