在ECS实例中安装云助手Agent_云服务器 ECS(ECS)-阿里云帮助中心

2017年12月01日之后使用公共镜像创建的ECS实例，已默认预装云助手Agent。如果您的实例是在2017年12月01日之前购买，或是通过自行上传的自定义镜像创建，或者是第三方云服务器，若要使用云助手相关功能，则需为该ECS实例安装云助手Agent。

注意事项

请确认您的操作系统是否支持安装云助手。有关支持的操作系统信息，请参见使用限制。
- 若操作系统支持云助手，请参考本文自行安装云助手Agent。
- 若操作系统不支持安装云助手，您可以选择更换或升级操作系统，最新的公共镜像默认安装了云助手Agent，更多详情请参见更换操作系统（更换系统盘）。
部分内核在安装云助手时存在最高可安装版本的限制。
实例的内核版本号
云助手Agent可升级的最高版本
实例的内核版本号
云助手Agent可升级的最高版本
Linux内核版本号小于2.6.32
X86/X64架构：2.2.3.398
ARM架构：2.4.3.398
FreeBSD 11及以下（内核版本号小于12.x）
2.3.3.529
在使用云助手支持的某项功能时，该功能对云助手的版本存在一定的要求。具体信息，请参见支持功能及版本。
若您想要将第三方云服务器注册为阿里云托管实例，请参见阿里云托管实例。

通过程序包方式安装

Windows系统安装步骤

以管理员账号远程连接ECS实例。
具体操作，请参见通过密码认证登录Windows实例。
下载云助手Agent。
云助手Agent下载地址：
- 公网地址（最新版本）：下载地址。
- 内网地址（最新版本）：
```
https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/windows/aliyun_agent_latest_setup.exe
```
  其中{regionId}为您实例所在的地域的Region ID。例如在杭州内网下载最新版本，则对应地址如下所示。
```
https://aliyun-client-assist-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/windows/aliyun_agent_latest_setup.exe
```
双击云助手Agent文件，根据安装向导完成安装。
如果您选择默认安装路径，云助手Agent在Windows实例中的安装目录为C:\ProgramData\aliyun\assist\。
您也可以将上述下载和安装的步骤整合成powershell脚本，以下脚本以内网最新版本地址为例，使用时请将{regionId}替换为您实例所在的地域的Region ID。
```
curl -UseBasicParsing -Uri https://aliyun-client-assist-{regionId}.oss-{regionId}-internal.aliyuncs.com/windows/aliyun_agent_latest_setup.exe -OutFile 'C:\\aliyun_agent_latest_setup.exe'
&"C:\\aliyun_agent_latest_setup.exe" '/S' 
```
（可选）如果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的示例结果如下：

Linux系统安装步骤

RPM和DEB包管理方式

FreeBSD

Binary安装方式

源代码安装方式

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

以sudo权限的用户远程连接ECS实例。
具体操作，请参见使用Workbench工具以SSH协议登录Linux实例。

执行如下脚本，完成云助手安装包的下载与安装。

重要

以下脚本会默认安装最新版本的Agent，如果受内核版本影响只能安装指定版本时，请将脚本中 VERSION=latest修改为指定的版本号，例如 VERSION=2.2.3.398。

内网下载安装脚本

公网下载安装脚本

推荐，适用于ECS实例，默认可以通过内网下载。

#!/bin/bash

VERSION=latest
PACKAGE=
PKG_URI=

REGION=$(curl http://100.100.100.200/latest/meta-data/region-id)
DOMAIN=aliyun-client-assist-${REGION}.oss-${REGION}-internal.aliyuncs.com

arch=$(uname -m)
echo "[main] arch = ${arch}"
case $arch in
    "i386"|"i686"|"x86_64"|"amd64")
        if command -v rpm; then
            PACKAGE="aliyun_assist_${VERSION}.rpm"
        else
            PACKAGE="aliyun_assist_${VERSION}.deb"
        fi
        PKG_URI="https://$DOMAIN/linux/$PACKAGE"
        ;;
    *)
        if command -v rpm; then
            PACKAGE="aliyun-assist-${VERSION}-1.aarch64.rpm"
        else
            PACKAGE="aliyun-assist-${VERSION}-1_arm64.deb"
        fi
        PKG_URI="https://$DOMAIN/arm/$PACKAGE"
esac

if command -v wget; then
    sudo wget $PKG_URI
elif command -v curl; then
    curl -o $PACKAGE $PKG_URI
else
    echo "[WARN] command wget/curl not found, exit"
    exit 1;
