All Products
Search

This Product

    Auto Scaling:CreateScheduledTask

    Document Center

    Auto Scaling:CreateScheduledTask

    Last Updated:Aug 28, 2026

    Creates a scheduled task that automatically executes a specific scaling rule at a specified point in time, enabling automatic scaling of computing resources to ensure business continuity and minimize costs.

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

    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 execute when the scheduled task is triggered.

    If you specify ScheduledAction, the scheduled task uses an existing scaling rule. You cannot specify 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. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format.

    The time must be in UTC. You cannot specify a time later than 365 days from the creation of the scheduled task.

    2014-08-17T16:55Z
    LaunchTime

    string

    No

    The time at which the scheduled task is triggered. Specify the time in the ISO 8601 standard. The time must be in UTC. You cannot trigger a scheduled task more than 90 days after its creation.

    • If you specify RecurrenceType, the task is triggered repeatedly at the time specified by LaunchTime.

    • If you do not specify RecurrenceType, the task is triggered only once at the time specified by LaunchTime.

    2014-08-17T16:52Z
    RecurrenceType

    string

    No

    The recurrence pattern 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 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
    RecurrenceValue

    string

    No

    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
    TaskEnabled

    boolean

    No

    Whether to enable the scheduled task.

    • true

    • false

    Default value: true.

    true
    LaunchExpirationTime

    integer

    No

    The retry window for a failed scheduled task execution. 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 whose instance count changes when the scheduled task is triggered.

    If you specify ScalingGroupId, you must also specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. You cannot specify ScheduledAction and ScalingGroupId at the same time.

    asg-bp18p2yfxow2dloq****

    Response elements

    Element

    Type

    Description

    Example

    object

    ScheduledTaskId

    string

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

    edRtShc57WGXdt8TlPbr****
    RequestId

    string

    The ID of the request.

    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.