在OpenAPI門戶中產生CLI命令樣本 - Alibaba Cloud CLI

阿里雲CLI支援多款阿里雲產品，本文將向您展示如何使用阿里雲CLI命令調用常用API，以及如何在OpenAPI門戶中產生CLI命令樣本。

說明

重要

部分 API 涉及資源計費，請在進行調試命令之前確保已經開通所需的雲產品，並瞭解該產品的計費規則以及產品OpenAPI的使用方式。

在本地調試命令之前，請確保您已經安裝阿里雲CLI並正確配置身份憑證資訊，詳情請參見安裝指南及配置憑證。
您可在OpenAPI門戶中通過產品名擷取產品的全部API文檔以及對應阿里雲CLI命令樣本。具體操作請參見產生命令。

命令結構

在阿里雲CLI中，使用的命令列結構如下：

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

command：指定一個頂級命令。
- 可指定阿里雲CLI支援的雲產品code，例如ecs、rds等。
- 可指定阿里雲CLI本身的功能命令，例如help、configure等。

subcommand：指定要執行操作的附加子命令，即具體的某一項操作。
- 當頂級命令command為configure時，支援附加子命令請參見configure功能子命令。
- 當頂級命令command為雲產品code時，支援附加子命令為可調用的OpenAPI名稱。更多雲產品OpenAPI，請參見尋找API。

options and parameters：指定用於控制阿里雲CLI行為的選項或者API參數選項，其選項值可以是數字、字串和JSON結構字串等。更多參數格式資訊，請參見參數格式說明。
阿里雲雲產品的API分為RPC和RESTful兩種類型，大部分產品使用的是RPC風格。不同風格的API，調用方式不同。詳情請參見調用RPC API和RESTful API。

產生命令

說明

OpenAPI門戶可以線上產生阿里雲CLI所有命令，建議您通過此方式擷取需要的命令樣本。

步驟一：登入OpenAPI門戶

登入OpenAPI 門戶。

步驟二：尋找需產生樣本的API

OpenAPI門戶提供了多種搜尋API方式，您可以選擇任意方式完成操作。

搜尋API名稱

重要

不同雲產品可能存在相同名稱的API，請您注意甄別，以防誤操作造成損失。

在OpenAPI門戶首頁搜尋方塊或頂部搜尋方塊中輸入目標API名稱，單擊去調試即可跳轉至API調試介面。

搜尋API所屬雲產品

在OpenAPI門戶首頁搜尋方塊或頂部搜尋方塊中輸入目標API所屬雲產品資訊，單擊查看API即可跳轉至雲產品首頁。

您也可在OpenAPI門戶頂部導覽列中單擊選擇雲產品，搜尋目標API所屬雲產品資訊並跳轉至雲產品首頁。
進入雲產品首頁後，單擊右上方去調試，即可跳轉至該產品API調試介面。

步驟三：產生CLI命令樣本

在API調試介面左側搜尋方塊中可搜尋您需要使用的API。在參數配置中根據API文檔資訊填寫參數，單擊參數配置右側的CLI樣本標籤頁即可產生攜帶參數的命令樣本。

單擊運行命令按鈕，可喚出雲命令列並快速完成命令調試。
單擊複製按鈕，將CLI樣本複製到剪貼簿中，可粘貼至本地Shell工具中運行。
- 複製CLI樣本到本地Shell工具中進行調試時請注意參數格式。關於阿里雲CLI命令參數使用格式的詳細資料，請參見參數格式說明。
- OpenAPI門戶產生樣本中會預設添加--region選項，複製命令到本地調用時阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊，優先使用指定的地區調用命令，您可根據需要對該選項進行刪除或保留。

調用樣本

以下程式碼範例將為您展示如何使用阿里雲CLI調用Elastic Compute Service中的CreateInstance命令，建立一台隨用隨付ECS執行個體。擷取更多阿里雲CLI命令，請參見產生命令。

執行命令。

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

輸出結果。

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceId": "i-bp67acfmxazb4p****",
  "OrderId": "1234567890",
  "TradePrice": 0.165
}

您可以通過OpenAPI、SDK或者Elastic Compute Service控制台等方式，檢查操作是否正確完成。