生成并調(diào)用命令
阿里云CLI支持多款阿里云產(chǎn)品，本文將向您展示如何使用阿里云CLI命令調(diào)用常用API，以及如何在OpenAPI門(mén)戶中生成CLI命令示例。
前置準(zhǔn)備
部分 API 涉及資源計(jì)費(fèi)，請(qǐng)?jiān)谶M(jìn)行調(diào)試命令之前確保已經(jīng)開(kāi)通所需的云產(chǎn)品，并了解該產(chǎn)品的計(jì)費(fèi)規(guī)則以及產(chǎn)品OpenAPI的使用方式。
在本地調(diào)試命令之前，請(qǐng)確保您已經(jīng)安裝阿里云CLI并正確配置身份憑證信息，詳情請(qǐng)參見(jiàn)安裝指南及配置憑證。
您可在OpenAPI門(mén)戶中通過(guò)產(chǎn)品名獲取產(chǎn)品的全部API文檔以及對(duì)應(yīng)阿里云CLI命令示例。具體操作請(qǐng)參見(jiàn)生成命令。
生成命令
OpenAPI門(mén)戶可以在線生成阿里云CLI所有命令，建議您通過(guò)此方式獲取需要的命令示例。
步驟一：登錄OpenAPI門(mén)戶
步驟二：查找需生成示例的API
OpenAPI門(mén)戶提供了多種搜索API方式，您可以選擇任意方式完成操作。
搜索API名稱
不同云產(chǎn)品可能存在相同名稱的API，請(qǐng)您注意甄別，以防誤操作造成損失。
在OpenAPI門(mén)戶首頁(yè)搜索框或頂部搜索框中輸入目標(biāo)API名稱，單擊去調(diào)試即可跳轉(zhuǎn)至API調(diào)試界面。
搜索API所屬云產(chǎn)品
在OpenAPI門(mén)戶首頁(yè)搜索框或頂部搜索框中輸入目標(biāo)API所屬云產(chǎn)品信息，單擊查看API即可跳轉(zhuǎn)至云產(chǎn)品主頁(yè)。
您也可在OpenAPI門(mén)戶頂部導(dǎo)航欄中單擊選擇云產(chǎn)品，搜索目標(biāo)API所屬云產(chǎn)品信息并跳轉(zhuǎn)至云產(chǎn)品主頁(yè)。
進(jìn)入云產(chǎn)品主頁(yè)后，單擊右上角去調(diào)試，即可跳轉(zhuǎn)至該產(chǎn)品API調(diào)試界面。
步驟三：生成CLI命令示例
在API調(diào)試界面左側(cè)搜索框中可搜索您需要使用的API。在參數(shù)配置中根據(jù)API文檔信息填寫(xiě)參數(shù)，單擊參數(shù)配置右側(cè)的CLI示例標(biāo)簽頁(yè)即可生成攜帶參數(shù)的命令示例。
單擊運(yùn)行命令
按鈕，可喚出云命令行并快速完成命令調(diào)試。單擊復(fù)制
按鈕，將CLI示例復(fù)制到剪貼板中，可粘貼至本地Shell工具中運(yùn)行。復(fù)制CLI示例到本地Shell工具中進(jìn)行調(diào)試時(shí)請(qǐng)注意參數(shù)格式。關(guān)于阿里云CLI命令參數(shù)使用格式的詳細(xì)信息，請(qǐng)參見(jiàn)參數(shù)格式說(shuō)明。
OpenAPI門(mén)戶生成示例中會(huì)默認(rèn)添加
--region選項(xiàng)，復(fù)制命令到本地調(diào)用時(shí)阿里云CLI將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息，優(yōu)先使用指定的地域調(diào)用命令，您可根據(jù)需要對(duì)該選項(xiàng)進(jìn)行刪除或保留。
調(diào)用示例
以下代碼示例將為您展示如何使用阿里云CLI調(diào)用云服務(wù)器 ECS中的CreateInstance命令，創(chuàng)建一臺(tái)按量付費(fèi)ECS實(shí)例。獲取更多阿里云CLI命令，請(qǐng)參見(jiàn)生成命令。
執(zhí)行命令。
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輸出結(jié)果。
{ "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****", "InstanceId": "i-bp67acfmxazb4p****", "OrderId": "1234567890", "TradePrice": 0.165 }您可以通過(guò)OpenAPI、SDK或者云服務(wù)器 ECS控制臺(tái)等方式，檢查操作是否正確完成。