云助手Agent是为ECS实例执行云助手命令的程序。本文介绍如何安装云助手Agent

前提条件

查询您的实例规格以及操作系统是否能使用云助手后,再自行安装客户端。更多详情,请参见使用限制章节。

背景信息

2017年12月01日之后使用公共镜像创建的ECS实例,默认预装云助手Agent。如果您的实例是2017年12月01日之前购买的,若需要使用云助手相关功能,请自行安装云助手Agent

您需要根据云助手支持的功能来安装对应版本的云助手。云助手支持的功能与支持该功能的云助手最低版本号如下表所示。
云助手支持的功能云助手最低版本号(Linux实例)云助手最低版本号(Windows实例)相关文档
支持上报云助手心跳1.0.2.4581.0.0.149
发送文件1.0.2.5691.0.0.149上传本地文件到ECS实例
执行命令支持指定用户名称2.2.0.1062.1.0.50
支持设置实例下次启动时执行命令2.2.0.462.1.0.50
支持设置实例每次启动时执行命令
支持会话管理(Session Manager)2.2.3.1962.1.3.196通过会话管理连接实例
定时任务的执行规则支持Rate表达式、At表达式2.2.3.2822.1.3.282
定时任务的执行规则中,Cron表达式支持指定年份或时区2.2.3.2822.1.3.282
支持内置环境参数2.2.3.3092.1.3.309
支持将实例名称作为内置环境参数2.2.3.3442.1.3.344
支持通过指定特殊退出码停止或重启实例2.2.3.3172.1.3.317通过指定特殊退出码停止或重启实例
支持通过指定容器名称,在容器内执行命令2.2.3.3442.1.3.344使用云助手在容器内执行命令
支持通过指定容器ID,在容器内执行命令2.2.3.3442.1.3.344

不同操作系统可选择的安装方式如下表所示。

实例操作系统选择安装方式
Windows
Linux(Alibaba Cloud Linux、CentOS、RHEL和SUSE Linux等)
Linux(Debian和Ubuntu等)
Linux(其他)

Windows实例安装云助手Agent

  1. 以管理员账号远程连接ECS实例。
    具体操作,请参见连接方式概述
  2. 下载云助手Agent
    云助手Agent下载地址:
    • 公网地址(最新版本):云助手Agent最新版本
    • 公网地址(指定版本):
      https://aliyun-client-assist.oss-accelerate.aliyuncs.com/windows/aliyun_agent_{version}_setup.exe
    • 内网地址(最新版本):
      https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/windows/aliyun_agent_latest_setup.exe
    • 内网地址(指定版本):
      https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/windows/aliyun_agent_{version}_setup.exe
    说明
    • {version}云助手Agent的具体版本号。
    • {regionId}为您实例所在的地域的Region ID

      您可以在ECS控制台上的实例详情页面基本信息区域查看ECS实例所属地域,然后在地域和可用区中查看对应的地域ID。

    • 公网地址和内网地址支持指定下载的云助手版本号如下。
      • 公网地址:1.0.0.128、2.1.2.181、2.1.3.187、2.1.3.221、2.1.3.247、2.1.3.256、2.1.3.269、2.1.3.282、2.1.3.289、2.1.3.326、2.1.3.349、2.1.3.372、2.1.3.398
      • 内网地址:1.0.0.128、2.1.3.221、2.1.3.247、2.1.3.256、2.1.3.265、2.1.3.269、2.1.3.282、2.1.3.289、2.1.3.326、2.1.3.349、2.1.3.372、2.1.3.398
    例如在杭州内网下载1.0.0.128版本,则对应地址如下所示。
    https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/windows/aliyun_agent_1.0.0.128_setup.exe
  3. 双击客户端文件,根据安装向导完成安装。
    如果您选择默认安装路径,客户端在Windows实例中的安装目录为C:\ProgramData\aliyun\assist\
  4. 如果ECS实例的网络类型为经典网络,需要执行以下操作。
    1. 在云助手的安装目录下,创建名为region-id的文件(不要添加类似.txt.conf的扩展名)。
      重要 Windows系统会隐藏已知文件类型的扩展名,您必须设置显示已知文件类型的扩展名才能真正判断region-id是否带有扩展名。
    2. region-id文件中填入ECS实例所属地域的ID,例如cn-hangzhou
      说明 您可以在ECS控制台上的实例详情页面基本信息区域查看ECS实例所属地域,然后在地域和可用区中查看对应的地域ID。
    以Windows Server 2012 R2为例,在云助手默认安装路径C:\ProgramData\aliyun\assist\下新建的region-id文件及填入cn-hangzhou地域ID的示例结果如下:在Windows上添加文件

