使用阿里云CLI调用OpenAPI

介绍使用阿里云CLI调用OpenAPI的具体操作流程，包括安装、配置凭证、生成并调用命令等步骤。

方案概览

使用阿里云CLI调用OpenAPI，大致分为四个步骤：

1. 安装阿里云CLI：根据您使用设备的操作系统，选择并安装相应的版本。

2. 配置阿里云CLI：在阿里云CLI中完成身份凭证的配置，主要包括AccessKey信息以及地域信息。阿里云CLI将使用配置中的凭证信息调用OpenAPI。

3. 生成CLI命令：在OpenAPI门户中输入参数，生成携带参数的CLI命令示例，复制粘贴到Shell工具中即可运行。

4. 调用API：在Shell工具中输入命令并根据需要使用命令选项，运行命令即可调用对应OpenAPI。

5. 

前提条件

• 使用阿里云CLI之前，如果您还没有账号，请访问阿里云官网注册阿里云账号（主账号），同时建议您创建专用于API访问的RAM用户。具体操作可参见创建RAM用户。

• 部分产品需要开通云产品服务才可调用该产品OpenAPI。您可以通过以下两种方式开通您所需要的云产品服务，以开通短信服务为例：

  • 可访问开通助手一键开通云产品服务。搜索短信服务，选中短信服务，单击一键开通。

  • 访问各云产品控制台开通云产品服务。例如在短信服务控制台单击开通。

• 使用阿里云CLI前，您需要确认需集成的云产品是否支持阿里云CLI。确认方法如下：

  • 查看该云产品文档中心，在开发参考>集成概览中查看阿里云CLI支持情况。

  • 在阿里云提供的在线服务Cloud Shell中执行aliyun --help命令，获取阿里云CLI支持产品列表。

步骤一：安装阿里云CLI

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

• Windows：在Windows上安装阿里云CLI。

• Linux：在Linux上安装阿里云CLI。

• macOS：在macOS上安装阿里云CLI。

您也可使用阿里云提供的云命令行Cloud Shell调试阿里云CLI命令。关于云命令行的更多信息，请参见什么是云命令行。

步骤二：配置阿里云CLI

重要

为保证账号安全，建议您创建专用于API访问的RAM用户并获取身份凭证。更多关于凭证的安全使用建议，请参见凭证的安全使用方案。

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

1. 您需要创建一个RAM用户并根据需要授予管理对应产品的权限。具体操作，请参见创建RAM用户及为RAM用户授权。

2. 创建RAM用户并授权后，您需要创建RAM用户对应的AccessKey，并记录AccessKey ID和AccessKey Secret，以便后续配置身份凭证使用。具体操作，请参见创建AccessKey。

3. 您需要获取并记录可用的地域ID，以便后续配置身份凭证使用。阿里云CLI将使用您指定的地域发起API调用，可用地域请参见地域和可用区列表。

   说明

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

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

步骤三：生成CLI命令

说明

OpenAPI门户可以在线生成阿里云CLI所有命令，建议您通过此方式获取需要的命令示例。若您需要更详细的操作步骤，请参见生成命令。

在API调试界面左侧搜索框中可搜索您需要使用的API。在参数配置中根据API文档信息填写参数，单击参数配置右侧的CLI示例页签即可生成携带参数的命令示例。

• 单击运行命令

  

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

• 单击复制

  

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

  • 复制CLI示例到本地Shell工具中进行调试时请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息，请参见参数格式说明。

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

步骤四：调用API

命令结构

阿里云CLI的通用命令行结构如下。更多详情，请参见命令结构。

aliyun <command> <subcommand> [options and parameters]

常用命令选项

在阿里云CLI中，您可根据需要使用命令行选项，用来修改命令的默认行为或为命令提供额外功能。常用命令行选项如下：

• --profile <profileName>：使用--profile选项并指定有效配置名称profileName后，阿里云CLI将忽略默认身份凭证配置及环境变量设置，优先使用指定的配置进行命令调用。

• --help：在需要获取帮助的命令层级处键入--help选项，即可获取该命令的帮助信息。更多详情，请参见获取帮助信息。

更多详细信息，请参见API命令可用选项。

调用命令

生成命令后，可复制命令示例并粘贴到Shell工具中运行命令。以如下命令为例，调用云服务器 ECS中的CreateInstance命令，创建一台按量付费ECS实例。

aliyun ecs CreateInstance
    --InstanceName myvm1
    --ImageId centos_7_03_64_40G_alibase_20170625.vhd
    --InstanceType ecs.n4.small
    --SecurityGroupId sg-xxxxxx123
    --VSwitchId vsw-xxxxxx456
    --InternetChargeType PayByTraffic
    --Password xxx