ACS::ECS::ActivateSoftware.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "name-en": "ACS::ECS::ActivateSoftware",
    "name-zh-cn": "执行命令并给ECS实例打标签",
    "en": "Creates a cloud assistant command and triggers it on an ECS instance",
    "zh-cn": "执行一个云助手命令并给ECS实例打标签"
  },
  "Parameters": {
    "regionId": {
      "Label": {
        "en": "RegionId",
        "zh-cn": "地域ID"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId",
      "Default": "{{ ACS::RegionId }}"
    },
    "instanceId": {
      "Label": {
        "en": "ECSInstanceId",
        "zh-cn": "ECS实例ID"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "regionId"
      }
    },
    "commandType": {
      "Label": {
        "en": "CommandType",
        "zh-cn": "命令类型"
      },
      "AssociationPropertyMetadata": {
        "LocaleKey": "ECSCommandType"
      },
      "Type": "String",
      "AllowedValues": [
        "RunBatScript",
        "RunPowerShellScript",
        "RunShellScript",
        "RunPythonScript",
        "RunPerlScript"
      ]
    },
    "commandContent": {
      "Label": {
        "en": "CommandContent",
        "zh-cn": "命令内容"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::OOS::Command::CommandContent",
      "AssociationPropertyMetadata": {
        "CommandType": "${commandType}"
      }
    }
  },
  "Tasks": [
    {
      "Name": "untilOrderPaiedReady",
      "Action": "ACS::WaitFor",
      "Retries": 57,
      "Description": {
        "en": "Waits for the order is paied",
        "zh-cn": "等待订单支付完成"
      },
      "Properties": {
        "Service": "ECS",
        "API": "DescribeInstances",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "InstanceIds": [
            "{{ instanceId }}"
          ]
        },
        "NotDesiredValues": [
          null
        ],
        "PropertySelector": ".Instances.Instance[0].Tags.Tag[] | select(.TagKey == \"acs:ecs:licenseCode\") | .TagValue"
      }
    },
    {
      "Name": "runCommand",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Executes a cloud assistant command",
        "zh-cn": "执行云助手命令"
      },
      "Properties": {
        "Service": "ECS",
        "API": "RunCommand",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "CommandContent": "{{ commandContent }}",
          "InstanceIds": [
            "{{instanceId}}"
          ],
          "Name": "{{ ACS::ExecutionId }}",
          "Type": {
            "Fn::If": [
              {
                "Fn::Or": [
                  {
                    "Fn::Equals": [
                      "{{ commandType }}",
                      "RunPythonScript"
                    ]
                  },
                  {
                    "Fn::Equals": [
                      "{{ commandType }}",
                      "RunPerlScript"
                    ]
                  }
                ]
              },
              "RunShellScript",
              "{{ commandType }}"
            ]
          }
        }
      },
      "Outputs": {
        "invokeId": {
          "Type": "String",
          "ValueSelector": "InvokeId"
        }
      }
    },
    {
      "Name": "untilInvocationReady",
      "Action": "ACS::WaitFor",
      "Description": {
        "en": "Waits for the command to be completed",
        "zh-cn": "等待云助手命令执行完成"
      },
      "OnError": "ACS::END",
      "Retries": 296,
      "MaxRetryInterval": 300,
      "Properties": {
        "Service": "ECS",
        "API": "DescribeInvocations",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "InvokeId": "{{ runCommand.invokeId }}"
        },
        "DesiredValues": [
          "Finished"
        ],
        "StopRetryValues": [
          "Failed",
          "Stopped"
        ],
        "PropertySelector": "Invocations.Invocation[].InvokeStatus"
      }
    },
    {
      "Name": "describeInvocationResults",
      "Action": "ACS::ExecuteAPI",
      "Description": {
        "en": "Queries the command output of a cloud assistant command in the specified ECS instance",
        "zh-cn": "查看在ECS实例上执行云助手命令的返回结果"
      },
      "Properties": {
        "Service": "ECS",
        "API": "DescribeInvocationResults",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "InvokeId": "{{ runCommand.invokeId }}"
        }
      },
      "Outputs": {
        "invocationResult": {
          "Type": "String",
          "ValueSelector": "Invocation.InvocationResults.InvocationResult[].Output"
        }
      }
    },
    {
      "Name": "checkInvocationResult",
      "Action": "ACS::CheckFor",
      "Description": {
        "en": "Checks the command exitcode of a cloud assistant command",
        "zh-cn": "检测云助手命令的退出码"
      },
      "OnError": "ACS::END",
      "Properties": {
        "Service": "ECS",
        "API": "DescribeInvocationResults",
        "Parameters": {
          "RegionId": "{{ regionId }}",
          "InvokeId": "{{ runCommand.InvokeId }}"
        },
        "PropertySelector": "Invocation.InvocationResults.InvocationResult[].ExitCode",
        "DesiredValues": [
          0
        ]
      }
    }
  ],
  "Outputs": {
    "invocationOutput": {
      "Type": "String",
      "Value": {
        "Fn::Base64Decode": "{{ describeInvocationResults.invocationResult }}"
      }
    }
  },
  "Metadata": {
    "ALIYUN::OOS::Interface": {
      "ParameterGroups": [
        {
          "Parameters": [
            "regionId",
            "instanceId"
          ],
          "Label": {
            "default": {
              "zh-cn": "选择实例",
              "en": "Select Ecs Instances"
            }
          }
        },
        {
          "Parameters": [
            "commandType",
            "commandContent"
          ],
          "Label": {
            "default": {
              "zh-cn": "执行命令选项",
              "en": "Run Command Options"
            }
          }
        }
      ]
    }
  }
}