fi;

if command -v rpm; then
    sudo rpm -ivh --force $PACKAGE
elif command -v dpkg; then
    sudo dpkg -i $PACKAGE
else
    echo "[WARN] command rpm/dpkg not found, exit"
    exit 2;
fi

if [[ -e /etc/redhat-release ]]; then
    if sudo systemctl status qemu-guest-agent; then
        sudo systemctl stop qemu-guest-agent
        sudo systemctl disable qemu-guest-agent
        sudo systemctl restart aliyun.service
    fi
fi

适用于非阿里云主机以及可出公网的ECS实例。

#!/bin/bash

VERSION=latest
PACKAGE=
PKG_URI=

DOMAIN=aliyun-client-assist.oss-accelerate.aliyuncs.com

arch=$(uname -m)
echo "[main] arch = ${arch}"
case $arch in
    "i386"|"i686"|"x86_64"|"amd64")
        if command -v rpm; then
            PACKAGE="aliyun_assist_${VERSION}.rpm"
        else
            PACKAGE="aliyun_assist_${VERSION}.deb"
        fi
        PKG_URI="https://$DOMAIN/linux/$PACKAGE"
        ;;
    *)
        if command -v rpm; then
            PACKAGE="aliyun-assist-${VERSION}-1.aarch64.rpm"
        else
            PACKAGE="aliyun-assist-${VERSION}-1_arm64.deb"
        fi
        PKG_URI="https://$DOMAIN/arm/$PACKAGE"
esac

if command -v wget; then
    sudo wget $PKG_URI
elif command -v curl; then
    curl -o $PACKAGE $PKG_URI
else
    echo "[WARN] command wget/curl not found, exit"
    exit 1;
fi;

if command -v rpm; then
    sudo rpm -ivh --force $PACKAGE
elif command -v dpkg; then
    sudo dpkg -i $PACKAGE
else
    echo "[WARN] command rpm/dpkg not found, exit"
    exit 2;
fi

if [[ -e /etc/redhat-release ]]; then
    if sudo systemctl status qemu-guest-agent; then
        sudo systemctl stop qemu-guest-agent
        sudo systemctl disable qemu-guest-agent
        sudo systemctl restart aliyun.service
    fi
fi

以sudo权限的用户远程连接ECS实例。
具体操作，请参见使用Workbench工具以SSH协议登录Linux实例。

执行如下脚本，完成云助手安装包的下载与安装。

重要

以下脚本会默认安装最新版本的Agent，如果受内核版本影响只能安装指定版本时，请将脚本中 VERSION=latest修改为指定的版本号，例如 VERSION=2.3.3.529。

内网下载安装脚本

公网下载安装脚本

推荐，适用于ECS实例，默认可以通过内网下载。

#!/bin/sh

