ModifyScheduledAction

Last updated: 2019-12-05 13:47:56

PDF

1. API Description

Domain name for API request: as.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: as.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyScheduledAction
Version Yes String Common parameter. The value used for this API: 2018-04-19
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ScheduledActionId Yes String ID of the scheduled task to be edited
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 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 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 Repeating mode of the scheduled task, which is in standard cron format.
This parameter and EndTime need to be specified at the same time.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying a Scheduled Task

Input Example

https://as.tencentcloudapi.com/?Action=ModifyScheduledAction
&ScheduledActionId=asst-chwbkq4c
&ScheduledActionName=scheduled-action-0
&MaxSize=5
&MinSize=0
&DesiredCapacity=3
&StartTime=2018-08-28T23:00:00+08:00
&<Common request parameter>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Internal error.
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.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.