前提條件

1. 已安裝阿里云CLI。具體操作，請參見以下文檔：

   • 在Windows上安裝阿里云CLI

   • 在Linux上安裝阿里云CLI

   • 在macOS上安裝阿里云CLI

2. 已配置阿里云CLI。具體操作，請參見配置憑證。

權限說明

如果使用RAM用戶或RAM角色使用CLI調用API網關，請確認RAM用戶或RAM角色已擁有相關資源的訪問權限。更多信息，請參見基于身份的策略。

生成CLI命令示例

1. 登錄API網關調試-入口。

2. 在API調試界面左側搜索框中可搜索您需要使用的API。在參數配置中根據API文檔信息填寫參數，單擊參數配置右側的CLI示例標簽頁即可生成攜帶參數的命令示例。

   

   • 單擊運行命令按鈕，可喚出云命令行并快速完成命令調試。

   • 單擊復制按鈕，將CLI示例復制到剪貼板中，可粘貼至本地Shell工具中運行。

     • 復制CLI示例到本地Shell工具中進行調試時請注意參數格式。關于阿里云CLI命令參數使用格式的詳細信息，請參見參數格式說明。

     • OpenAPI門戶生成示例中會默認添加--region選項，復制命令到本地調用時阿里云CLI將忽略默認身份憑證配置及環境變量設置中的地域信息，優先使用指定的地域調用命令，您可根據需要對該選項進行刪除或保留。

使用CLI調用API 網關

CLI的基本使用方法，請參見調用RPC API和RESTful API。在使用API 網關前，您還需要了解API 網關的API概覽及各API的請求參數、返回參數等信息。

下面以2個樣例說明如何使用CLI調用API。

• 查詢region是杭州下的共享實例/Serverless實例/專享實例詳情

  aliyun cloudapi DescribeInstances --region cn-hangzhou

• 查詢API分組的詳情

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

使用建議

當您需要使用CLI調用API完成相對復雜的任務時，建議將CLI整理成Shell腳本后再執行，可以提高效率。