CLI集成示例
阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構(gòu)建的通用命令行工具,您可以通過阿里云CLI實(shí)現(xiàn)自動(dòng)化管理和維護(hù)微服務(wù)引擎 MSE(Microservices Engine)。本文以調(diào)用ListTagResources
接口獲取標(biāo)簽列表為例,為您介紹使用阿里云CLI調(diào)用微服務(wù)引擎OpenAPI的操作步驟。
前置概念
閱讀本文前,建議您先了解什么是阿里云CLI。
步驟一:安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統(tǒng)下的安裝服務(wù),請(qǐng)根據(jù)您使用設(shè)備的操作系統(tǒng)選擇對(duì)應(yīng)的安裝服務(wù)。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
您也可在云命令行(Cloud Shell)中調(diào)試阿里云CLI命令。云命令行預(yù)裝了阿里云CLI,且自動(dòng)為您配置身份憑證,無需手動(dòng)操作。更多信息,請(qǐng)參見什么是云命令行。
步驟二:配置阿里云CLI
阿里云主賬號(hào)擁有所有產(chǎn)品OpenAPI的管理和訪問權(quán)限,風(fēng)險(xiǎn)很高。強(qiáng)烈建議您創(chuàng)建RAM身份,并依據(jù)最小化權(quán)限原則授予權(quán)限,使用RAM身份訪問OpenAPI。微服務(wù)引擎支持的權(quán)限策略,請(qǐng)參見微服務(wù)引擎系統(tǒng)權(quán)限策略參考及微服務(wù)引擎自定義權(quán)限策略參考。
使用阿里云CLI之前,您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證,詳情請(qǐng)參見身份憑證類型。本文以AK類型憑證為例,具體操作步驟如下:
創(chuàng)建一個(gè)RAM用戶,并創(chuàng)建AccessKey,以便后續(xù)配置身份憑證使用。具體操作,請(qǐng)參見創(chuàng)建RAM用戶及創(chuàng)建AccessKey。
為RAM用戶授權(quán)。本文示例需授予RAM用戶只讀訪問微服務(wù)引擎的權(quán)限策略
AliyunMSEReadOnlyAccess
。具體操作,請(qǐng)參見為RAM用戶授權(quán)。獲取可用的地域ID,以便后續(xù)配置身份憑證使用。阿里云CLI將使用您指定的地域發(fā)起OpenAPI調(diào)用,微服務(wù)引擎的可用地域請(qǐng)參見服務(wù)接入點(diǎn)。
說明使用阿里云CLI過程中您可使用
--region
選項(xiàng)指定地域發(fā)起命令調(diào)用,該選項(xiàng)在使用時(shí)將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息。詳情請(qǐng)參見API命令可用選項(xiàng)。使用RAM用戶的AccessKey及地域ID配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請(qǐng)參見配置示例。
步驟三:生成CLI命令示例
在OpenAPI門戶中,訪問ListTagResources調(diào)試地址。
在參數(shù)配置中輸入請(qǐng)求參數(shù),單擊CLI示例頁簽,查看生成的CLI示例。
復(fù)制CLI示例或在云命令行中快速執(zhí)行:
單擊運(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)參見參數(shù)格式說明。
OpenAPI門戶生成示例中會(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)用微服務(wù)引擎OpenAPI
示例一:獲取支持阿里云CLI調(diào)用微服務(wù)引擎OpenAPI列表
以下示例將為您展示如何使用--help
選項(xiàng)獲取支持阿里云CLI調(diào)用的微服務(wù)引擎OpenAPI列表。您也可在API概覽中查看支持調(diào)用的OpenAPI。
執(zhí)行命令。
aliyun mse --help
輸出結(jié)果。
示例二:獲取標(biāo)簽列表
以下示例將為您展示如何使用阿里云CLI調(diào)用微服務(wù)引擎的ListTagResources
命令,獲取ID為mse-cn-7pp2st2****
的資源信息及其標(biāo)簽列表。
執(zhí)行命令。
aliyun mse ListTagResources --RegionId 'cn-hangzhou' --ResourceType CLUSTER --ResourceId.1 'mse-cn-7pp2st2****'
輸出結(jié)果。
{ "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6ng3BeUyo2zbY5wgL1DBa2T", "RequestId": "92ED7C9C-84A2-595F-87FE-354F84C0F739", "Message": "請(qǐng)求處理成功", "ErrorCode": "mse-100-000", "Success": true, "TagResources": { "TagResource": [ { "ResourceId": "mse-cn-7pp2st2****", "ResourceType": "cluster", "TagValue": "prd", "TagKey": "env" } ] } }
說明如果調(diào)用微服務(wù)引擎OpenAPI后返回錯(cuò)誤,您需要根據(jù)返回的錯(cuò)誤碼提示檢查傳入的請(qǐng)求參數(shù)及其取值是否正確。
您也可以記錄下調(diào)用返回的RequestID或SDK報(bào)錯(cuò)信息,通過阿里云OpenAPI診斷平臺(tái)進(jìn)行自助診斷。