CLI集成示例
阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構建的通用命令行工具,您可以通過阿里云CLI實現自動化管理和維護云SSO。本文將為您介紹云SSO管理員使用阿里云CLI調用云SSO的操作步驟和示例。
前置概念
閱讀本文前,若您還不了解阿里云CLI,請參見什么是阿里云CLI。
安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統下的安裝服務,請根據您使用設備的操作系統選擇對應的安裝服務。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
您也可使用阿里云提供的云命令行Cloud Shell調試阿里云CLI命令。關于云命令行的更多信息,請參見什么是云命令行。
配置阿里云CLI
具體操作步驟,請參見使用CLI登錄云SSO并訪問阿里云資源。
生成CLI命令示例
登錄云SSO API調試列表。
在API調試界面左側搜索框中可搜索您需要使用的API。在參數配置中根據API文檔信息填寫參數,單擊參數配置右側的CLI示例頁簽即可生成攜帶參數的命令示例。
單擊運行命令按鈕,可喚出云命令行Cloud Shell并在其中快速完成命令調試。
單擊復制按鈕,將CLI示例復制到剪貼板中,可粘貼至本地Shell工具中運行。
復制CLI示例到本地Shell工具中進行調試時請注意參數格式。關于阿里云CLI命令參數使用格式的詳細信息,請參見參數格式說明。
OpenAPI門戶生成示例中會默認添加
--region
選項,復制命令到本地調用時阿里云CLI將忽略默認身份憑證配置及環境變量設置中的地域信息,優先使用指定的地域調用命令,您可根據需要對該選項進行刪除或保留。
調用API
命令結構
阿里云CLI的通用命令行結構如下。更多詳情,請參見命令結構。
aliyun <command> <subcommand> [options and parameters]
常用命令選項
在阿里云CLI中,您可根據需要使用命令行選項,用來修改命令的默認行為或為命令提供額外功能。常用命令行選項如下:
--profile <profileName>
:使用--profile
選項并指定有效配置名稱profileName
后,阿里云CLI將忽略默認身份憑證配置及環境變量設置,優先使用指定的配置進行命令調用。--help
:在需要獲取幫助的命令層級處鍵入--help
選項,即可獲取該命令的幫助信息。更多詳情,請參見獲取幫助信息。
更多詳細信息,請參見API命令可用選項。
調用示例
示例一:以下代碼示例將為您展示如何使用--help
選項獲取云SSO支持阿里云CLI調用API列表。您也可在API概覽中查看支持調用的API。
執行命令。
aliyun cloudsso --help
輸出結果。
示例二:以下代碼示例將為您展示如何使用阿里云CLI調用云SSO中的CreateUser
命令,創建一個云SSO用戶Alice
。
執行命令。
aliyun cloudsso CreateUser --region cn-shanghai --DirectoryId 'd-00fc2p61****' --UserName Alice
輸出結果。
{ "User": { "Status": "Enabled", "UserName": "Alice", "Email": "", "Description": "", "UserId": "u-004ds*************", "FirstName": "", "CreateTime": "2024-05-16T10:49:27Z", "ProvisionType": "Manual", "DisplayName": "", "UpdateTime": "2024-05-16T10:49:27Z", "LastName": "" }, "RequestId": "E5D5256C-3981-5EB8-AB9C-30DF641D4DC9" }
說明如果調用云SSO API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。