Linux实例安装云助手Agent(rpm包管理方式)

适合Alibaba Cloud Linux、CentOS、RHEL和SUSE Linux等操作系统。

  1. 以sudo权限的用户远程连接ECS实例。
    具体操作,请参见连接方式概述
  2. 下载云助手Agent rpm包。
    • 公网地址(最新版本):
      • X86版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm"
      • ARM版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/arm/aliyun-assist-latest-1.aarch64.rpm"
    • 公网地址(指定版本):
      • X86版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_{version}.rpm"
      • ARM版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/arm/aliyun-assist-{version}-1.aarch64.rpm"
    • 内网地址(最新版本):
      • X86版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_latest.rpm"
      • ARM版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/arm/aliyun-assist-latest-1.aarch64.rpm"
    • 内网地址(指定版本):
      • X86版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_{version}.rpm"
      • ARM版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/arm/aliyun-assist-{version}-1.aarch64.rpm"
    说明
    • {version}云助手Agent的具体版本号。
    • {regionId}为您实例所在的地域的Region ID

      您可以在ECS控制台上的实例详情页面基本信息区域查看ECS实例所属地域,然后在地域和可用区中查看对应的地域ID。

    • 公网地址和内网地址支持指定下载的云助手版本号如下。
      • 公网地址:
        • X86版本:1.0.1.413、1.0.1.414、1.0.1.448、1.0.1.450、1.0.2.458、1.0.2.479、1.0.2.541、1.0.2.569、1.0.2.574、2.2.0.102、2.2.0.106、2.2.2.181、2.2.3.187、2.2.3.221、2.2.3.247、2.2.3.256、2.2.3.269、2.2.3.282、2.2.3.289、2.2.3.326、2.2.3.349、2.2.3.372、2.2.3.398
        • ARM版本:2.4.3.282、2.4.3.326、2.4.3.349、2.4.3.372、2.4.3.398
      • 内网地址:
        • X86版本:1.0.1.407、1.0.2.458、1.0.2.479、2.2.3.221、2.2.3.247、2.2.3.256、2.2.3.265、2.2.3.269、2.2.3.282、2.2.3.289、2.2.3.326、2.2.3.349、2.2.3.372、2.2.3.398
        • ARM版本:2.4.3.282、2.4.3.326、2.4.3.349、2.4.3.372、2.4.3.398
    例如在杭州内网地址下载1.0.2.458 X86版本,则对应地址如下所示。
    sudo wget "https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/linux/aliyun_assist_1.0.2.458.rpm"
  3. 安装云助手Agent
    如果您选择默认安装路径,则客户端在Linux实例中的安装目录为:
    • CoreOS操作系统:/opt/local/share/aliyun-assist/
    • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):/usr/local/share/aliyun-assist/
    此示例表示安装最新版本云助手Agent
    • X86版本
      sudo rpm -ivh --force aliyun_assist_latest.rpm
    • ARM版本
      sudo rpm -ivh --force aliyun-assist-latest-1.aarch64.rpm
  4. 根据ECS实例的操作系统或网络类型不同,判断是否需要执行以下不同操作。
    • 如果ECS实例的操作系统为RedHat,执行以下操作。
      1. 关闭qemu-ga服务。
        sudo systemctl stop qemu-guest-agent
        sudo systemctl disable qemu-guest-agent
      2. 重启云助手服务。
        sudo systemctl restart aliyun.service
    • 如果ECS实例的网络类型为经典网络,执行以下操作。
      在云助手的安装目录下,创建名为region-id的文件,并在region-id文件中填入ECS实例所属地域的ID。以云助手默认安装路径为例,创建region-id文件并添加cn-hangzhou地域ID的命令如下:
      • CoreOS操作系统:
        sudo sh -c 'echo "cn-hangzhou" > /opt/local/share/aliyun-assist/region-id'
      • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):
        sudo sh -c 'echo "cn-hangzhou" > /usr/local/share/aliyun-assist/region-id'
      以其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等)为例,回显如下:创建文件