VERSION=latest
use_curl=0
which curl >/dev/null 2>&1 && use_curl=1
if [ $use_curl -eq 1 ];then
    REGION=$(curl http://100.100.100.200/latest/meta-data/region-id)
else
    REGION=$(wget -O - http://100.100.100.200/latest/meta-data/region-id)
fi
DOMAIN=aliyun-client-assist-${REGION}.oss-${REGION}-internal.aliyuncs.com
PACKAGE=aliyun_assist_${VERSION}.txz
PKG_URI="https://$DOMAIN/freebsd/$PACKAGE"

if [ $use_curl -eq 1 ];then
    curl -o $PACKAGE $PKG_URI
else
    wget -O $PACKAGE $PKG_URI
fi
pkg install -U -y $PACKAGE
service aliyun start

适用于非阿里云主机以及可出公网的ECS实例。

#!/bin/sh

VERSION=latest
DOMAIN=aliyun-client-assist.oss-accelerate.aliyuncs.com
PACKAGE=aliyun_assist_${VERSION}.txz
PKG_URI="https://$DOMAIN/freebsd/$PACKAGE"

use_curl=0
which curl >/dev/null 2>&1 && use_curl=1
if [ $use_curl -eq 1 ];then
    curl -o $PACKAGE $PKG_URI
else
    wget -O $PACKAGE $PKG_URI
fi
pkg install -U -y $PACKAGE
service aliyun start

适合主流Linux操作系统。

以sudo权限的用户远程连接ECS实例。
具体操作，请参见使用Workbench工具以SSH协议登录Linux实例。

执行如下脚本，完成云助手安装包的下载与安装。

重要

以下脚本会默认安装最新版本的Agent，如果受内核版本影响只能安装指定版本时，请将脚本中 VERSION=latest修改为指定的版本号，例如 VERSION=2.2.3.398。

内网下载安装脚本

公网下载安装脚本

推荐，适用于ECS实例，默认可以通过内网下载。

#!/bin/bash

VERSION=latest
PACKAGE=
PKG_URI=

REGION=$(curl http://100.100.100.200/latest/meta-data/region-id)
DOMAIN=aliyun-client-assist-${REGION}.oss-${REGION}-internal.aliyuncs.com

arch=$(uname -m)
echo "[main] arch = ${arch}"
case $arch in
    "i386"|"i686"|"x86_64"|"amd64")
        PACKAGE="aliyun_assist_${VERSION}.deb"
        PKG_URI="https://$DOMAIN/linux/$PACKAGE"
        ;;
    *)
        PACKAGE="aliyun-assist-${VERSION}-1_arm64.deb"
        PKG_URI="https://$DOMAIN/arm/$PACKAGE"
esac

if command -v wget; then
    sudo wget $PKG_URI
elif command -v curl; then
    curl -o $PACKAGE $PKG_URI
else
    echo "[WARN] command wget/curl not found, exit"
    exit 1
fi;

TARGET_DIR=/usr/local/share/aliyun-assist
sudo unzip -o $PACKAGE -d $TARGET_DIR/
sudo chmod a+x $TARGET_DIR/$VERSION/update_install
sudo bash $TARGET_DIR/$VERSION/update_install

适用于非阿里云主机以及可出公网的ECS实例。

#!/bin/bash

VERSION=latest
PACKAGE=
PKG_URI=

DOMAIN=aliyun-client-assist.oss-accelerate.aliyuncs.com

arch=$(uname -m)
echo "[main] arch = ${arch}"
case $arch in
    "i386"|"i686"|"x86_64"|"amd64")
        PACKAGE="aliyun_assist_${VERSION}_update.zip"
        PKG_URI="https://$DOMAIN/linux/$PACKAGE"
        ;;
    *)
        PACKAGE="aliyun-assist-${VERSION}-update_arm.zip"
        PKG_URI="https://$DOMAIN/arm/$PACKAGE"
esac

if command -v wget; then
    sudo wget $PKG_URI
elif command -v curl; then
    curl -o $PACKAGE $PKG_URI
else
    echo "[WARN] command wget/curl not found, exit"
    exit 1
fi;

TARGET_DIR=/usr/local/share/aliyun-assist
sudo unzip -o $PACKAGE -d $TARGET_DIR/
sudo chmod a+x $TARGET_DIR/$VERSION/update_install
sudo bash $TARGET_DIR/$VERSION/update_install

以sudo权限的用户远程连接ECS实例。
具体操作，请参见使用Workbench工具以SSH协议登录Linux实例。
安装Git和Go等必要的软件。
此示例通过yum安装，如果您使用其他Linux版本，请修改为对应的包管理工具。
- 安装Git：
```
sudo yum install git -y
```
- 安装Go：
```
sudo yum install go -y
```

下载云助手Agent源码。

sudo git clone https://github.com/aliyun/aliyun_assist_client

进入源码存放目录。
```
cd ./aliyun_assist_client
```
编译源码。
```
sudo go build
```
如果返回结果无报错信息，表示安装成功。
如果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等）为例，回显如下：
运行云助手Agent。
```
aliyun-service -d
```

通过OpenAPI方式安装

您还可以通过调用阿里云的OpenAPI，触发安装任务。该安装方式不区分操作系统类型。

API的调用流程如下：

调用DescribeCloudAssistantStatus查询目标ECS实例是否安装了云助手Agent。
若实例并未安装云助手Agent，则调用InstallCloudAssistant安装云助手Agent。
安装完成之后，调用RebootInstance重启ECS实例。

说明

通过OpenAPI方式安装时，需配置身份凭据（如AccessKey）信息。有关如何获取AccessKey，请参见创建AccessKey。

接下来，我们以通过CLI方式调用API为例，讲解安装过程。

通过阿里云CLI安装客户端，可免除远程连接实例的步骤，请确保您已经为本地客户端安装了阿里云CLI，在不同操作系统中安装CLI的方式如下：

说明

RHEL不支持通过阿里云CLI安装。

