文档

ModifyScheduledTask - 修改一个定时任务的信息

更新时间:

修改一个定时任务的信息。

接口说明

定时任务支持两种伸缩方式:

  • 通过ScheduledAction参数设置需要执行的伸缩规则。
  • 通过ScalingGroupId参数设置伸缩组内实例数量。
说明 不支持同时设置ScheduledActionScalingGroupId

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:ModifyScheduledTaskWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ScheduledTaskIdstring

定时任务的 ID。

edRtShc57WGXdt8TlPbr****
ScheduledTaskNamestring

定时任务的名称。2~64 个英文或中文字符,以数字、大小字母或中文开头,可包含数字、下划线(_)、连字符(-)或点号(.)。同一账号同一地域内唯一。

scheduled****
Descriptionstring

定时任务的描述信息。2~200 个英文或中文字符。

Test scheduled task.
ScheduledActionstring

定时任务触发时需要执行的伸缩规则,填写伸缩规则的唯一标识符。指定ScheduledAction后,定时任务的伸缩方式为选择已有伸缩规则。

说明 不支持同时设置ScheduledActionScalingGroupId
ari:acs:ess:cn-hangzhou:14069264****:scalingrule/asr-bp12tcnol686y1ik****
RecurrenceEndTimestring

重复执行定时任务的结束时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mmZ。不能填写自修改当天起 365 日后的时间。

2014-08-20T16:55Z
LaunchTimestring

定时任务触发的时间点。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mmZ。不能填写自修改当天起 90 日后的时间。

  • 如果指定了RecurrenceType,则此属性指定的时间点,默认为循环执行的时间点。

  • 如果未指定RecurrenceType,则按指定的日期和时间执行一次。

2014-08-18T10:52Z
RecurrenceTypestring

重复执行定时任务的类型,取值范围:

  • Daily:每多少天重复执行一次定时任务。
  • Weekly:每周指定几天重复执行一次定时任务。
  • Monthly:每月内指定几天重复执行一次定时任务。
  • Cron:按照指定的 Cron 表达式执行定时任务。

修改后,RecurrenceTypeRecurrenceValue需要同时有效。

Daily
RecurrenceValuestring

重复执行定时任务的数值。

  • RecurrenceType取值为Daily时,只能填一个值,取值范围:1~31。
  • RecurrenceType取值为Weekly时,可以填入多个值,填多个值时使用半角逗号(,)分隔。例如,周日、周一、周二、周三、周四、周五、周六的值依次为:0,1,2,3,4,5,6
  • RecurrenceType取值为Monthly时,格式为A-B。A、B 的取值范围为 1~31,并且 B 必须大于等于 A。
  • RecurrenceType取值为Cron时,表示 UTC 时间,支持分、时、日、月、星期的五个域表达式,支持通配符半角逗号(,)、半角问号(?)、短划线(-)、星号(*)、井号(#)、正斜线(/)、L 和 W。

修改后,RecurrenceTypeRecurrenceValue需要同时有效。

2
TaskEnabledboolean

是否启动定时任务。取值范围:

  • true:启动定时任务。
  • false:停止定时任务。

默认值:true。

true
LaunchExpirationTimeinteger

定时任务触发操作失败后,在此时间内重试。单位为秒,取值范围:0~1800。

默认值:600。

600
MinValueinteger

定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的最小数量。

0
MaxValueinteger

定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的最大数量。

10
DesiredCapacityinteger

定时任务的伸缩方式为设置伸缩组内实例数量时,指定伸缩组内实例的期望实例数。

说明 伸缩组必须支持设置期望实例数,即在创建该伸缩组时指定了DesiredCapacity
10
ScalingGroupIdstring

定时任务触发时需要修改实例数量的伸缩组,填写伸缩组 ID。指定ScalingGroupId后,定时任务的伸缩方式为设置伸缩组内实例数量,您需要为MinValueMaxValueDesiredCapacity中至少一个参数指定数量。

说明 不支持同时设置ScheduledActionScalingGroupId
asg-bp18p2yfxow2dloq****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

HTTP status code错误码错误信息
400ThrottlingRequest was denied due to request throttling.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