弹性伸缩修改定时任务-定时任务相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（ModifyScheduledAction）用于修改定时任务。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyScheduledAction。
Version	是	String	公共参数，本接口取值：2018-04-19。
Region	是	String	公共参数，详见产品支持的地域列表。
ScheduledActionId	是	String	待修改的定时任务ID 示例值：asst-chwbkq4c
ScheduledActionName	否	String	定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。同一伸缩组下必须唯一。示例值：scheduled-action-0
MaxSize	否	Integer	当定时任务触发时，设置的伸缩组最大实例数。示例值：5
MinSize	否	Integer	当定时任务触发时，设置的伸缩组最小实例数。示例值：0
DesiredCapacity	否	Integer	当定时任务触发时，设置的伸缩组期望实例数。示例值：3
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`需要同时指定。示例值：0 18 * * 1,2,3,4,5

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改定时任务

输入示例

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

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

修改定时任务

本页目录：