All Products
Search
Document Center

Auto Scaling:ModifyScheduledTask

Last Updated:Nov 02, 2026

Modifies the information of a scheduled task.

Operation description

Operation description

Scheduled tasks support the following two scaling methods:

  • Use the ScheduledAction parameter to specify the scaling rule to be executed.

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

Note

You cannot specify both ScheduledAction and ScalingGroupId at the same time.

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:ModifyScheduledTask

update

*ScalingGroup

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

None None

Request parameters

Parameter

Type

Required

Description

Example

ScheduledTaskId

string

Yes

The ID of the scheduled task.

edRtShc57WGXdt8TlPbr****

ScheduledTaskName

string

No

The name of the scheduled task. The name must be 2 to 64 characters in length, and can contain periods (.), underscores (_), and hyphens (-). It must start with a letter, digit, or Chinese character. The name must be unique within the same region and Alibaba Cloud account.

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. This parameter is available only when the scaling method is set to executing an existing scaling rule. Select an existing scaling rule and enter its unique identifier. You can view the identifier on the details page of the scaling rule.

Note

You cannot specify both ScheduledAction and ScalingGroupId at the same time.

ari:acs:ess:cn-hangzhou:14069264****: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 the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot specify a time that is later than 365 days from the date of modification.

2014-08-20T16:55Z

LaunchTime

string

No

The time at which the scheduled task is executed. 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 that is later than 90 days from the date of modification.

  • If RecurrenceType is specified, the time specified by this parameter is the default time for cyclic execution.

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

2014-08-18T10:52Z

RecurrenceType

string

No

The recurrence type of the scheduled task. The task can be executed on a daily, weekly, or monthly basis. 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.

After the modification, both RecurrenceType and RecurrenceValue must be valid.

Daily

RecurrenceValue

string

No

The recurrence value of the scheduled task, which corresponds to the recurrence type.

  • 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. Separate multiple values with commas (,). For example, the values for Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday are 0,1,2,3,4,5,6.

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

  • If RecurrenceType is set to Cron, the value represents a UTC time. The cron expression supports five fields: minute, hour, day, month, and week. It also supports wildcards such as commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), L, and W.

After the modification, both RecurrenceType and RecurrenceValue must be valid.

2

TaskEnabled

boolean

No

Specifies whether to enable the scheduled task. Valid values:

  • true: enables the scheduled task.

  • false: disables the scheduled task.

Default value: true.

true

LaunchExpirationTime

integer

No

The period of time during which Auto Scaling retries to execute the scheduled task after the 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. This parameter is available only 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. This parameter is available only 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. This parameter is available only 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 the expected number of instances. That is, 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. This parameter is available only when the scaling method is set to specifying the number of instances in the scaling group. After you specify ScalingGroupId, 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****

RegionId

string

No

The region ID of the scaling group.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 Throttling Request was denied due to request throttling.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.