CloudOps Orchestration Service：ACS-ECS-ScheduleToRunCommand

模板名稱

ACS-ECS-ScheduleToRunCommand 定時批量在ECS執行個體上運行命令

立即執行

模板描述

定時批量在多台ECS執行個體上運行雲助手命令

模板類型

自動化

所有者

Alibaba Cloud

輸入參數

輸出參數

執行此模板需要的權限原則

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DescribeInstances",
                "ecs:DescribeInvocationResults",
                "ecs:DescribeInvocations",
                "ecs:RunCommand"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

詳情

ACS-ECS-ScheduleToRunCommand詳情

模板內容

FormatVersion: OOS-2019-06-01
Description:
  en: Schedule to run command on ECS instances
  zh-cn: 定時批量在多台ECS執行個體上運行雲助手命令
  name-en: ACS-ECS-ScheduleToRunCommand
  name-zh-cn: 定時批量在ECS執行個體上運行命令
  categories:
    - time_trigger
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: 地區ID
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  triggerCron:
    Description:
      en: 'refer them here: https://help.aliyun.com/document_detail/169784.html'
      zh-cn: '詳情參考：https://help.aliyun.com/document_detail/169784.html'
    Label:
      en: Cronexpression
      zh-cn: cron運算式
    Type: String
    AssociationProperty: Cron
    Default: 0 0 12 ? * *
  triggerEndDate:
    Description:
      en: 'Format: yyyy-MM-ddTHH:mm:ssZ.'
      zh-cn: '格式：yyyy-MM-ddTHH:mm:ssZ'
    Label:
      en: triggerEndDate
      zh-cn: 時間觸發器結束時間
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'YYYY-MM-DDTHH:mm:ssZ'
  timeZone:
    Label:
      en: timeZone
      zh-cn: 時區
    Type: String
    AssociationProperty: TimeZone
    Default: UTC
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: 目標執行個體
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
      Status: Running
  commandType:
    Label:
      en: CommandType
      zh-cn: 雲助手命令類型
    Type: String
    AllowedValues:
      - RunBatScript
      - RunPowerShellScript
      - RunShellScript
    Default: RunShellScript
  commandContent:
    Label:
      en: CommandContent
      zh-cn: 雲助手命令
    Type: String
    MaxLength: 16384
    AssociationProperty: Code
    Default: echo hello
  workingDir:
    Description:
      en: '<td class="entry colsep-1 rowsep-1">
            <p class="p">Default value：</p>
            <ul class="ul">
            <li class="li"> Linux instances: the home directory of the administrator (the root user), which is<code class="ph codeph">/root</code>.</li>
            <li class="li"> Windows instances: the directory where the Cloud Assistant client process resides,such as <code class="ph codeph">C:\Windows\System32</code>.</li>
            </ul>
          </td>'
      zh-cn: <td class="entry colsep-1 rowsep-1">
              <p class="p">預設值：</p>
              <ul class="ul">
                <li class="li">Linux系統執行個體預設在管理員（root使用者）的home目錄下，即<code class="ph codeph">/root</code>。</li>
                <li class="li">Windows系統執行個體預設在雲助手用戶端進程所在目錄，例如<code class="ph codeph">C:\Windows\System32</code>。</li>
              </ul>
            </td>
    Label:
      en: WorkingDir
      zh-cn: 命令在ECS執行個體中的運行目錄
    Type: String
    Default: ''
  timeout:
    Label:
      en: Timeout
      zh-cn: 逾時時間
    Type: Number
    Default: 600
  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: OOSServiceRole
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: timerTrigger
    Action: ACS::TimerTrigger
    Description:
      en: Triggers a task as scheduled by specifying type and expression
      zh-cn: 通過指定觸發類型和運算式按計劃觸發任務
    Properties:
      Type: cron
      Expression: '{{ triggerCron }}'
      EndDate: '{{ triggerEndDate }}'
      TimeZone: '{{ timeZone }}'
  - 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: runCommand
    Action: 'ACS::ECS::RunCommand'
    Description:
      en: Execute cloud assistant command
      zh-cn: 執行雲助手命令
    Properties:
      regionId: '{{ regionId }}'
      commandContent: '{{ commandContent }}'
      instanceId: '{{ ACS::TaskLoopItem }}'
      commandType: '{{ commandType }}'
      workingDir: '{{ workingDir }}'
      timeout: '{{ timeout }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ getInstance.instanceIds }}'
      Outputs:
        commandOutputs:
          AggregateType: 'Fn::ListJoin'
          AggregateField: commandOutput
    Outputs:
      commandOutput:
        Type: String
        ValueSelector: invocationOutput
Outputs:
  commandOutputs:
    Type: List
    Value: '{{ runCommand.commandOutputs }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - timeZone
          - triggerCron
          - triggerEndDate
        Label:
          default:
            zh-cn: 定時設定
            en: Timer Trigger Configure
      - Parameters:
          - commandType
          - commandContent
          - workingDir
          - timeout
        Label:
          default:
            zh-cn: 執行命令選型
            en: run command options
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: 選擇執行個體
            en: Select Ecs Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: 進階選項
            en: Control Options