资源编排支持通过命令行工具对资源栈进行创建、删除、更新、查看等操作。

概述

您可以通过下载安装包或者直接编译源码的方式来安装阿里云CLI。下面为您介绍下载安装包的方式,如需通过直接编码的方式来安装阿里云CLI, 请参见编译源码

阿里云命令行工具CLI支持在Windows、Linux和MacOS(x64版本)多系统上安装使用。您可以查看表格中不同安装方式对应的文档内容,并学习安装指南中的操作步骤,完成对阿里云CLI的安装。

安装方式 相关文档
通过下载安装包 选择您系统相应的安装学习路径:
  • Windows平台
  • Linux平台
  • MacOS平台
编译源码 编译源码
说明 您可以自行选择阿里云CLI的版本进行安装,需要说明的是3.0.25及以上的版本只支持新版ROS API,3.0.25以下的版本只支持旧版ROS API。

使用场景

  • 无法使用控制台情况下。
  • API 级别的开发、调试,例如查看资源栈,删除资源栈,查看资源类型等。

下载安装阿里云CLI

您可以通过下载安装包的方式,在平台上安装阿里云CLI。

Windows平台操作步骤

  1. 您可以登录官网或者GitHub的下载页面,下载名为aliyun-cli-windows-3.0.16-amd64.zip的Windows终端安装包。
  2. 解压aliyun-cli-windows-3.0.16-amd64.zip文件,获取名为aliyun.exe的可执行文件。
  3. 配置环境变量。您需要将aliyun.exe文件所在目录的路径添加到Path环境变量中。
    1. 进入环境变量图形界面,在用户变量集中,选择键为Path的环境变量,并单击编辑。
    2. 输入aliyun.exe文件所在目录的路径。
    3. 单击两次确定,应用更改。
    4. 打开终端,并执行如下命令查看环境变量是否配置成功。

      CMD终端: 试用

      set path

      PowerShell终端:试用

      env:path
  4. 在终端执行如下命令,验证阿里云CLI是否安装成功。 试用
    aliyun version

    如果系统显示类似如下的阿里云CLI当前版本号,则表示安装成功。

    3.0.16

Linux平台操作步骤

  1. 您可以登录到官网或者GitHub的下载页面,下载名为aliyun-cli-linux-3.0.16-amd64.tgz的Linux终端安装包。
  2. 执行如下命令,解压aliyun-cli-linux-3.0.16-amd64.tgz文件,获取名为aliyun的可执行文件。
    cd $HOME/aliyun
    tar xzvf aliyun-cli-linux-3.0.16-amd64.tgz
    说明 假设已经下载到了$HOME/aliyun目录中,并解压到此目录下。
  3. 执行如下命令,将aliyun程序移至/usr/local/bin目录中。 试用
    sudo cp aliyun /usr/local/bin
    说明 如果您是root用户,请移除sudo命令。

MacOs平台操作步骤

  1. 您可以登录到 官网或者GitHub的下载页面,下载名为aliyun-cli-macosx-3.0.16-amd64.tgz的MacOS终端安装包。
  2. 执行如下命令,解压aliyun-cli-macosx-3.0.16-amd64.tgz文件,获取名为aliyun的可执行文件。
    cd $HOME/aliyun
    tar xzvf aliyun-cli-macosx-3.0.16-amd64.tgz
    说明 假设已经下载到了$HOME/aliyun目录中,并解压到此目录下。
  3. 执行如下命令,将aliyun程序移至/usr/local/bin目录中。 试用
    sudo cp aliyun /usr/local/bin
    说明 如果您是root用户,请移除sudo命令。

配置阿里云CLI

在使用阿里云CLI之前,您需要配置调用阿里云资源所需的凭证信息、地域、语言等。

凭证类型

阿里云CLI可通过在configure命令后添加--mode <authenticationMethod>选项的方式,来使用不同的认证方式。目前支持的四种凭证类型如下:

验证方式 说明 交互式配置凭证(快速) 非交互式配置凭证
AK 使用AccessKey ID/Secret访问。 配置AccessKey凭证 配置AccessKey凭证
StsToken 使用STS Token访问。 配置STS Token凭证 配置STS Token凭证
RamRoleArn 使用RAM子账号的AssumeRole方式访问。 配置RamRoleArn凭证 配置RamRoleArn凭证
EcsRamRole 在ECS实例上通过EcsRamRole实现免密验证。 配置EcsRamRole凭证 配置EcsRamRole凭证
说明 除了EcsRamRole凭证无需AccessKey信息之外,其他三种都需要AccessKey信息。

配置凭证方式

在阿里云CLI中配置凭证时,您可以选择如下两种配置方式,并自行指定配置的凭证类型。下面介绍交互式配置方式AccessKey凭证;非交互式配置及其他配置详情,请参见配置凭证方式

  • 交互式配置(快速配置):此配置过程方便快速,您只需要根据提示信息输入相应的值即可。
  • 非交互式配置:即单命令行配置方式,您需要指定配置名称、凭证类型和对应凭证所需的鉴权信息等。

交互式配置简介

使用configure命令来配置凭证。其命令格式如下:

aliyun configure --mode <AuthenticateMode> --profile <profileName>

配置选项说明如下:

  • --profile:指定配置名称。如果指定的配置存在,则修改配置。若不存在,则创建配置。
  • --profile:指定凭证类型。分别为AKStsTokenRamRoleArnEcsRamRole

此配置方式的交互式提示信息中,包含Accesskey信息、RegionId等:

  • 请配置正确的AccessKey信息,若不正确,可能会造成误操作或者无法调用接口。
    说明 您可以在阿里云控制台的 AccessKey页面 ,创建和查看您的AccessKey,或者联系您的系统管理员获取AccessKey。
  • 阿里云支持的RegionId,请参见地域和可用区

配置AccessKey凭证

在阿里云CLI中,AccessKey凭证类型被命名为AK,且为默认凭证类型。因此,使用该方式快速配置凭证时,可以忽略--mode选项。

如下示例,配置名为akProfile的AccessKey凭证。

aliyun configure --profile akProfile
Configuring profile 'akProfile' in ''
authenticate mode...
Access Key Id []: AccessKey ID
Access Key Secret []: AccessKey Secret
Default Region Id []: cn-hangzhou
Default Output Format [json]: json (Only support json))
Default Language [zh|en] en:
Saving profile[akProfile] ...Done.

命令自动补全功能

在使用阿里云CLI时,您可以启用或关闭zsh/bash自动补全功能。

您可以通过如下命令启用或关闭自动补全功能,目前仅支持sh/bash。

  • 启用自动补全功能:
    aliyun auto-completion
  • 关闭自动补全功能:
    aliyun auto-completion --uninstall