CLI参考

前置概念

• 阿里云CLI（Alibaba Cloud Command Line Interface）是基于OpenAPI构建的通用命令行工具，您可以通过阿里云CLI实现自动化管理和维护资源目录。更多信息，请参见什么是阿里云CLI。

• 自3.0.282版本起，阿里云CLI已集成资源目录2022-04-19版本OpenAPI，建议您更新CLI至最新版本以获取调用支持。

• 暂不支持在阿里云CLI中调用资源目录2020-03-31版本OpenAPI。

步骤一：安装阿里云CLI

使用阿里云CLI前，您需要先安装阿里云CLI。阿里云CLI为用户提供了Windows、Linux和macOS三种操作系统下的安装服务，请根据您使用设备的操作系统选择对应的安装服务。

• Windows：安装CLI（Windows）。

• Linux：安装CLI（Linux）。

• macOS：安装CLI（macOS）。

云命令行（Cloud Shell）预装了阿里云CLI，且自动为您配置身份凭证，无需手动操作。您可在云命令行中调试阿里云CLI命令。更多信息，请参见什么是云命令行。

步骤二：配置阿里云CLI

使用阿里云CLI之前，您需要在阿里云CLI中配置身份凭证、地域ID等信息。阿里云CLI支持多种身份凭证，详情请参见身份凭证类型。本文以AK类型凭证为例，具体操作步骤如下：

1. 在资源目录管理账号下创建一个RAM用户，并创建AccessKey，以便后续配置身份凭证使用。具体操作，请参见创建RAM用户及创建AccessKey。

2. 为RAM用户授权。本文示例需要授予RAM用户只读访问资源目录的权限策略AliyunResourceDirectoryReadOnlyAccess。具体操作，请参见为RAM用户授权。

3. 获取可用的地域ID，以便后续配置身份凭证使用。阿里云CLI将使用您指定的地域发起OpenAPI调用，资源目录的可用地域请参见服务接入点。

   说明

   使用阿里云CLI过程中，您可使用--region选项指定地域发起命令调用，该选项在使用时将忽略默认身份凭证配置及环境变量设置中的地域信息。更多信息，请参见命令行选项。

4. 使用RAM用户的AccessKey及地域ID配置AK类型凭证，配置文件命名为AkProfile。具体操作，请参见配置示例。

步骤三：生成CLI命令示例

1. 在OpenAPI门户中，访问GetFolder调试地址。

   

2. 在参数配置中输入请求参数，单击CLI示例页签，查看生成的CLI示例。

3. 复制CLI示例或在云命令行中快速执行：

   • 单击运行命令按钮，可唤出云命令行并快速完成命令调试。

   • 单击复制按钮，将CLI示例复制到剪贴板中，可粘贴至本地Shell工具中运行。

   说明

   • 复制CLI示例到本地Shell工具中进行调试时请注意参数格式。

   • OpenAPI门户生成示例中会默认添加--region选项，复制命令到本地调用时阿里云CLI将忽略默认身份凭证配置及环境变量设置中的地域信息，优先使用指定的地域调用命令，您可根据需要对该选项进行删除或保留。

步骤四：调用资源目录OpenAPI

阿里云CLI支持调用的资源目录OpenAPI列表，请参见API概览。