云助手命令可以在ECS实例中快速完成运行自动化运维脚本、轮询进程、重置用户密码、安装或者卸载软件、更新应用以及安装补丁等一些日常任务。命令类型可以是Windows PowerShell脚本、Bat批处理命令和Linux Shell脚本，命令中支持自定义参数，方便设置变量值。

背景信息

  • 在一个阿里云地域下，您可以保存100条云助手命令，配额随您的云服务器使用情况可能会增加。 关于如何查询配额，请参见步骤一：查看资源配额。在立即执行命令时，如果您仅执行命令，则不占用云助手命令配额。
    说明 您也可以调用API DescribeAccountAttributes，将参数 AttributeName.N设置为 max-axt-command-count，查询一个地域中云助手命令配额。
  • 创建的脚本在Base64编码后大小不能超过16 KB。
  • 一份云助手命令中的自定义参数不能超过20个。
  • 创建命令时，您需要自行测试命令的语法、逻辑或算法是否正确。

    例如，假设您已在实例中创建了一个/backup目录（mkdir /backup），以下Shell命令将在该目录中归档一份文件。 

    #!/bin/bash 
OF=/backup/my-backup-$(date +%Y%m%d).tgz
tar -cf $OF {{file}}
    说明 以上示例命令中， {{file}}是一个自定义参数，您可以在执行命令时设置为需要归档的目标文件，如 /app/usrcredential。自定义参数能满足动态取值以及一值多用的场景。对于具有安全敏感性的数据以及随环境变化的数据，建议您设置自定义参数，例如AccessKey、实例ID、授权码、时间参数、关键系统文件等。

控制台操作

  1. 登录ECS管理控制台。
  2. 在左侧导航栏，选择运维与监控 > 发送命令/文件（云助手）。
  3. 在顶部菜单栏左上角处，选择地域。
  4. 单击创建/执行命令。
  5. 在命令信息区域，设置参数。
    名称 描述
    命令来源 选择命令来源。
    • 输入命令内容：创建一个新命令。
    • 选择已保存的命令：选择已创建的命令。
    命令名称 设置命令名称。
    执行计划 选择命令执行时间。
    • 立即执行：单击执行或执行并保存后，立即执行命令。
    • 系统下一次启动后：单击执行或执行并保存后，实例下次启动时执行命令。
    • 系统每次启动后：单击执行或执行并保存后，实例每次启动时执行命令。
    命令类型 选择命令类型。
    • Linux：选择Shell。
    • Windows：选择Bat或者Power Shell。
    命令内容 编辑或者粘贴您的命令。

    有关Shell命令的示例，请参见查看实例系统配置。

    使用参数 选择是否启用参数。

    如果您开启了使用参数功能，在命令内容中以{{key}}格式设置自定义参数。

    命令参数 设置命令内容中{{key}}自定义参数的取值。

    仅在开启了使用参数功能后可设置此参数。

    说明 如果需要在云助手中使用运维编排服务的参数仓库，请参见 在云助手命令中使用OOS参数仓库。
    命令描述 设置命令的描述信息。建议设置命令用途等信息，方便后续管理维护。
    执行用户 在ECS实例中执行命令的用户名称。

    使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。更多信息，请参见设置普通用户执行云助手命令。

    默认情况下，在Linux实例中以root用户执行命令，在Windows实例中以System用户执行命令。
    密码名称 选择托管在运维编排服务中的执行用户密码名称。仅在Windows实例中使用非System用户执行命令时，需要设置此参数。

    如果您没有将执行用户的密码托管在运维编排服务，需要在运维编排服务的参数仓库中创建并托管密码。更多信息，请参见创建加密参数和配置Windows实例的普通用户执行云助手命令。

    执行路径 自定义命令的执行路径。默认路径如下：
    • Linux：默认在root用户的/home目录。
    • Windows：默认在云助手客户端进程目录，例如，C:\ProgramData\aliyun\assist\$(version)。
    超时时间 设置命令在实例中的超时时间，当执行命令的任务超时后，云助手将强制终止任务进程。

    单位为秒，默认为60秒，最小为10秒。如果您设置的超时时间小于10秒，为确保命令执行成功，会被系统设置为10秒。

  6. 在选择实例和选择托管实例区域，选中需要执行命令的目标实例。
    说明 托管实例是云助手托管的非阿里云服务器，更多信息，请参见 混合云托管服务器。
  7. 单击保存。

CLI示例

  • 请求示例：

    调用CreateCommand接口创建一份名为update的云助手命令，用于更新系统。 

    aliyun ecs CreateCommand --RegionId 'cn-hangzhou' \
--CommandContent 'eXVtIHVwZGF0ZSAteQ==' \
--Type 'RunShellScript' \
--Name 'update' \
--Description 'update' \
--output cols=CommandId
    说明 半角单引号（''）内为参数的示例取值，您需要根据实际情况修改。
    名称 示例 描述
    RegionId cn-hangzhou 地域ID。
    Name update 命令名称。
    Type RunShellScript 命令类型。
    • Linux：RunShellScript
    • Windows：RunBatScript或者RunPowershellScript
    CommandContent eXVtIHVwZGF0ZSAteQ== 通过Base64编码后的命令内容。
    Description update 命令的描述信息。

    更多信息，请参见CreateCommand。

  • 返回示例： 
    CommandId
---------
c-hz018qng4on****

后续步骤

创建命令，您可以在命令列表页签中查看具体信息。如果需要对指定实例执行此命令，请参见执行命令。

说明 如果您创建的命令使用了参数，执行命令时，您需要在 命令参数栏中填写参数取值。