Product Introduction

Overview

Strengths

Scenarios

Service Limits

Access Management

Purchase Guide

Getting Started

Creating a Scaling Plan in 5 Minutes

Step 1:Creating a Launch Configuration

Step 2:Creating a Scaling Group

Step 3:Creating a Scaling Policy

Tutorial

Creating Web Services

Creating High-performance Computing Cluster

Creating Servers for Sending Requests

Configuring For High Availability Services

Launch Configuration

Launch Configuration Overview

Creating a Launch Configuration

Viewing Launch Configuration List

Modifying Launch Configurations

Exception Detection

Scaling Groups

Scaling Group Overview

Creating a Scaling Group

Viewing Scaling Group List

Modifying Scaling Groups

Modifying Bound Instances

Adding CLBs

Delete scaling group

Creating Notifications

Creating Scaling Activity Notifications

Specifying Notification Recipients

Expanding and Reducing Capacity

Auto Scaling Lifecycle Hook

Managing Scheduled Actions

Managing an Alarm-triggered Policy

Instance Health Check

Expanding Capacity Manually

Scale-in Process

Viewing Scaling Activities

Suspending and Resuming Scaling

Scale-in Removal Protection

Scaling Activity Cancelled

Scaling Activity Failed

Cooldown Period

Monitoring

Monitor Alarm Metrics

Running Status Check

Scheduled Task

Scheduled Task Execution Time Description

Troubleshooting

Scaling Group Doesn't Work

Scaling Activity Failed

Use Cases

Setting a Fixed Outbound IP Address for Scaling Groups

Deploying Elastic Web Application Service

Enabling Services Upon CVM Start-up

Customer Cases

iCarbonX

API Documentation

History

Introduction

API Category

Making API Requests

Scaling Group APIs

Scaling Group Instances APIs

Launch Configuration APIs

Scheduled Action APIs

Alarm Trigger Policy APIs

Notification APIs

Lifecycle Hook APIs

Instance Refresh APIs

Other APIs

Data Types

Error Codes

FAQs

Glossary

CreateScheduledAction

PDF

Modo Foco

Tamanho da Fonte

Última atualização: 2025-12-22 10:40:28

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	Scaling group ID. obtain available scaling group ids in the following ways:. Query the scaling group ID by logging in to the console. . Specifies the scaling group ID obtained by calling the api DescribeAutoScalingGroups and retrieving the AutoScalingGroupId from the return information. .
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.
MinSize	Yes	Integer	The minimum 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.
DesiredCapacity	Yes	Integer	The desired number of instances set for the auto scaling group when the scheduled task is triggered.
MaxSize	Yes	Integer	The maximum number of instances set for the auto scaling group when the scheduled task is triggered.
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 a scheduled task follows the standard Cron format. the Recurrence parameter limits in a scheduled task consist of 5 fields separated by spaces, with the structure: minute, hour, 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
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 One-Time Execution Scheduled Task

This example shows you how to create a scheduled task to adjust the scaling group's maximum instance count, minimum number of instances and expected number of instances to 10, 4 and 6 at the specified time (23:00 on 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 Scheduled Task with Repeated Execution

This example shows you how to create a scheduled task that adjusts the scaling group's maximum instance count, minimum number of instances and expected number of instances to 7, 2 and 3 daily at 23:00 UTC+8 starting from August 28, 2018, and ends after 00:00 UTC+8 on January 1, 2019.

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 * * *",
    "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

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

Ajuda e Suporte

Esta página foi útil?

Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.

comentários

tencent cloud

Auto Scaling

CreateScheduledAction

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Creating a One-Time Execution Scheduled Task

Input Example

Output Example

Example2 Creating a Scheduled Task with Repeated Execution

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Ajuda e Suporte