文档

ALIYUN::ECS::Command

更新时间:

ALIYUN::ECS::Command类型用于新建云助手命令。

语法

{
  "Type": "ALIYUN::ECS::Command",
  "Properties": {
    "Name": String,
    "WorkingDir": String,
    "CommandContent": String,
    "Timeout": Integer,
    "Type": String,
    "Description": String,
    "EnableParameter": Boolean,
    "Username": String,
    "WindowsPasswordName": String,
    "ResourceGroupId": String,
    "ContainerName": String,
    "ContainerId": String,
    "RepeatMode": String
    "Tags": List
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Name

String

命令名称。

长度为1~128个字符。支持全字符集。

WorkingDir

String

您创建的命令在ECS实例中运行的目录。

默认值:

  • Linux实例:管理员root用户的home目录下,取值为:/root

  • Windows实例:云助手客户端进程所在目录,例如C:\Windows\System32

CommandContent

String

命令Base64编码后的内容。

该参数的值必须使用Base64编码后传输,且脚本内容的大小在Base64编码之后不能超过16KB。

命令内容支持使用自定义参数形式,具体通过指定参数EnableParameter取值为true启用自定义参数功能:

  • 自定义参数用两个大括号({{}})包含的方式定义,在两个大括号({{}})内参数名前后的空格以及换行符会被忽略。

  • 自定义参数个数不能超过20个。

  • 自定义参数名可包含英文字母和数字,参数名不区分大小写。

  • 单个参数名不能超过64个字符。

Timeout

Integer

您创建的命令在ECS实例中执行时的超时时间。

当因为某种原因无法运行您创建的命令时,会出现超时现象;超时后,会强制终止命令进程,即取消命令的PID。

默认值:60。

单位:秒。

Type

String

命令的类型。

取值:

  • RunBatScript:创建一个在Windows实例中运行的Bat脚本。

  • RunPowerShellScript:创建一个在Windows实例中运行的PowerShell脚本。

  • RunShellScript:创建一个在Linux实例中运行的Shell脚本。

Description

String

命令描述。

长度为1~512个字符。支持全字符集。

EnableParameter

Boolean

创建的命令是否使用自定义参数。

取值

  • true:使用自定义参数。

  • false(默认):不使用自定义参数。

Tags

List

实例的标签。最多支持添加20个标签。

更多信息,请参见Tags属性

RepeatMode

String

设置命令执行的方式。

取值范围:

  • Once:立即执行命令。

  • Period:定时执行命令。当该参数取值为Period时,必须同时指定Frequency参数。

  • NextRebootOnly:当实例下一次启动时,自动执行命令。

  • EveryReboot:实例每一次启动都将自动执行命令。

默认值:

  • 当不指定Frequency参数时,默认值为Once

  • 当指定Frequency参数时,无论是否已设置了该参数值,都将按照Period处理。

注意事项:

  • 您可以调用StopInvocation停止待执行的命令或定时执行的命令。

  • 当该参数取值Period或者EveryReboot时,您可以调用DescribeInvocationResults,然后指定IncludeHistory=true查看命令定时执行的历史记录。

ResourceGroupId

String

命令执行的资源组ID。

当指定该参数时:

ContainerName

String

容器名称。

注意事项:

  • 如果指定了该参数,云助手将在实例的指定容器内执行脚本。

  • 如果指定了该参数,仅支持在云助手Agent版本不低于2.2.3.344的Linux 实例内运行。

  • 如果指定了该参数,本接口中已指定的Username参数和CreateCommand中指定的WorkingDir参数将不会生效。仅支持通过容器默认用户在容器的默认工作目录下执行命令。更多信息,请参见使用云助手在容器内执行命令

  • 如果指定了该参数,在Linux容器中只支持执行Shell脚本,不支持在脚本开头使用类似#!/usr/bin/python命令的形式指定脚本内容的解释器。更多信息,请参见使用云助手在容器内执行命令

ContainerId

String

容器ID。

仅支持64位16进制字符串。支持使用docker://containerd://或者cri-o://前缀来表示指定的容器运行时。

注意事项:

  • 如果指定了该参数,云助手将在实例的指定容器内执行脚本。

  • 如果指定了该参数,仅支持在云助手Agent版本不低于2.2.3.344的Linux实例内运行。

  • 如果指定了该参数,本接口中已指定的Username参数和CreateCommand中指定的WorkingDir参数将不会生效。仅支持通过容器默认用户在容器的默认工作目录下执行命令。更多信息,请参见使用云助手在容器内执行命令

  • 如果指定了该参数,在Linux容器中只支持执行Shell脚本,不支持在脚本开头使用类似#!/usr/bin/python命令的形式指定脚本内容的解释器。更多信息,请参见使用云助手在容器内执行命令

Username

String

在ECS实例中执行命令的用户名称。

长度不得超过255个字符。

  • Linux系统的ECS实例,默认以root用户执行命令。

  • Windows系统的ECS实例,默认以System用户执行命令。

您也可以指定实例中已存在的其他用户执行命令,以普通用户执行云助手命令更加安全。更多信息,请参见设置普通用户执行云助手命令

WindowsPasswordName

String

在Windows实例中执行命令的用户的密码名称。

长度不得超过255个字符。

当您希望以非默认用户(System)在Windows实例中执行命令时,需要同时传入Username和该参数。为降低密码泄露的风险,需要将密码明文托管在运维编排服务的参数仓库中,此处仅传入密码的名称。更多信息,请参见加密参数以及设置普通用户执行云助手命令

说明

当您使用Linux实例的root用户或Windows实例的 System用户执行命令时,不需要传递该参数。

Tags语法

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Key

String

标签键。

长度为1~128个字符,不能以aliyunacs:开头,不能包含http://https://

Value

String

标签值。

长度为0~128个字符,不能以aliyunacs:开头,不能包含http://https://

返回值

Fn::GetAtt

CommandId:命令ID。

说明

如果您只需要执行一次性命令,请参见ALIYUN::ECS::RunCommand

示例

  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      Command:
        Type: ALIYUN::ECS::Command
        Properties:
          CommandContent:
            Fn::Base64Encode: |
              #!/bin/bash
              echo "hello" >> /root/test.sh
          Type: RunShellScript
          Name:
            Ref: ALIYUN::StackName
    Outputs:
      CommandId:
        Description: The id of command created.
        Value:
          Fn::GetAtt:
            - Command
            - CommandId
  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "Command": {
          "Type": "ALIYUN::ECS::Command",
          "Properties": {
            "CommandContent": {
              "Fn::Base64Encode": "#!/bin/bash\necho \"hello\" >> /root/test.sh\n"
            },
            "Type": "RunShellScript",
            "Name": {
              "Ref": "ALIYUN::StackName"
            }
          }
        }
      },
      "Outputs": {
        "CommandId": {
          "Description": "The id of command created.",
          "Value": {
            "Fn::GetAtt": [
              "Command",
              "CommandId"
            ]
          }
        }
      }
    }
  • 本页导读 (1)
文档反馈