全部产品
阿里云办公

创建定时任务

更新时间:2018-08-27 14:25:12

描述

根据传入参数创建定时任务。

  • 每个用户最多能创建20个定时任务。
  • 由于伸缩组正在发生伸缩活动或者伸缩组停用等原因,导致定时任务触发执行伸缩规则失败后,在LaunchExpirationTime内,定时任务会自动重试触发,否则放弃本次定时触发。
  • 如果多个定时任务在相近的时间内触发执行同一个伸缩组的伸缩规则,则最早触发的定时任务会先执行伸缩活动。由于同一个伸缩组同一时刻内只能有一个伸缩活动,排在后面的定时任务会在LaunchExpirationTime内自动重试定时触发。如上一个伸缩活动完成之后,排在后面的定时任务还在LaunchExpirationTime内重试,则执行该定时任务的伸缩规则并触发相应的伸缩活动。

请求参数

名称 类型 是否必需 描述
Action String 操作接口名,系统规定参数,取值:CreateScheduledTask。
RegionId String 定时任务所在的地域ID。
ScheduledAction String 定时任务触发时需要执行的操作。此处填写伸缩规则的唯一标识符。
LaunchTime String 定时任务触发的时间点。
按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。
如果指定了RecurrenceType,则此属性指定的时间点,默认为循环执行的时间点。如果未指定RecurrenceType,则按指定的日期和时间执行一次。
不能填写自创建或修改当天起90日后的时间。
ScheduledTaskName String 定时任务的显示名称,2-40 个英文或中文字符,以数字、大小字母或中文开头,可包含数字,”_”、”-“或”.”。
同一用户账号同一地域内唯一。
如果没有指定该参数,默认值为ScheduledScalingTaskId。
Description String 定时任务的描述信息。2-200 个英文或中文字符。
LaunchExpirationTime Integer 定时任务触发操作失败后,在此时间内重试。
默认600秒。
取值范围:[0, 21600]
RecurrenceType String 重复执行定时任务的类型。可选值:
- Daily:每多少天重复执行一次定时任务。
- Weekly:每周指定几天重复执行一次定时任务。
- Monthly:每月内指定几天重复执行一次定时任务。
- Cron:按照指定的Cron表达式执行定时任务。
RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同时指定。
RecurrenceValue String 重复执行定时任务的数值。
- Daily:只能填一个值,取值范围:[1,31]。
- Weekly:可以填入多值。周日、周一……周六的值依次为:0, 1,2,…, 6,多天使用英文逗号(,)分隔。
- Monthly:格式为A-B。A、B的取值范围为[1,31],并且B必须大于等于A。
- Cron:表示UTC时间,支持分、时、日、月、星期的5域表达式,支持通配符英文逗号(,)、英文问号(?)、连词符(-)、星号(*)、井号(#)、斜线(/)、L 和 W。
RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同时指定。
RecurrenceEndTime String 重复执行定时任务的结束时间。
按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mmZ
不能填写自创建或修改当天起90日后的时间。
RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同时指定。
TaskEnabled Bool 是否启动定时任务。
- true为启动任务
- false为停止任务
默认为true。

返回参数

名称 类型 描述
ScheduledTaskId String 定时任务的ID,由系统生成,全局唯一。

示例

请求示例

  1. http://ess.aliyuncs.com/?Action=CreateScheduledTask
  2. &RegionId=cn-qingdao
  3. &LaunchTime=2014-08-17T16:52Z
  4. &RecurrenceType=Daily
  5. &RecurrenceValue=1
  6. &RecurrenceEndTime=2014-08-17T16:55Z
  7. &ScheduledAction=ari:acs:ess:cn-qingdao:1344371:scalingRule/cCBpdYdQuBe2cUxOdu6piOk
  8. &<公共请求参数>

返回示例

XML 格式

  1. <CreateScheduledTaskResponse>
  2. <ScheduledTaskId>edRtShc57WGXdt8TlPbrjsnV</ScheduledTaskId>
  3. <RequestId>0F02D931-2B12-44D7-A0E9-39925C13D15E</RequestId>
  4. </CreateScheduledTaskResponse>

JSON 格式

  1. {
  2. "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  3. "ScheduledTaskId": "edRtShc57WGXdt8TlPbrjsnV"
  4. }

错误码

关于所有接口的通用性错误,请参考客户端错误表服务器端错误表

错误代码 错误信息 HTTP 状态码 描述
InvalidRegionId.NotFound The specified region does not exist. 404 指定的地域不存在。
InvalidScheduledTaskName.Duplicate The specified value of parameter ScheduledTaskName is duplicated. 400 定时任务名已存在。
QuotaExceeded.ScheduledTask Scheduled task quota exceeded. 400 用户的定时任务使用个数达到上限。
ScheduledAction.RegionMismatch The specified scheduled task and the specified scheduled action are not in the same Region. 400 指定的ScheduledAction与定时任务所在的地域不匹配。