文档

CLI参考

更新时间:

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

前提条件

  1. 已安装阿里云CLI。具体操作,请参见以下文档:

  2. 已配置阿里云CLI。具体操作,请参见配置凭证

权限说明

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

使用CLI调用API 网关

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

说明

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

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

  • 查询region是杭州下的共享实例/专享实例详情

    aliyun cloudapi DescribeInstances --region cn-hangzhou
  • 查询API分组的详情

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

使用建议

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