Linux实例安装云助手Agent(deb包管理方式)

适合Debian和Ubuntu等操作系统。

  1. 以sudo权限的用户远程连接ECS实例。
    具体操作,请参见连接方式概述
  2. 下载云助手Agent deb包。
    • 公网地址(最新版本):
      • X86版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.deb"
      • ARM版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/arm/aliyun-assist_latest-1_arm64.deb"
    • 公网地址(指定版本):
      • X86版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_{version}.deb"
      • ARM版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/arm/aliyun-assist_{version}-1_arm64.deb"
    • 内网地址(最新版本):
      • X86版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_latest.deb"
      • ARM版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/arm/aliyun-assist_latest-1_arm64.deb"
    • 内网地址(指定版本):
      • X86版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_{version}.deb"
      • ARM版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/arm/aliyun-assist_{version}-1_arm64.deb"
    说明
    • {version}云助手Agent的具体版本号。
    • {regionId}为您实例所在的地域的Region ID

      您可以在ECS控制台上的实例详情页面基本信息区域查看ECS实例所属地域,然后在地域和可用区中查看对应的地域ID。

    • 公网地址和内网地址支持指定下载的云助手版本号如下。
      • 公网地址:
        • X86版本:1.0.1.413、1.0.1.414、1.0.1.448、1.0.1.450、1.0.2.458、1.0.2.479、1.0.2.541、1.0.2.569、1.0.2.574、2.2.0.102、2.2.0.106、2.2.2.181、2.2.3.187、2.2.3.221、2.2.3.247、2.2.3.256、2.2.3.269、2.2.3.282、2.2.3.289、2.2.3.326、2.2.3.349、2.2.3.372、2.2.3.398
        • ARM版本:2.4.3.282、2.4.3.326、2.4.3.349、2.4.3.372、2.4.3.398
      • 内网地址:
        • X86版本:1.0.1.407、1.0.2.458、1.0.2.479、2.2.3.221、2.2.3.247、2.2.3.256、2.2.3.265、2.2.3.269、2.2.3.282、2.2.3.289、2.2.3.326、2.2.3.349、2.2.3.372、2.2.3.398
        • ARM版本:2.4.3.282、2.4.3.326、2.4.3.349、2.4.3.372、2.4.3.398
    例如在杭州内网地址下载1.0.2.458 X86版本,则对应地址如下所示。
    sudo wget "https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/linux/aliyun_assist_1.0.2.458.deb"
  3. 如果ECS实例中已经安装过云助手,卸载旧版本。
    sudo dpkg -r aliyun-assist
  4. 安装云助手Agent
    如果您选择默认安装路径,则客户端在Linux实例中的安装目录为:
    • CoreOS操作系统:/opt/local/share/aliyun-assist/
    • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):/usr/local/share/aliyun-assist/
    此示例表示安装最新版本云助手Agent
    • X86版本
      sudo dpkg -i aliyun_assist_latest.deb
    • ARM版本
      sudo dpkg -i aliyun-assist_latest-1_arm64.deb
  5. 如果ECS实例的网络类型为经典网络,执行以下操作。
    在云助手的安装目录下,创建名为region-id的文件,并在region-id文件中填入ECS实例所属地域的ID。以云助手默认安装路径为例,创建region-id文件并添加cn-hangzhou地域ID的命令如下:
    • CoreOS操作系统:
      sudo sh -c 'echo "cn-hangzhou" > /opt/local/share/aliyun-assist/region-id'
    • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):
      sudo sh -c 'echo "cn-hangzhou" > /usr/local/share/aliyun-assist/region-id'
    以其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等)为例,回显如下:创建文件

