快速開始使用阿里雲CLI - Alibaba Cloud CLI

本文將為您介紹使用阿里雲CLI調用OpenAPI的具體操作流程，包括安裝、配置憑證、產生並調用命令等步驟。

方案概覽

使用阿里雲CLI調用OpenAPI，大致分為四個步驟：

安裝阿里雲CLI：根據您使用裝置的作業系統，選擇並安裝相應的版本。
配置阿里雲CLI：在阿里雲CLI中完成身份憑證的配置，主要包括AccessKey資訊以及地區資訊。阿里雲CLI將使用配置中的憑證資訊調用OpenAPI。
產生CLI命令：在OpenAPI門戶中輸入參數，產生攜帶參數的CLI命令樣本，複製粘貼到Shell工具中即可運行。
調用API：在Shell工具中輸入命令並根據需要使用命令選項，運行命令即可調用對應OpenAPI。

前提條件

使用阿里雲CLI之前，如果您還沒有帳號，請訪問阿里雲官網註冊阿里雲帳號（主帳號），同時建議您建立專用於API訪問的RAM使用者。具體操作可參見建立RAM使用者。
部分產品需要開通雲產品服務才可調用該產品OpenAPI。您可以通過以下兩種方式開通您所需要的雲產品服務，以開通簡訊服務為例：
- 可訪問開通助手一鍵開通雲產品服務。搜尋簡訊服務，選中簡訊服務，單擊一鍵開通。
- 訪問各雲產品控制台開通雲產品服務。例如在簡訊服務控制台單擊開通。
使用阿里雲CLI前，您需要確認需整合的雲產品是否支援阿里雲CLI。確認方法如下：
- 查看該雲產品文檔中心，在開發參考>整合概覽中查看阿里雲CLI支援情況。
- 在阿里雲提供的線上服務Cloud Shell中執行aliyun --help命令，擷取阿里雲CLI支援產品列表。

步驟一：安裝阿里雲CLI

使用阿里雲CLI前，您需要先安裝阿里雲CLI。阿里雲CLI為使用者提供了Windows、Linux和macOS三種作業系統下的安裝服務，請根據您使用裝置的作業系統選擇對應的安裝服務。

您也可使用阿里雲提供的雲命令列Cloud Shell調試阿里雲CLI命令。關於雲命令列的更多資訊，請參見什麼是雲命令列。

步驟二：配置阿里雲CLI

重要

為保證帳號安全，建議您建立專用於API訪問的RAM使用者並擷取身份憑證。更多關於憑證的安全使用建議，請參見憑證的安全使用方式情節。

使用阿里雲CLI之前，您需要在阿里雲CLI中配置身份憑證、地區ID等資訊。阿里雲CLI支援多種身份憑證，詳情請參見身份憑證類型。本文操作以AK類型憑證為例，具體操作步驟如下：

您需要建立一個RAM使用者並根據需要授予管理對應產品的許可權。具體操作，請參見建立RAM使用者及為RAM使用者授權。
建立RAM使用者並授權後，您需要建立RAM使用者對應的AccessKey，並記錄AccessKey ID和AccessKey Secret，以便後續配置身份憑證使用。具體操作，請參見建立AccessKey。
您需要擷取並記錄可用的地區ID，以便後續配置身份憑證使用。阿里雲CLI將使用您指定的地區發起API調用，可用地區請參見地區和可用性區域列表。
說明
使用阿里雲CLI過程中您可使用--region選項指定地區發起命令調用，該選項在使用時將忽略預設身份憑證配置及環境變數設定中的地區資訊。詳情請參見API命令可用選項。
使用RAM使用者的AccessKey配置AK類型憑證，設定檔命名為AkProfile。具體操作，請參見配置樣本。

步驟三：產生CLI命令

說明

OpenAPI門戶可以線上產生阿里雲CLI所有命令，建議您通過此方式擷取需要的命令樣本。若您需要更詳細的操作步驟，請參見產生命令。

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

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

步驟四：調用API

命令結構

阿里雲CLI的通用命令列結構如下。更多詳情，請參見命令結構。

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

常用命令選項

在阿里雲CLI中，您可根據需要使用命令列選項，用來修改命令的預設行為或為命令提供額外功能。常用命令列選項如下：

--profile <profileName>：使用--profile選項並指定有效配置名稱profileName後，阿里雲CLI將忽略預設身份憑證配置及環境變數設定，優先使用指定的配置進行命令調用。
--help：在需要擷取協助的命令層級處鍵入--help選項，即可擷取該命令的協助資訊。更多詳情，請參見擷取協助資訊。

更多詳細資料，請參見API命令可用選項。

調用命令

產生命令後，可複製命令樣本並粘貼到Shell工具中運行命令。以如下命令為例，調用Elastic Compute Service中的CreateInstance命令，建立一台隨用隨付ECS執行個體。

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

更多命令調用詳情，請參見調用樣本，或各雲產品文檔中心下的CLI整合樣本。