全部产品
Search
文档中心

资源编排:ALIYUN::ESS::ScheduledTask

更新时间:Mar 26, 2024

ALIYUN::ESS::ScheduledTask类型用于根据指定参数创建定时任务。

语法

{
  "Type": "ALIYUN::ESS::ScheduledTask",
  "Properties": {
    "TaskEnabled": Boolean,
    "Description": String,
    "ScheduledTaskName": String,
    "LaunchExpirationTime": Integer,
    "LaunchTime": String,
    "RecurrenceEndTime": String,
    "RecurrenceType": String,
    "RecurrenceValue": String,
    "ScheduledAction": String,
    "MaxValue": Integer,
    "MinValue": Integer,
    "DesiredCapacity": Integer,
    "ScalingGroupId": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

TaskEnabled

Boolean

是否启动定时任务

取值:

  • true(默认值):启动任务

  • false:停止任务

Description

String

定时任务的描述信息

长度为2~200个字符

ScheduledTaskName

String

定时任务的显示名称

长度为2~40个字符,以数字、字母或中文字符开头,可包含数字、字母、中文字符、下划线(_)、短划线(-)或英文句点(.)。

同一用户账号同一地域内唯一。

如果没有指定该参数,默认为ScheduledScalingTaskId。

LaunchExpirationTime

Integer

定时任务触发操作失败后,在此时间内重试

取值范围:0~21600。

单位:秒。

默认值:600。

LaunchTime

String

定时任务触发的时间点

格式为:YYYY-MM-DDThh:mmZ

按照ISO8601标准表示,并需要使用UTC时间。

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

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

不能填写自创建或修改当天起90日后的时间。

RecurrenceEndTime

String

重复执行定时任务的结束时间

格式为:YYYY-MM-DDThh:mmZ

按照ISO8601标准表示,并需要使用UTC时间。

不能填写自创建或修改当天起90日后的时间。

RecurrenceType、RecurrenceValue和RecurrenceEndTime需要同时指定。

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需要同时指定。

ScheduledAction

String

定时任务触发时需要执行的操作

最大支持200个字符。

此处填写伸缩规则的唯一标识符。

MaxValue

Integer

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

MinValue

Integer

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

DesiredCapacity

Integer

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

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

ScalingGroupId

String

定时任务触发时需要修改实例数量的伸缩组,填写伸缩组ID。

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

说明

不支持同时设置ScheduledActionScalingGroupId

返回值

Fn::GetAtt

ScheduledTaskId: 定时任务的ID,由系统生成,全局唯一。

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Resources:
      ScheduledTask:
        Type: ALIYUN::ESS::ScheduledTask
        Properties:
          TaskEnabled: 'true'
          Description: scheduledtask
          ScheduledTaskName: task1
          LaunchTime: 2014-08-17T16:52Z
          RecurrenceEndTime: 2014-08-17T16:55Z
          RecurrenceType: Daily
          RecurrenceValue: '1'
          ScheduledAction: ari:acs:ess:cn-qingdao:1344371:scalingRule/cCBpdYdQuBe2cUxOdu6piOk
    Outputs:
      ScheduledTaskId:
        Value:
          FN::GetAtt:
            - ScheduledTask
            - ScheduledTaskId
  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Resources": {
        "ScheduledTask": {
          "Type": "ALIYUN::ESS::ScheduledTask",
          "Properties": {
            "TaskEnabled": "true",
            "Description": "scheduledtask",
            "ScheduledTaskName": "task1",
            "LaunchTime": "2014-08-17T16:52Z",
            "RecurrenceEndTime": "2014-08-17T16:55Z",
            "RecurrenceType": "Daily",
            "RecurrenceValue": "1",
            "ScheduledAction": "ari:acs:ess:cn-qingdao:1344371:scalingRule/cCBpdYdQuBe2cUxOdu6piOk"
          }
        }
      },
      "Outputs": {
        "ScheduledTaskId": {
          "Value": {
            "FN::GetAtt": [
              "ScheduledTask",
              "ScheduledTaskId"
            ]
          }
        }
      }
    }