ModifyScheduledAction

Download PDF

Last updated:2025-12-22 10:40:27

ModifyScheduledAction

Last updated: 2025-12-22 10:40:27

Download PDF

1. API Description

Domain name for API request: as.intl.tencentcloudapi.com.

This API (ModifyScheduledAction) is used to modify a scheduled task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyScheduledAction.
Version	Yes	String	Common Params. The value used for this API: 2018-04-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ScheduledActionId	Yes	String	Scheduled task ID that needs modification. obtain the scheduled task ID by calling the api DescribeScheduledActions and retrieving the ScheduledActionId from the returned information.
ScheduledActionName	No	String	Scheduled task name, which can only contain letters, numbers, underscores, hyphens ("-"), and decimal points with a maximum length of 60 bytes and must be unique in an auto scaling group.
MaxSize	No	Integer	The maximum number of instances set for the auto scaling group when the scheduled task is triggered.
MinSize	No	Integer	The minimum number of instances set for the auto scaling group when the scheduled task is triggered.
DesiredCapacity	No	Integer	The desired number of instances set for the auto scaling group when the scheduled task is triggered.
StartTime	No	Timestamp ISO8601	Initial triggered time of the scheduled task. The value is in `Beijing time` (UTC+8) in the format of `YYYY-MM-DDThh:mm:ss+08:00` according to the `ISO8601` standard.
EndTime	No	Timestamp ISO8601	End time of the scheduled task. The value is in `Beijing time` (UTC+8) in the format of `YYYY-MM-DDThh:mm:ss+08:00` according to the `ISO8601` standard. This parameter and `Recurrence` need to be specified at the same time. After the end time, the scheduled task will no longer take effect.
Recurrence	No	String	The repeating mode of the scheduled task. follows the standard Cron format. the Recurrence parameter limits (https://www.tencentcloud.com/document/product/377/88119?from_cn_redirect=1) consist of 5 fields separated by space, with the structure: minute, hr, date, month, week. this parameter must be simultaneously specified with `EndTime`.
DisableUpdateDesiredCapacity	No	Boolean	Disable update DesiredCapacity Indicates the DesiredCapacity is updated normally during scheduled task triggering. Specifies whether the scheduled task triggers proactive modification of the DesiredCapacity when the value is True. DesiredCapacity may be modified by the minSize and maxSize mechanism. The following cases assume that DisableUpdateDesiredCapacity is True: - When scheduled task triggered, the original DesiredCapacity is 5. The scheduled task changes the minSize to 10, the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 5 is less than minSize 10, so the final new DesiredCapacity is 10. - When scheduled task triggered, the original DesiredCapacity is 25. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 25 is greater than the maxSize 20, so the final new DesiredCapacity is 20. - When scheduled task triggered, the original DesiredCapacity is 13. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect, and the DesiredCapacity is still 13.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying a Scheduled Task

Input Example

POST / HTTP/1.1
Host: as.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyScheduledAction
<Common request parameters>

{
    "DesiredCapacity": 3,
    "MinSize": 0,
    "MaxSize": 5,
    "ScheduledActionName": "scheduled-action-0",
    "StartTime": "2018-08-28T23:00:00+08:00",
    "ScheduledActionId": "asst-chwbkq4c"
}

Output Example

{
    "Response": {
        "RequestId": "5f6f0f95-216f-4745-a2e6-617897e9cedb"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	An internal error occurred.
InvalidParameter.ActionNotFound	Invalid Action request.
InvalidParameterValue.CronExpressionIllegal	The cron expression specified for the scheduled task is invalid.
InvalidParameterValue.EndTimeBeforeStartTime	The end time of the scheduled task is before the start time.
InvalidParameterValue.InvalidScheduledActionId	Invalid scheduled action ID.
InvalidParameterValue.InvalidScheduledActionNameIncludeIllegalChar	The scheduled task name contains invalid characters.
InvalidParameterValue.ScheduledActionNameDuplicate	The scheduled task name already exists.
InvalidParameterValue.Size	The value of maximum, minimum, or desired number of instances in the auto scaling group is invalid.
InvalidParameterValue.StartTimeBeforeCurrentTime	The start time of the scheduled task is before the current time.
InvalidParameterValue.TimeFormat	Wrong time format.
InvalidParameterValue.TooLong	Too many values.
LimitExceeded.DesiredCapacityLimitExceeded	The desired number of instances exceeds the limit.
LimitExceeded.MaxSizeLimitExceeded	The maximum number of instances exceeds the limit.
LimitExceeded.MinSizeLimitExceeded	The minimum number of instances is below the limit.
LimitExceeded.ScheduledActionLimitExceeded	The number of scheduled tasks exceeds the limit.
ResourceNotFound.ScheduledActionNotFound	The specified scheduled task does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud