CLI集成示例
阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構(gòu)建的通用命令行工具,您可以通過阿里云CLI實現(xiàn)自動化管理和維護(hù)CDN。本文將為您介紹使用阿里云CLI調(diào)用CDN的操作步驟和示例。
前置概念
閱讀本文前,若您還不了解阿里云CLI,請參見什么是阿里云CLI。
安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統(tǒng)下的安裝服務(wù),請根據(jù)您使用設(shè)備的操作系統(tǒng)選擇對應(yīng)的安裝服務(wù)。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
您也可使用阿里云提供的云命令行Cloud Shell調(diào)試阿里云CLI命令。關(guān)于云命令行的更多信息,請參閱什么是云命令行。
配置阿里云CLI
阿里云賬號(主賬號)擁有所有產(chǎn)品API的管理和訪問權(quán)限,風(fēng)險很高。強(qiáng)烈建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問或日常運維。
使用阿里云CLI之前,您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證,詳情請參見身份憑證類型。本文操作以AK類型憑證為例,具體操作步驟如下:
您需要創(chuàng)建一個RAM用戶并授予相應(yīng)操作權(quán)限。具體操作,請參見創(chuàng)建RAM用戶及為RAM用戶授權(quán)。
重要本示例需要您為RAM用戶授予
AliyunCDNReadOnlyAccess
權(quán)限策略。您也可以按需選擇AliyunCDNFullAccess
權(quán)限(具有查詢、修改CDN域名的完全控制權(quán)限)或進(jìn)行自定義策略,更多信息請參見CDN自定義權(quán)限策略參考。創(chuàng)建RAM用戶并授權(quán)后,您需要創(chuàng)建RAM用戶對應(yīng)的AccessKey,并記錄
AccessKey ID
和AccessKey Secret
,以便后續(xù)配置身份憑證使用。具體操作,請參見創(chuàng)建AccessKey。您需要獲取并記錄可用的地域ID,以便后續(xù)配置身份憑證使用。阿里云CLI將使用您指定的地域發(fā)起API調(diào)用,可用地域請參見請求結(jié)構(gòu)。
說明使用阿里云CLI過程中您可使用
--region
選項指定地域發(fā)起命令調(diào)用,該選項在使用時將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息。詳情請參見API命令可用選項。使用RAM用戶的AccessKey配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請參見服務(wù)接入點。
生成CLI命令示例
在API調(diào)試界面左側(cè)搜索框中可搜索您需要使用的API。在參數(shù)配置中根據(jù)API文檔信息填寫參數(shù),單擊參數(shù)配置右側(cè)的CLI示例頁簽即可生成攜帶參數(shù)的命令示例。
單擊按鈕,可喚出云命令行Cloud Shell并在其中快速完成命令調(diào)試。
單擊按鈕,將CLI示例復(fù)制到剪貼板中,可粘貼至本地Shell工具中運行。
復(fù)制CLI示例到本地Shell工具中進(jìn)行調(diào)試時請注意參數(shù)格式。關(guān)于阿里云CLI命令參數(shù)使用格式的詳細(xì)信息,請參見參數(shù)格式說明。
OpenAPI門戶生成示例中會默認(rèn)添加
--region
選項,復(fù)制命令到本地調(diào)用時阿里云CLI將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息,優(yōu)先使用指定的地域調(diào)用命令,您可根據(jù)需要對該選項進(jìn)行刪除或保留。
調(diào)用API
命令結(jié)構(gòu)
阿里云CLI的通用命令行結(jié)構(gòu)如下。更多詳情,請參見命令結(jié)構(gòu)。
aliyun <command> <subcommand> [options and parameters]
常用命令選項
在阿里云CLI中,您可根據(jù)需要使用命令行選項,用來修改命令的默認(rèn)行為或為命令提供額外功能。常用命令行選項如下:
--profile <profileName>
:使用--profile
選項并指定有效配置名稱profileName
后,阿里云CLI將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置,優(yōu)先使用指定的配置進(jìn)行命令調(diào)用。--help
:在需要獲取幫助的命令層級處鍵入--help
選項,即可獲取該命令的幫助信息。更多詳情,請參見獲取幫助信息。
更多詳細(xì)信息,請參見API命令可用選項。
調(diào)用示例
以下示例將為您展示如何使用阿里云CLI調(diào)用CDN中的DescribeUserDomains
命令,查詢用戶名下所有的域名與狀態(tài)。DescribeUserDomains
命令的詳細(xì)介紹,請參見DescribeUserDomains。
執(zhí)行命令。
輸出結(jié)果。
如果調(diào)用CDNAPI后返回錯誤,您需要根據(jù)返回的錯誤碼提示檢查傳入的請求參數(shù)及其取值是否正確。
您也可以記錄下調(diào)用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進(jìn)行自助診斷。