阿里云命令行工具(Alibaba Cloud Command Line Interface)是基于OpenAPI建立的通用命令行工具。您可以在命令行Shell
中,使用aliyun
命令与云原生API网关进行交互,管理您的云原生API网关资源。
前提条件
已安装阿里云CLI。具体操作,请参见以下文档:
已配置阿里云CLI。具体操作,请参见配置凭证。
云命令行(Cloud Shell)中预装了阿里云CLI,且自动为您配置身份凭证,无需手动操作。您可在云命令行中调试阿里云CLI命令。更多信息,请参见什么是云命令行。
权限说明
如果使用RAM用户或RAM角色通过CLI调用云原生API网关,请确认RAM用户或RAM角色已拥有相关资源的访问权限。更多信息,请参见基于身份的策略。
生成CLI命令示例
在API调试界面左侧搜索框中可搜索您需要使用的API。在参数配置中根据API文档信息填写参数,单击CLI示例页签即可生成携带参数的命令示例。
单击运行命令按钮,可唤出云命令行并快速完成命令调试。
单击复制按钮,将CLI示例复制到剪贴板中,可粘贴至本地Shell工具中运行。
复制CLI示例到本地Shell工具中进行调试时请注意参数格式。关于阿里云CLI命令参数使用格式的详细信息,请参见参数格式说明。
OpenAPI门户生成示例中会默认添加
--region
选项,复制命令到本地调用时阿里云CLI将忽略默认身份凭证配置及环境变量设置中的地域信息,优先使用指定的地域调用命令,您可根据需要对该选项进行删除或保留。
使用CLI调用云原生API网关
阿里云CLI的基本使用方法,请参见调用RPC API和RESTful API。在使用前,您还需要了解云原生API网关OpenAPI的请求参数、返回参数等信息。更多信息,请参见API概览。
对于API中不同类型的字段,请遵循阿里云CLI的参数格式要求。更多信息,请参见参数格式说明。
下面以2个样例说明如何使用阿里云CLI调用API。
根据HTTP API类型及云原生API网关ID查询HTTP API列表
aliyun apig GET /v1/http-apis --types 'Http,Rest' --gatewayId 'gw-cq2avtllh****'
获取网关的所属VPC、所属交换机、网关入口等基本信息
aliyun apig GET /v1/gateways/gw-cpv4sqdl*****
使用建议
当您需要使用CLI调用API完成相对复杂的任务时,建议将CLI整理成Shell脚本后再执行,可以提高效率。