All Products
Search
Document Center

Auto Scaling:CreateScheduledTask

Last Updated:Jun 06, 2024

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 a scheduled task fails to trigger a scaling activity due to an ongoing scaling activity in a scaling group or because the scaling group is disabled, the scheduled task is automatically retried during the period that is specified by the LaunchExpirationTime parameter. If the scheduled task still fails to trigger a scaling activity after the period ends, the task is automatically skipped.

  • If multiple tasks are scheduled at similar points in time to trigger scaling activities in the same scaling group, the earliest task triggers the scaling activity first. Other tasks trigger scaling activities within their launch expiration time. Only one scaling activity can be triggered in a scaling group at a time. If the previous scaling activity is complete and another scheduled task attempts to trigger a scaling activity, Auto Scaling executes the scaling rule that is specified in the scheduled task and then triggers a scaling activity.

  • A scheduled task supports the following scaling methods:

    • 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 created the scheduled task.
Note You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the scheduled task.

cn-qingdao
ScheduledTaskNamestringNo

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 ScheduledTaskId parameter is used.

scheduled****
DescriptionstringNo

The description of the scheduled task. The description must be 2 to 200 characters in length.

Test scheduled task.
ScheduledActionstringNo

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 the ScheduledAction parameter, you must select an existing scaling rule for the scheduled task.

Note You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.
ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp12tcnol686y1ik****
RecurrenceEndTimestringNo

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
LaunchTimestringNo

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.

  • If you specify the RecurrenceType parameter, the scheduled task is repeatedly executed at the point in time that is specified by the LaunchTime parameter.
  • If you do not specify the RecurrenceType parameter, the task is executed only once at the point in time that is specified by the LaunchTime parameter.
2014-08-17T16:52Z
RecurrenceTypestringNo

The interval at which the scheduled task is repeated. Valid values:

  • Daily: The scheduled task is executed once every specified number of days.
  • Weekly: The scheduled task is executed on each specified day of the week.
  • Monthly: The scheduled task is executed on each specified day of the month.
  • Cron: The scheduled task is executed based on the specified cron expression.

You must specify the RecurrenceType and RecurrenceValue parameters at the same time.

Daily
RecurrenceValuestringNo

The number of recurrences of the scheduled task.

  • If you set the RecurrenceType parameter to Daily, you can specify only one value for this parameter. Valid values: 1 to 31.
  • If you set the RecurrenceType parameter to Weekly, you can specify multiple values for this parameter. Separate the values with commas (,). The values that correspond to Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0, 1, 2, 3, 4, 5, and 6.``
  • If you set the RecurrenceType parameter to Monthly, you can specify two values in the A-B format for this parameter. Valid values of A and B: 1 to 31. B must be greater than or equal to A.
  • If you set the RecurrenceType parameter to Cron, you can specify a cron expression. A cron expression is written in UTC time and consists of the following fields: minute, hour, day, month, and week. The expression can contain the letters L and W and the following wildcard characters: commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), and forward slashes (/).

You must specify both the RecurrenceType parameter and the RecurrenceValue parameter.

1
TaskEnabledbooleanNo

Specifies whether to enable the scheduled task.

  • true
  • false

Default value: true.

true
LaunchExpirationTimeintegerNo

The time period during which the failed scheduled task can be retried. Unit: seconds. Valid values: 0 to 1800.

Default value: 600.

600
MinValueintegerNo

The minimum number of instances in the scaling group if you specify the ScalingGroupId parameter.

0
MaxValueintegerNo

The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.

10
DesiredCapacityintegerNo

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
ScalingGroupIdstringNo

The ID of the scaling group whose number of instances must be modified when the scheduled task is triggered. If you specify the ScalingGroupId parameter for a scheduled task, you must specify the minimum, maximum, or expected numbers of instances for a scaling group in the scheduled task. That is, you must specify at least one of the MinValue, MaxValue, and DesiredCapacity parameters.

Note You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.
asg-bp18p2yfxow2dloq****

Response parameters

ParameterTypeDescriptionExample
object
ScheduledTaskIdstring

The globally unique ID of the scheduled task. The globally unique ID is generated by the system.

edRtShc57WGXdt8TlPbr****
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Sample success responses

JSONformat

{
  "ScheduledTaskId": "edRtShc57WGXdt8TlPbr****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history