tencent cloud

CreateScheduledAction
Download PDF
Last updated: 2024-11-27 15:17:27
CreateScheduledAction
Last updated: 2024-11-27 15:17:27
Download PDF

1. API Description

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

This API (CreateScheduledAction) is used to create 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: CreateScheduledAction.
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.
AutoScalingGroupId Yes String Auto scaling group ID
ScheduledActionName Yes 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 Yes Integer The maximum number of instances set for the auto scaling group when the scheduled task is triggered.
MinSize Yes Integer The minimum number of instances set for the auto scaling group when the scheduled task is triggered.
DesiredCapacity Yes Integer The desired number of instances set for the auto scaling group when the scheduled task is triggered.
StartTime Yes 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 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
ScheduledActionId String Scheduled task ID
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 Creating a single-run scheduled action

This example shows you how to create a scheduled action to adjust the maximum, minimum, and desired capacity of the scaling group to 10, 4, and 6 respectively at 23:00, August 28, 2018 (UTC+8).

Input Example

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

{
    "DesiredCapacity": "6",
    "AutoScalingGroupId": "asg-2nr9xh8h",
    "MinSize": "4",
    "MaxSize": "10",
    "ScheduledActionName": "scheduled-action-0",
    "StartTime": "2018-08-28T23:00:00+08:00"
}

Output Example

{
    "Response": {
        "ScheduledActionId": "asst-chwbkq4c",
        "RequestId": "193a710f-8dbf-46aa-8b4a-195532244df8"
    }
}

Example2 Creating a recurring scheduled action

This example shows you how to create a scheduled action to adjust the maximum, minimum, and desired capacity of a scaling group to 7, 2, and 3 respectively at 23:00 every day starting from August 28, 2018 and ending at 00:00, January 1, 2019 (UTC+8).

Input Example

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

{
    "Recurrence": "0 23 */1 * *",
    "DesiredCapacity": "3",
    "AutoScalingGroupId": "asg-2nr9xh8h",
    "MinSize": "2",
    "MaxSize": "7",
    "ScheduledActionName": "scheduled-action-1",
    "StartTime": "2018-08-28T23:00:00+08:00",
    "EndTime": "2019-01-01T00:00:00+08:00"
}

Output Example

{
    "Response": {
        "ScheduledActionId": "asst-le3us530",
        "RequestId": "502fd6fa-44ff-4c79-b77e-ee20f72bddc0"
    }
}

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

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.InvalidAutoScalingGroupId Invalid scaling group 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.QuotaNotEnough You are short of the quota.
LimitExceeded.ScheduledActionLimitExceeded The number of scheduled tasks exceeds the limit.
MissingParameter Parameter missing.
ResourceNotFound.AutoScalingGroupNotFound The scaling group does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback