使用阿里云CLI調用OpenAPI
本文將為您介紹使用阿里云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三種操作系統下的安裝服務,請根據您使用設備的操作系統選擇對應的安裝服務。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
您也可使用阿里云提供的云命令行Cloud Shell調試阿里云CLI命令。關于云命令行的更多信息,請參見什么是云命令行。
步驟二:配置阿里云CLI
為保證賬號安全,建議您創建專用于API訪問的RAM用戶并獲取身份憑證。更多關于憑證的安全使用建議,請參見憑證的安全使用方案。
使用阿里云CLI之前,您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證,詳情請參見身份憑證類型。本文操作以AK類型憑證為例,具體操作步驟如下:
創建RAM用戶并授權后,您需要創建RAM用戶對應的AccessKey,并記錄
AccessKey ID
和AccessKey Secret
,以便后續配置身份憑證使用。具體操作,請參見創建AccessKey。您需要獲取并記錄可用的地域ID,以便后續配置身份憑證使用。阿里云CLI將使用您指定的地域發起API調用,可用地域請參見地域和可用區列表。
說明使用阿里云CLI過程中您可使用
--region
選項指定地域發起命令調用,該選項在使用時將忽略默認身份憑證配置及環境變量設置中的地域信息。詳情請參見API命令可用選項。使用RAM用戶的AccessKey配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請參見配置示例。
步驟三:生成CLI命令
在API調試界面左側搜索框中可搜索您需要使用的API。在參數配置中根據API文檔信息填寫參數,單擊參數配置右側的CLI示例頁簽即可生成攜帶參數的命令示例。
步驟四:調用API
命令結構
阿里云CLI的通用命令行結構如下。更多詳情,請參見命令結構。
aliyun <command> <subcommand> [options and parameters]
常用命令選項
在阿里云CLI中,您可根據需要使用命令行選項,用來修改命令的默認行為或為命令提供額外功能。常用命令行選項如下:
--profile <profileName>
:使用--profile
選項并指定有效配置名稱profileName
后,阿里云CLI將忽略默認身份憑證配置及環境變量設置,優先使用指定的配置進行命令調用。--help
:在需要獲取幫助的命令層級處鍵入--help
選項,即可獲取該命令的幫助信息。更多詳情,請參見獲取幫助信息。
更多詳細信息,請參見API命令可用選項。
調用命令
生成命令后,可復制命令示例并粘貼到Shell工具中運行命令。以如下命令為例,調用云服務器 ECS中的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集成示例。