Linux实例安装云助手Agent(binary安装方式)

适合主流Linux操作系统。

  1. 以sudo权限的用户远程连接ECS实例。
    具体操作,请参见连接方式概述
  2. 下载云助手Agent binary包。
    • 公网地址(最新版本):
      • X86版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest_update.zip"
      • ARM版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/arm/aliyun_assist_latest_update_arm.zip"
    • 公网地址(指定版本):
      • X86版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_{version}_update.zip"
      • ARM版本
        sudo wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/arm/aliyun_assist_{version}_update_arm.zip"
    • 内网地址(最新版本):
      • X86版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_latest_update.zip"
      • ARM版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/arm/aliyun_assist_latest_update_arm.zip"
    • 内网地址(指定版本):
      • X86版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_{version}_update.zip"
      • ARM版本
        sudo wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/arm/aliyun_assist_{version}_update_arm.zip"
    说明
    • {version}云助手Agent的具体版本号。
    • {regionId}为您实例所在的地域的Region ID

      您可以在ECS控制台上的实例详情页面基本信息区域查看ECS实例所属地域,然后在地域和可用区中查看对应的地域ID。

    • 公网地址和内网地址支持指定下载的云助手版本号如下。
      • X86版本:2.2.3.282、2.2.3.289、2.2.3.326、2.2.3.349、2.2.3.372、2.2.3.398
      • ARM版本:2.4.3.282、2.4.3.326、2.4.3.349、2.4.3.372、2.4.3.398
    例如在杭州内网地址下载2.2.3.282 X86版本,则对应地址如下所示。
    sudo wget "https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/linux/aliyun_assist_2.2.3.282_update.zip"
  3. 安装云助手Agent
    如果您选择默认安装路径,则客户端在Linux实例中的安装目录为:
    • CoreOS操作系统:/opt/local/share/aliyun-assist/
    • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):/usr/local/share/aliyun-assist/

    请将binary包解压到安装目录后并进行安装。下列示例以2.2.3.282 x86版本的云助手Agent为例。

    sudo unzip  -o aliyun_assist_2.2.3.282_update.zip -d /usr/local/share/aliyun-assist/
    sudo chmod a+x /usr/local/share/aliyun-assist/2.2.3.282/update_install
    sudo bash /usr/local/share/aliyun-assist/2.2.3.282/update_install
  4. 根据ECS实例的操作系统或网络类型不同,判断是否需要执行以下不同操作。
    • 如果ECS实例的操作系统为RedHat,执行以下操作。
      1. 关闭qemu-ga服务。
        sudo systemctl stop qemu-guest-agent
        sudo systemctl disable qemu-guest-agent
      2. 重启云助手服务。
        sudo systemctl restart aliyun.service
    • 如果ECS实例的网络类型为经典网络,执行以下操作。
      在云助手的安装目录下,创建名为region-id的文件,并在region-id文件中填入ECS实例所属地域的ID。以云助手默认安装路径为例,创建region-id文件并添加cn-hangzhou地域ID的命令如下:
      • CoreOS操作系统:
        sudo sh -c 'echo "cn-hangzhou" > /opt/local/share/aliyun-assist/region-id'
      • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):
        sudo sh -c 'echo "cn-hangzhou" > /usr/local/share/aliyun-assist/region-id'
      以其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等)为例,回显如下:创建文件

