修改定时任务

最近更新时间:2018-11-15 15:47:56

1. 接口描述

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

本接口(ModifyScheduledAction)用于修改定时任务。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyScheduledAction
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的地域列表
ScheduledActionId String 待修改的定时任务ID
ScheduledActionName String 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。同一伸缩组下必须唯一。
MaxSize Integer 当定时任务触发时,设置的伸缩组最大实例数。
MinSize Integer 当定时任务触发时,设置的伸缩组最小实例数。
DesiredCapacity Integer 当定时任务触发时,设置的伸缩组期望实例数。
StartTime Timestamp 定时任务的首次触发时间,取值为北京时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
EndTime Timestamp 定时任务的结束时间,取值为北京时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
此参数与Recurrence需要同时指定,到达结束时间之后,定时任务将不再生效。
Recurrence String 定时任务的重复方式。为标准Cron格式
此参数与EndTime需要同时指定。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改定时任务

输入示例

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
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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