有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(CreateScheduledAction)用于创建定时任务。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateScheduledAction。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupId String 伸缩组ID
示例值:asg-2nr9xh8h
ScheduledActionName String 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。同一伸缩组下必须唯一。
示例值:scheduled-action-0
MaxSize Integer 当定时任务触发时,设置的伸缩组最大实例数。
示例值:10
MinSize Integer 当定时任务触发时,设置的伸缩组最小实例数。
示例值:4
DesiredCapacity Integer 当定时任务触发时,设置的伸缩组期望实例数。
示例值:6
StartTime Timestamp ISO8601 定时任务的首次触发时间,取值为北京时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
示例值:2018-08-28T23:00:00+08:00
EndTime Timestamp ISO8601 定时任务的结束时间,取值为北京时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00

此参数与Recurrence需要同时指定,到达结束时间之后,定时任务将不再生效。
示例值:2019-01-01T00:00:00+08:00
Recurrence String 定时任务的重复方式。为标准 Cron 格式

此参数与EndTime需要同时指定。

3. 输出参数

参数名称 类型 描述
ScheduledActionId String 定时任务ID
示例值:asst-chwbkq4c
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建单次执行的定时任务

创建定时任务,在指定时间(北京时间2018年8月28日23点)调整伸缩组的最大实例数、最小实例数和期望实例数至 10、4、6。

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScheduledAction
<公共请求参数>

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

输出示例

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

示例2 创建重复执行的定时任务

创建定时任务,从北京时间2018年8月28日开始,每天 23:00 调整伸缩组的最大实例数、最小实例数和期望实例数至 7、2、3,在北京时间2019年1月1日 00:00 后结束。

输入示例

POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateScheduledAction
<公共请求参数>

{
    "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"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter.ActionNotFound 无效的Action请求。
InvalidParameterValue.CronExpressionIllegal 定时任务指定的Cron表达式无效。
InvalidParameterValue.EndTimeBeforeStartTime 定时任务设置的结束时间在开始时间。
InvalidParameterValue.InvalidAutoScalingGroupId 伸缩组ID无效。
InvalidParameterValue.InvalidScheduledActionNameIncludeIllegalChar 定时任务名称包含无效字符。
InvalidParameterValue.ScheduledActionNameDuplicate 定时任务名称重复。
InvalidParameterValue.Size 伸缩组最大数量、最小数量、期望实例数取值不合法。
InvalidParameterValue.StartTimeBeforeCurrentTime 定时任务设置的开始时间在当前时间之前。
InvalidParameterValue.TimeFormat 时间格式错误。
InvalidParameterValue.TooLong 取值过多。
LimitExceeded.DesiredCapacityLimitExceeded 期望实例数超出限制。
LimitExceeded.MaxSizeLimitExceeded 最大实例数大于限制。
LimitExceeded.MinSizeLimitExceeded 最小实例数低于限制。
LimitExceeded.QuotaNotEnough 当前剩余配额不足。
LimitExceeded.ScheduledActionLimitExceeded 定时任务数量超过限制。
MissingParameter 缺少参数错误。
ResourceNotFound.AutoScalingGroupNotFound 伸缩组不存在。