Linux实例安装云助手Agent(源代码安装方式)

  1. 以sudo权限的用户远程连接ECS实例。
    具体操作,请参见连接方式概述
  2. 安装Git和go等必要的软件。
    此示例通过yum安装,如果您使用其他Linux版本,请修改为对应的包管理工具。
    • 安装git:
      sudo yum install git -y
    • 安装go:
      sudo yum install go -y
  3. 下载云助手Agent源码。
    sudo git clone https://github.com/aliyun/aliyun_assist_client
  4. 进入源码存放目录。
    cd ./aliyun_assist_client
  5. 编译源码。
    sudo go build
    如果返回结果无报错信息,表示安装成功。
  6. 如果ECS实例的网络类型为经典网络,执行以下操作。
    在云助手的安装目录下,创建名为region-id的文件,并在region-id文件中填入ECS实例所属地域的ID。以云助手默认安装路径为例,创建region-id文件并添加cn-hangzhou地域ID的命令如下:
    • CoreOS操作系统:
      sudo sh -c 'echo "cn-hangzhou" > /opt/local/share/aliyun-assist/region-id'
    • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):
      sudo sh -c 'echo "cn-hangzhou" > /usr/local/share/aliyun-assist/region-id'
    以其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等)为例,回显如下:创建文件
  7. 运行云助手Agent
    aliyun-service -d

通过阿里云CLI安装云助手Agent(Windows或Linux实例)

通过阿里云CLI安装客户端,可免除远程连接实例的步骤,请确保您已经为ECS实例安装了阿里云CLI,在不同操作系统中安装CLI的方式如下:
说明 RHEL不支持通过阿里云CLI安装。
  1. 调用DescribeCloudAssistantStatus查询目标ECS实例是否安装了云助手Agent
    aliyun ecs DescribeCloudAssistantStatus --RegionId TheRegionId --InstanceId.1 i-bp1g6zv0ce8og******p --output cols=CloudAssistantStatus rows=InstanceCloudAssistantStatusSet.InstanceCloudAssistantStatus[]
    返回CloudAssistantStatus=true时,表示ECS实例已安装云助手Agent。否则,请继续下一步。
  2. 调用InstallCloudAssistant安装云助手Agent
    aliyun ecs InstallCloudAssistant --RegionId TheRegionId --InstanceId.1 i-bp1g6zv0ce8og******p
  3. 调用RebootInstance重启ECS实例。
    aliyun ecs RebootInstance --InstanceId i-bp1g6zv0ce8og******p
  4. 如果ECS实例的网络类型为经典网络,在实例内部添加所属地域声明。
    1. 以root/system权限远程连接ECS实例。
      具体操作,请参见连接方式概述
    2. 查看云助手版本。

      如果客户端版本高于1.0.1.400,云助手Agent安装成功;否则,继续下一步操作。

    3. 创建region-id文件并填入ECS实例所属地域的ID。
      • Linux:
        在云助手的安装目录下,创建名为region-id的文件,并在region-id文件中填入ECS实例所属地域的ID。以云助手默认安装路径为例,创建region-id文件并添加cn-hangzhou地域ID的命令如下:
        • CoreOS操作系统:
          sudo sh -c 'echo "cn-hangzhou" > /opt/local/share/aliyun-assist/region-id'
        • 其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等):
          sudo sh -c 'echo "cn-hangzhou" > /usr/local/share/aliyun-assist/region-id'
        以其他操作系统(Alibaba Cloud Linux、Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server和OpenSUSE等)为例,回显如下:创建文件
      • Windows:
        1. 在云助手的安装目录下,创建名为region-id的文件(不要添加类似.txt.conf的扩展名)。
          重要 Windows系统会隐藏已知文件类型的扩展名,您必须设置显示已知文件类型的扩展名才能真正判断region-id是否带有扩展名。
        2. region-id文件中填入ECS实例所属地域的ID,例如cn-hangzhou
          说明 您可以在ECS控制台上的实例详情页面基本信息区域查看ECS实例所属地域,然后在地域和可用区中查看对应的地域ID。
        以Windows Server 2012 R2为例,在云助手默认安装路径C:\ProgramData\aliyun\assist\下新建的region-id文件及填入cn-hangzhou地域ID的示例结果如下:在Windows上添加文件

查看ECS实例的云助手Agent信息

您安装好云助手Agent后,可以通过以下步骤查看ECS实例的云助手Agent版本号、状态等信息。

  1. 登录ECS管理控制台
  2. 在左侧导航栏,选择运维与监控 > 发送命令/文件(云助手)
  3. 在顶部菜单栏左上角处,选择地域。
  4. 单击ECS实例页签,查看当前地域ECS实例上的云助手Agent信息。
    查询结果