Creates a scheduled task.
Operation description
Operation description
After a scheduled node fails to trigger a scaling rule due to reasons such as an ongoing scaling activity in the scaling group or the scaling group being disabled, the scheduled node automatically retries the trigger within the LaunchExpirationTime period. Otherwise, the trigger for the scheduled node is abandoned.
- If multiple scheduled nodes trigger scaling rules of the same scaling group at approximately the same time, the details of the triggered scaling activities are as follows:
Scaling groups with settings for the expected number of instances: The scaling activities triggered by multiple scheduled nodes are classified as parallel scaling activities. For example, if multiple scheduled nodes are executed at approximately the same time, the scaling group can trigger multiple parallel scaling activities simultaneously.
Scaling groups without settings for the expected number of instances: The earliest triggered scheduled node executes the scaling activity first. Because a scaling group can have only one scaling activity at a time, subsequent scheduled nodes automatically retry the scheduled trigger within the LaunchExpirationTime period. If a subsequent scheduled node is still retrying within the LaunchExpirationTime period after the previous scaling activity is completed, the scaling rule of the scheduled node is executed and the corresponding scaling activity is triggered.
- Scheduled nodes support the following two scaling methods:
Use the ScheduledAction parameter to configure settings for the scaling rule to be executed.
Use the ScalingGroupId parameter to configure settings for the number of instances in the scaling group.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ess:CreateScheduledTask |
create |
*ScalingGroup
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The ID of the region to which the scheduled task belongs. |
cn-qingdao |
| ScheduledTaskName |
string |
No |
The name of the scheduled task. The name must be 2 to 64 characters in length. It must start with a letter or digit and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must be unique within the same region and Alibaba Cloud account. Default value: the value of ScheduledTaskId. |
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 unique identifier of the scaling rule to be executed when the scheduled task is triggered. After you specify this parameter, the scaling method of the scheduled task is set to selecting an existing scaling rule. Note
You cannot specify both ScheduledAction and ScalingGroupId at the same time. |
ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp12tcnol686y1ik**** |
| RecurrenceEndTime |
string |
No |
The end time of the scheduled task that is executed repeatedly. Specify the time in the ISO 8601 standard in the |
2014-08-17T16:55Z |
| LaunchTime |
string |
No |
The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard in the
|
2014-08-17T16:52Z |
| RecurrenceType |
string |
No |
The recurrence type of the scheduled task. Valid values:
You must specify both RecurrenceType and RecurrenceValue. |
Daily |
| RecurrenceValue |
string |
No |
The recurrence value of the scheduled task.
You must specify both RecurrenceType and RecurrenceValue. |
1 |
| TaskEnabled |
boolean |
No |
Specifies whether to start the scheduled task. Valid values:
Default value: true. |
true |
| LaunchExpirationTime |
integer |
No |
The retry period after the scheduled task fails to be triggered. Unit: seconds. Valid values: 0 to 1800. Default value: 600. |
600 |
| MinValue |
integer |
No |
The minimum number of instances in the scaling group when the scaling method of the scheduled task is set to specifying the number of instances in the scaling group. |
0 |
| MaxValue |
integer |
No |
The maximum number of instances in the scaling group when the scaling method of the scheduled task is set to specifying the number of instances in the scaling group. |
10 |
| DesiredCapacity |
integer |
No |
The expected number of instances in the scaling group when the scaling method of the scheduled task is set to specifying the number of instances in the scaling group. Note
The scaling group must support configuring the expected number of instances. This means that DesiredCapacity must be specified when the scaling group is created. |
10 |
| ScalingGroupId |
string |
No |
The ID of the scaling group for which you want to modify the number of instances when the scheduled task is triggered. After you specify this parameter, the scaling method of the scheduled task is set to specifying the number of instances in the scaling group. You must specify a value for at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. Note
You cannot specify both ScheduledAction and ScalingGroupId at the same time. |
asg-bp18p2yfxow2dloq**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| ScheduledTaskId |
string |
The ID of the scheduled task. The ID is generated by the system and is globally unique. |
edRtShc57WGXdt8TlPbr**** |
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
Examples
Success response
JSON format
{
"ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.