云助手客户端是为ECS实例执行云助手命令的程序。本章节介绍如何安装云助手客户端。

前提条件

  • 您必须以管理员身份安装和使用云助手客户端。Linux实例的管理员用户名为root，Windows实例的管理员用户名为system。
  • 查询您的实例规格以及操作系统是否能使用云助手后，再自行安装客户端。更多详情，请参见云助手概述的使用限制章节。

背景信息

2017年12月01日之后使用公共镜像创建的ECS实例，默认预装云助手客户端。如果您的实例是2017年12月01日之前购买的，若需要使用云助手相关功能，请自行安装云助手客户端。
本章节介绍了三种安装方式：

通过下载链接安装客户端（Windows实例）

  1. 以管理员权限远程连接ECS实例。连接方式请参见连接方式概述。
  2. 下载云助手客户端。
    云助手客户端下载地址：
    • 公网地址（最新版本）：云助手客户端最新版本。
    • 公网地址（指定版本）： 
      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}为云助手客户端的具体版本号。
    • {regionId}为您实例所在的地域的Region ID，具体请参见地域和可用区。
    例如在杭州内网下载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实例的网络类型为经典网络，在云助手的安装目录下，创建名为region-id的文件（不要添加类似.txt或.conf的扩展名），在region-id文件中填入ECS实例所属地域的ID，例如cn-hangzhou。取值请参见地域和可用区。
    说明 Windows系统会隐藏已知文件类型的扩展名，您必须设置显示已知文件类型的扩展名才能真正判断region-id是否带有扩展名。

通过下载链接安装客户端（Linux实例）

  1. 以root权限远程连接ECS实例。连接方式请参见连接方式概述。
  2. 根据您的操作系统，选择下列安装方式的其中一种。
    • rpm包安装，适合CentOS、RHEL和SUSE Linux等操作系统
      1. 下载云助手客户端rpm包。
        • 公网地址（最新版本）： 
          wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm"
        • 公网地址（指定版本）： 
          wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_{version}.rpm"
        • 内网地址（最新版本）： 
          wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_latest.rpm"
        • 内网地址（指定版本）： 
          wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_{version}.rpm"
        说明
        • {version}为云助手客户端的具体版本号。
        • {regionId}为您实例所在的地域的Region ID，具体请参见地域和可用区。
        例如在杭州内网下载1.0.2.458版本，则对应地址如下所示。 
        wget "https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/linux/aliyun_assist_1.0.2.458.rpm"
      2. 安装云助手客户端。

        此示例表示安装最新版本云助手客户端。

        rpm -ivh --force aliyun_assist_latest.rpm
      3. 如果ECS实例的操作系统为RedHat，按以下步骤操作。
        1. 关闭qemu-ga服务。 
          systemctl stop qemu-guest-agent
systemctl disable qemu-guest-agent
        2. 重启云助手服务。 
          systemctl restart aliyun.service
      4. 如果ECS实例的网络类型为经典网络，在云助手的安装目录下，创建名为region-id的文件（不要添加类似.txt或.conf的扩展名），在region-id文件中填入ECS实例所属地域的ID，例如cn-hangzhou。取值请参见地域和可用区。
    • deb包安装，适合Debian和Ubuntu等操作系统
      1. 下载云助手客户端deb包。
        • 公网地址（最新版本）： 
          wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.deb"
        • 公网地址（指定版本）： 
          wget "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_{version}.deb"
        • 内网地址（最新版本）： 
          wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_latest.deb"
        • 内网地址（指定版本）： 
          wget "https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/linux/aliyun_assist_{version}.deb"
        说明
        • {version}为云助手客户端的具体版本号。
        • {regionId}为您实例所在的地域的Region ID，具体请参见地域和可用区。
        例如在杭州内网下载1.0.2.458版本，则对应地址如下所示。 
        wget "https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/linux/aliyun_assist_1.0.2.458.deb"
      2. 如果ECS实例中已经安装过云助手，卸载旧版本。 
        dpkg -r aliyun-assist
      3. 安装云助手客户端。

        此示例表示安装最新版本云助手客户端。

        dpkg -i aliyun_assist_latest.deb
      4. 如果ECS实例的网络类型为经典网络，在云助手的安装目录下，创建名为region-id的文件（不要添加类似.txt或.conf的扩展名），在region-id文件中填入ECS实例所属地域的ID，例如cn-hangzhou。取值请参见地域和可用区。
    • 源码编译安装
      1. 下载云助手客户端源码。 
        git clone https://github.com/aliyun/aliyun_assist_client
      2. 进入源码存放目录。
      3. 运行cmake .生成编译文件。
        说明 若编译时报错CMAKE_MINIMUM_REQUIRED，请前往CMake官网升级CMake服务至3.1及以上版本。
      4. 运行make开始编译。
      5. 如果ECS实例的网络类型为经典网络，在云助手的安装目录下，创建名为region-id的文件（不要添加类似.txt或.conf的扩展名），在region-id文件中填入ECS实例所属地域的ID，例如cn-hangzhou。取值请参见地域和可用区。
      6. 运行aliyun-service -d运行云助手客户端。
    如果您选择默认安装路径，则客户端在Linux实例中的安装目录为：
    • CoreOS操作系统：/opt/local/share/aliyun-assist/
    • 其他操作系统（Ubuntu、Debian、RedHat、SUSE Linux Enterprise Server、OpenSUSE和Aliyun Linux等）：/usr/local/share/aliyun-assist/

通过阿里云CLI安装客户端（Windows或Linux实例）

说明 RedHat系统不支持通过API安装，仅支持通过下载链接安装。详情请参见通过下载链接安装客户端（Linux实例）。
  1. 调用DescribeCloudAssistantStatus查询目标ECS实例是否安装了云助手客户端。 
    aliyun ecs DescribeCloudAssistantStatus --RegionId TheRegionId --InstanceId.1 i-bp1g6zv0ce8og******p --output cols=CloudAssistantStatus rows=InstanceCloudAssistantStatusSet.InstanceCloudAssistantStatus[]
    返回CloudAssistantStatus=true时，表示ECS实例已安装云助手客户端。否则，请继续下一步。
  2. 调用InstallCloudAssistant安装云助手客户端。 
    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. 查看云助手版本，Linux系统运行以下命令，Windows系统请参见升级或禁止升级云助手客户端。 
      aliyun-service -v
      若客户端版本高于1.0.1.400，云助手客户端安装成功。否则，继续下一步操作。
    3. 在云助手的安装目录下，创建名为region-id的文件（不要添加类似.txt或.conf的扩展名），在region-id文件中填入ECS实例所属地域的ID，例如cn-hangzhou。取值请参见地域和可用区。
      说明 Windows系统会隐藏已知文件类型的扩展名，您必须设置显示已知文件类型的扩展名才能真正判断region-id是否带有扩展名。