调用DescribeCloudAssistantStatus查询目标ECS实例是否安装了云助手Agent。
```
aliyun ecs DescribeCloudAssistantStatus --RegionId <YOUR-REGION-ID> --InstanceId.1 <YOUR-INSTANCE-ID> --output cols=CloudAssistantStatus rows=InstanceCloudAssistantStatusSet.InstanceCloudAssistantStatus[]
```
说明
请替换命令中的<YOUR-REGION-ID>为您ECS实例所在地域，<YOUR-INSTANCE-ID>为您ECS实例ID。当查询多个ECS实例是否安装云助手Agent时，请在命令中增加--InstanceId.2 <YOUR-INSTANCE-ID> --InstanceId.3 <YOUR-INSTANCE-ID> ... --InstanceId.N <YOUR-INSTANCE-ID>。
返回CloudAssistantStatus=true时，表示ECS实例已安装云助手Agent。否则，请继续下一步。
调用InstallCloudAssistant安装云助手Agent。
```
aliyun ecs InstallCloudAssistant --RegionId <YOUR-REGION-ID> --InstanceId.1 <YOUR-INSTANCE-ID>
```
说明
请替换命令中的<YOUR-REGION-ID>为您ECS实例所在地域，<YOUR-INSTANCE-ID>为您ECS实例ID。当为多个ECS实例安装云助手Agent时，请在命令中增加--InstanceId.2 <YOUR-INSTANCE-ID> --InstanceId.3 <YOUR-INSTANCE-ID> ... --InstanceId.N <YOUR-INSTANCE-ID>。
调用RebootInstance重启ECS实例。
```
aliyun ecs RebootInstance --InstanceId <YOUR-INSTANCE-ID>
```
说明
请替换命令中的<YOUR-INSTANCE-ID>为您ECS实例ID。
如果ECS实例的网络类型为经典网络，在实例内部添加所属地域声明。
1. 以root/system权限远程连接ECS实例。
  具体操作，请参见ECS远程连接方式概述。
2. 查看云助手版本。
  - Linux：运行以下命令。
    aliyun-service -v
  - Windows：具体操作，请参见升级或禁止升级云助手Agent。
  如果云助手Agent版本高于1.0.1.400，云助手Agent安装成功；否则，继续下一步操作。
3. 创建region-id文件并填入ECS实例所属地域的ID。
  Linux
  Windows
  在云助手的安装目录下，创建名为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等）为例，回显如下：
  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的示例结果如下：

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

通过控制台查看

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

访问ECS控制台-云助手。
在页面左侧顶部，选择目标资源所在的资源组和地域。
单击ECS实例页签，查看当前地域ECS实例上的云助手Agent信息。

通过API查看

您也可调用DescribeCloudAssistantStatus查询目标ECS实例是否安装了云助手Agent。

登录实例查看

Linux

Windows

远程连接ECS实例。具体操作，请参见使用Workbench工具以SSH协议登录Linux实例。
查看云助手服务状态。
确定ECS实例的初始化系统，依据该初始化系统选择相应的命令查看云助手服务状态。
```
ls -l /sbin/init
```
- 如果输出指向/lib/systemd/systemd，执行如下命令查看云助手状态。
```
systemctl status aliyun.service
```
  当云助手状态为active (running)，说明云助手服务正常运行中。
- 如果输出指向/sbin/upstart，执行如下命令查看云助手状态。
```
/sbin/initctl status aliyun-service
```
  当云助手状态为start/running，说明云助手服务正常运行中。
- 如果输出指向/sbin/init，执行如下命令查看云助手状态。
```
/etc/init.d/aliyun-service status
```
  当云助手状态为Running，说明云助手服务正常运行中。

查看云助手的版本。

rpm包管理：
```
sudo rpm -qa | grep aliyun_assist
```
deb包管理：
```
sudo dpkg -l | grep aliyun-assist
```

远程连接ECS实例，具体操作，请参见通过密码认证登录Windows实例。
查看云助手服务状态。
1. 单击开始菜单，搜索计算机管理。
2. 选择服务和应用程序 > 服务。
3. 找到Aliyun Assist Service，查看Aliyun Assist Service状态。如果状态为正在运行，说明云助手服务正常运行中。
查看云助手的版本。
双击Aliyun Assist Service，在弹出窗口中找到可执行文件的路径，在路径中可以查看云助手的版本。
例如可执行文件的路径为C:\ProgramData\aliyun\assist\2.1.3.857\aliyun_assist_service.exe，其中2.1.3.857为云助手的版本。

实例的内核版本号	云助手Agent可升级的最高版本
Linux内核版本号小于2.6.32	X86/X64架构：2.2.3.398 ARM架构：2.4.3.398
FreeBSD 11及以下（内核版本号小于12.x）	2.3.3.529