阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構建的通用命令行工具,您可以通過阿里云CLI實現自動化管理和維護系統運維管理。本文將為您介紹使用阿里云CLI調用系統運維管理的操作步驟和示例。
前置概念
閱讀本文前,若您還不了解阿里云CLI,請參見什么是阿里云CLI。
安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統下的安裝服務,請根據您使用設備的操作系統選擇對應的安裝服務。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
您也可使用阿里云提供的云命令行Cloud Shell調試阿里云CLI命令。關于云命令行的更多信息,請參見什么是云命令行。
配置阿里云CLI
阿里云主賬號擁有所有產品API的管理和訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。
使用阿里云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命令示例
在API調試界面左側搜索框中可搜索您需要使用的API。在參數配置中根據API文檔信息填寫參數,單擊參數配置右側的CLI示例頁簽即可生成攜帶參數的命令示例。
調用API
命令結構
阿里云CLI的通用命令行結構如下。更多詳情,請參見命令結構。
aliyun <command> <subcommand> [options and parameters]
常用命令選項
在阿里云CLI中,您可根據需要使用命令行選項,用來修改命令的默認行為或為命令提供額外功能。常用命令行選項如下:
--profile <profileName>
:使用--profile
選項并指定有效配置名稱profileName
后,阿里云CLI將忽略默認身份憑證配置及環境變量設置,優先使用指定的配置進行命令調用。--help
:在需要獲取幫助的命令層級處鍵入--help
選項,即可獲取該命令的幫助信息。更多詳情,請參見獲取幫助信息。
更多詳細信息,請參見API命令可用選項。
調用示例
示例一:以下代碼示例將為您展示如何使用--help
選項獲取系統運維管理支持阿里云CLI調用API列表。您也可在API概覽中查看支持調用的API。
執行命令。
aliyun oos --help
輸出結果。
示例二:以下代碼示例將為您展示如何使用阿里云CLI調用系統運維管理中的CreateTemplate
命令,創建一個模板CLI_Template
。
執行命令。
說明String類型JSON數組列表參數值的傳入格式在不同操作系統中存在差異,請您根據操作系統選擇對應的命令。更多格式信息,請參見參數格式說明。
Linux/macOS
aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content '{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}'
Windows
aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content "{'FormatVersion': 'OOS-2019-06-01', 'Description': 'Describe instances of given status', 'Parameters': {'Status': {'Type': 'String', 'Description': '(Required) The status of the Ecs instance.'}}, 'Tasks': [{'Properties': {'Parameters': {'Status': '{{ Status }}'}, 'API': 'DescribeInstances', 'Service': 'Ecs'}, 'Name': 'foo', 'Action': 'ACS::ExecuteApi'}]}"
輸出結果。
{ "RequestId": "989F0944-E653-5826-9FA7-8ADE6E66F485", "Template": { "Description": "Describe instances of given status", "CreatedBy": "test(2039927162697*****)", "TemplateFormat": "JSON", "ResourceGroupId": "rg-acfmykd6*****", "UpdatedDate": "2024-08-05T10:28:24Z", "TemplateVersion": "v1", "Hash": "8abc5921b5a05051992*****", "UpdatedBy": "test(2039927162697*****)", "HasTrigger": false, "CreatedDate": "2024-08-05T10:28:24Z", "TemplateName": "CLI_Template", "Tags": {}, "TemplateId": "t-9246d5246f*****", "ShareType": "Private" } }
說明如果調用系統運維管理API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。
您也可以記錄下調用返回的RequestID或報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。