CLI参考_API 网关(API Gateway)-阿里云帮助中心

阿里云命令行工具（Alibaba Cloud Command Line Interface）是在Alibaba Cloud SDK for Go之上构建的开源工具。您可以在命令行Shell中，使用aliyun命令与API 网关进行交互，管理您的API 网关资源。

前提条件

如果使用RAM用户或RAM角色使用CLI调用API网关，请确认RAM用户或RAM角色已拥有相关资源的访问权限。更多信息，请参见基于身份的策略。

登录API网关调试-入口。
在API调试界面左侧搜索框中可搜索您需要使用的API。在参数配置中根据API文档信息填写参数，单击参数配置右侧的CLI示例标签页即可生成携带参数的命令示例。
- 单击运行命令按钮，可唤出云命令行并快速完成命令调试。
- 单击复制按钮，将CLI示例复制到剪贴板中，可粘贴至本地Shell工具中运行。
  - 复制CLI示例到本地Shell工具中进行调试时请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息，请参见参数格式说明。
  - OpenAPI门户生成示例中会默认添加--region选项，复制命令到本地调用时阿里云CLI将忽略默认身份凭证配置及环境变量设置中的地域信息，优先使用指定的地域调用命令，您可根据需要对该选项进行删除或保留。

CLI的基本使用方法，请参见调用RPC API和RESTful API。在使用API 网关前，您还需要了解API 网关的API概览及各API的请求参数、返回参数等信息。

说明

对于API中不同类型的字段，请遵循阿里云CLI的参数格式要求。更多信息，请参见参数格式说明。

下面以2个样例说明如何使用CLI调用API。

查询region是杭州下的共享实例/Serverless实例/专享实例详情
```
aliyun cloudapi DescribeInstances --region cn-hangzhou
```

查询API分组的详情

aliyun cloudapi DescribeApiGroup --region cn-hangzhou --GroupId 2d6e4d64c*******

当您需要使用CLI调用API完成相对复杂的任务时，建议将CLI整理成Shell脚本后再执行，可以提高效率。