ACS-ECS-ScheduleToStartAndStopOrStopAndStartInstances.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "en": "Schedule to start and stop ECS instances",
    "zh-cn": "定时开关机或者关开机",
    "name-en": "ACS-ECS-ScheduleToStartAndStopOrStopAndStartInstances",
    "name-zh-cn": "定时开关机或者关开机",
    "categories": [
      "time_trigger"
    ]
  },
  "Parameters": {
    "regionId": {
      "Type": "String",
      "Label": {
        "en": "RegionId",
        "zh-cn": "地域ID"
      },
      "AssociationProperty": "RegionId",
      "Default": "{{ ACS::RegionId }}"
    },
    "targets": {
      "Type": "Json",
      "Label": {
        "en": "TargetInstance",
        "zh-cn": "目标实例"
      },
      "AssociationProperty": "Targets",
      "AssociationPropertyMetadata": {
        "ResourceType": "ALIYUN::ECS::Instance",
        "RegionId": "regionId"
      }
    },
    "startFirstOrStopFirst": {
      "Type": "String",
      "Label": {
        "en": "StartFirstOrStopFirst",
        "zh-cn": "开关机模式"
      },
      "AllowedValues": [
        "StartFirst",
        "StopFirst"
      ],
      "Default": "StartFirst",
      "AssociationPropertyMetadata": {
        "LocaleKey": "OOSStopInstanceMode"
      }
    },
    "weekdays": {
      "Label": {
        "en": "The Cycle of task",
        "zh-cn": "任务执行的周期"
      },
      "Type": "String",
      "AssociationProperty": "TimeTriggerWeekly",
      "Default": "*",
      "AssociationPropertyMetadata": {
        "Mode": "${startFirstOrStopFirst}",
        "StartTime": "${dailyStartTime}",
        "StopTime": "${dailyStopTime}"
      }
    },
    "dailyStartTime": {
      "Label": {
        "en": "DailyStartTime",
        "zh-cn": "每天开启实例的时间"
      },
      "Type": "String",
      "AssociationProperty": "DateTime",
      "AssociationPropertyMetadata": {
        "Format": "HH:mm:ssZ"
      }
    },
    "dailyStopTime": {
      "Label": {
        "en": "DailyStopTime",
        "zh-cn": "每天停止实例的时间"
      },
      "Type": "String",
      "AssociationProperty": "DateTime",
      "AssociationPropertyMetadata": {
        "Format": "HH:mm:ssZ"
      }
    },
    "triggerEndDate": {
      "Label": {
        "en": "The end date of time trigger",
        "zh-cn": "时间触发器结束时间"
      },
      "Type": "String",
      "AssociationProperty": "DateTime",
      "AssociationPropertyMetadata": {
        "Format": "YYYY-MM-DDTHH:mm:ssZ"
      },
      "Default": "2099-12-01T00:00:00Z"
    },
    "stoppedMode": {
      "Label": {
        "en": "StoppedMode",
        "zh-cn": "停止模式"
      },
      "Description": {
        "en": "<p class=\"p\">The stop mode that is set when stopping a pay-as-you-go ECS instance. Value:</p> <ul class=\"ul\"> <li class=\"li\"Save downtime mode. For the conditions for <code class=\"ph codeph\">StopCharging</code> to take effect, please refer to <span><a target=\"_blank\" href=\"https://help.aliyun.com/document_detail/63353.html\" >Enable Conditions for Pay-As-You-Go Instance Savings Downtime Mode</a></span>. </li> <li class=\"li\">Normal shutdown mode. Charges continue even after the instance is stopped. </li> </ul>",
        "zh-cn": "<p class=\"p\">停止按量付费ECS实例时，设置的停止模式。取值：</p> <ul class=\"ul\"> <li class=\"li\">节省停机模式：有关<code class=\"ph codeph\">StopCharging</code>生效的条件，请参见<span><a target=\"_blank\" href=\"https://help.aliyun.com/document_detail/63353.html\">按量付费实例节省停机模式</a></span>的启用条件章节。</li> <li class=\"li\">普通停机模式：实例停止后仍继续收费。</li> </ul>"
      },
      "Type": "String",
      "AllowedValues": [
        "StopCharging",
        "KeepCharging"
      ],
      "Default": "KeepCharging",
      "AssociationPropertyMetadata": {
        "LocaleKey": "ECSStoppedMode"
      }
    },
    "hibernate": {
      "Label": {
        "en": "WhetherToHibernateTheInstance",
        "zh-cn": "实例是否休眠"
      },
      "Type": "Boolean",
      "Default": false
    },
    "rateControl": {
      "Label": {
        "en": "RateControl",
        "zh-cn": "任务执行的并发比率"
      },
      "Type": "Json",
      "AssociationProperty": "RateControl",
      "Default": {
        "Mode": "Concurrency",
        "MaxErrors": 0,
        "Concurrency": 10
      }
    },
    "OOSAssumeRole": {
      "Label": {
        "en": "OOSAssumeRole",
        "zh-cn": "OOS扮演的RAM角色"
      },
      "Type": "String",
      "Default": "AliyunServiceRoleForOOSInstanceScheduler"
    }
  },
  "RamRole": "{{ OOSAssumeRole }}",
  "Tasks": [
    {
      "Name": "timerTrigger",
      "Action": "ACS::TimerTrigger",
      "Description": {
        "en": "Triggers a task as scheduled by specifying Cron expression",
        "zh-cn": "通过指定Cron表达式按计划触发任务"
      },
      "Properties": {
        "Type": "cron",
        "EndDate": "{{ triggerEndDate }}",
        "Expression": {
          "Fn::Join": [
            " ",
            [
              "0",
              {
                "Fn::Select": [
                  1,
                  {
                    "Fn::Split": [
                      ":",
                      {
                        "Fn::If": [
                          {
                            "Fn::Equals": [
                              "StartFirst",
                              "{{startFirstOrStopFirst}}"
                            ]
                          },
                          "{{ dailyStartTime }}",
                          "{{ dailyStopTime }}"
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "Fn::Select": [
                  0,
                  {
                    "Fn::Split": [
                      ":",
                      {
                        "Fn::If": [
                          {
                            "Fn::Equals": [
                              "StartFirst",
                              "{{startFirstOrStopFirst}}"
                            ]
                          },
                          "{{ dailyStartTime }}",
                          "{{ dailyStopTime }}"
                        ]
                      }
                    ]
                  }
                ]
              },
              "?",
              "*",
              "{{ weekdays }}"
            ]
          ]
        }
      }
    },
    {
      "Name": "getInstance",
      "Description": {
        "en": "Views the ECS instances",
        "zh-cn": "获取ECS实例"
      },
      "Action": "ACS::SelectTargets",
      "Properties": {
        "ResourceType": "ALIYUN::ECS::Instance",
        "RegionId": "{{regionId}}",
        "Filters": [
          "{{ targets }}"
        ]
      },
      "Outputs": {
        "instanceIds": {
          "Type": "List",
          "ValueSelector": "Instances.Instance[].InstanceId"
        }
      }
    },
    {
      "Name": "startInstanceFirst",
      "Action": "ACS::ECS::StartInstance",
      "Description": {
        "en": "Starts the ECS instances",
        "zh-cn": "首先开启实例"
      },
      "When": {
        "Fn::Equals": [
          "StartFirst",
          "{{startFirstOrStopFirst}}"
        ]
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "instanceId": "{{ ACS::TaskLoopItem }}"
      },
      "Loop": {
        "RateControl": "{{ rateControl }}",
        "Items": "{{ getInstance.instanceIds }}"
      }
    },
    {
      "Name": "sleepToStopTime",
      "Action": "ACS::Sleep",
      "Description": {
        "en": "Sleep to instance stop time",
        "zh-cn": "睡眠到实例停止时间"
      },
      "When": {
        "Fn::Equals": [
          "StartFirst",
          "{{startFirstOrStopFirst}}"
        ]
      },
      "Properties": {
        "Duration": {
          "Fn::DurationBetween": [
            "{{ dailyStartTime }}",
            "{{ dailyStopTime }}"
          ]
        }
      }
    },
    {
      "Name": "stopInstanceSecond",
      "Action": "ACS::ECS::StopInstance",
      "Description": {
        "en": "Stops the ECS instances",
        "zh-cn": "停止实例"
      },
      "When": {
        "Fn::Equals": [
          "StartFirst",
          "{{startFirstOrStopFirst}}"
        ]
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "instanceId": "{{ ACS::TaskLoopItem }}",
        "stoppedMode": "{{ stoppedMode }}",
        "hibernate": "{{ hibernate }}"
      },
      "Loop": {
        "RateControl": "{{ rateControl }}",
        "Items": "{{ getInstance.instanceIds }}"
      }
    },
    {
      "Name": "stopInstanceFirst",
      "Action": "ACS::ECS::StopInstance",
      "Description": {
        "en": "Stop the ECS instances first",
        "zh-cn": "首先停止实例"
      },
      "When": {
        "Fn::Equals": [
          "StopFirst",
          "{{startFirstOrStopFirst}}"
        ]
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "instanceId": "{{ ACS::TaskLoopItem }}",
        "stoppedMode": "{{ stoppedMode }}",
        "hibernate": "{{ hibernate }}"
      },
      "Loop": {
        "RateControl": "{{ rateControl }}",
        "Items": "{{ getInstance.instanceIds }}"
      }
    },
    {
      "Name": "sleepToStartTime",
      "Action": "ACS::Sleep",
      "Description": {
        "en": "Sleep to instance stop time",
        "zh-cn": "睡眠到实例开启时间"
      },
      "When": {
        "Fn::Equals": [
          "StopFirst",
          "{{startFirstOrStopFirst}}"
        ]
      },
      "Properties": {
        "Duration": {
          "Fn::DurationBetween": [
            "{{ dailyStopTime }}",
            "{{ dailyStartTime }}"
          ]
        }
      }
    },
    {
      "Name": "startInstance",
      "Action": "ACS::ECS::StartInstance",
      "Description": {
        "en": "Starts the ECS instances",
        "zh-cn": "开启实例"
      },
      "When": {
        "Fn::Equals": [
          "StopFirst",
          "{{startFirstOrStopFirst}}"
        ]
      },
      "Properties": {
        "regionId": "{{ regionId }}",
        "instanceId": "{{ ACS::TaskLoopItem }}"
      },
      "Loop": {
        "RateControl": "{{ rateControl }}",
        "Items": "{{ getInstance.instanceIds }}"
      }
    }
  ]
}