All Products
Search

This Product

    Auto Scaling:CreateScheduledTask

    Document Center

    Auto Scaling:CreateScheduledTask

    Last Updated:Sep 10, 2026

    Creates a scheduled task.

    Operation description

    Operation description

    • If a scheduled task fails to trigger a scaling rule because a scaling activity is in progress in the scaling group or the scaling group is disabled, the scheduled task automatically retries within the period specified by LaunchExpirationTime. Otherwise, the scheduled task is skipped.

    • If multiple scheduled tasks trigger scaling rules for the same scaling group within a similar time frame, the details of the triggered scaling activities are as follows:

      • Scaling groups with the expected number of instances configured: The scaling activities triggered by multiple scheduled tasks are parallel scaling activities. For example, when multiple scheduled tasks are executed within a similar time frame, the scaling group can trigger multiple parallel scaling activities simultaneously.

      • Scaling groups without the expected number of instances configured: The earliest triggered scheduled task executes the scaling activity first. Because a scaling group can have only one scaling activity at a time, subsequent scheduled tasks automatically retry within the period specified by LaunchExpirationTime. If the previous scaling activity is completed while a subsequent scheduled task is still retrying within the LaunchExpirationTime period, the scaling rule of that scheduled task is executed and the corresponding scaling activity is triggered.

    • Scheduled tasks support the following two scaling methods:

      • Use the ScheduledAction parameter to specify the scaling rule to execute.

      • Use the ScalingGroupId parameter to specify the number of instances in the scaling group.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ess:CreateScheduledTask

    create

    *ScalingGroup

    acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The ID of the region where the scheduled task resides.

    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 (.). It must start with a digit, letter, or Chinese character. The name must be unique within the same account in the same region.

    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 scaling rule to execute when the scheduled task is triggered. Set this parameter to the unique identifier of the scaling rule.

    If you specify this parameter, the scaling method of the scheduled task is to use an existing scaling rule.

    Note

    You cannot specify both ScheduledAction and ScalingGroupId.

    ari:acs:ess:cn-hangzhou:140692647****:scalingrule/asr-bp12tcnol686y1ik****
    RecurrenceEndTime

    string

    No

    The end time of the recurrence for the scheduled task.

    Specify the time in the ISO 8601 standard in UTC. Format: YYYY-MM-DDThh:mmZ. The end time cannot be more than 365 days from the date of creation.

    2014-08-17T16:55Z
    LaunchTime

    string

    No

    The point in time at which the scheduled task is triggered.

    Specify the time in the ISO 8601 standard in UTC. Format: YYYY-MM-DDThh:mmZ. The time cannot be more than 90 days from the date of creation.

    • If you specify RecurrenceType, the scheduled task is executed repeatedly at the time specified by this parameter.

    • If you do not specify RecurrenceType, the task is executed only once at the specified date and time.

    2014-08-17T16:52Z
    RecurrenceType

    string

    No

    The recurrence type of the scheduled task. Valid values:

    • Daily: The scheduled task is executed once every specified number of days.

    • Weekly: The scheduled task is executed on specified days of each week.

    • Monthly: The scheduled task is executed on specified days of each month.

    • Cron: The scheduled task is executed based on the specified cron expression.

    You must specify both RecurrenceType and RecurrenceValue.

    Daily
    RecurrenceValue

    string

    No

    The recurrence value of the scheduled task.

    • If RecurrenceType is set to Daily, you can specify only one value. Valid values: 1 to 31.

    • If RecurrenceType is set to Weekly, you can specify multiple values separated by commas (,). The values that correspond to Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0,1,2,3,4,5,6.

    • If RecurrenceType is set to Monthly, the value is in the A-B format. Valid values of A and B: 1 to 31. B must be greater than or equal to A.

    • If RecurrenceType is set to Cron, the value is a UTC-based cron expression that supports five fields: minute, hour, day, month, and day of week. The following wildcard characters are supported: comma (,), question mark (?), hyphen (-), asterisk (*), pound sign (#), forward slash (/), L, and W.

    You must specify both RecurrenceType and RecurrenceValue.

    1
    TaskEnabled

    boolean

    No

    Specifies whether to enable the scheduled task. Valid values:

    • true: enables the task.

    • false: disables the task.

    Default value: true.

    true
    LaunchExpirationTime

    integer

    No

    The time period during which a failed scheduled task is retried. 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 to set 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 to set 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 to set the number of instances in the scaling group.

    Note

    The scaling group must have the expected number of instances feature enabled, which means DesiredCapacity was specified when the scaling group was created.

    10
    ScalingGroupId

    string

    No

    The ID of the scaling group whose number of instances is modified when the scheduled task is triggered.

    If you specify this parameter, the scaling method of the scheduled task is to set 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.

    asg-bp18p2yfxow2dloq****

    Response elements

    Element

    Type

    Description

    Example

    object

    ScheduledTaskId

    string

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

    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.