CLI集成示例
阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構建的通用命令行工具,您可以通過阿里云CLI實現自動化管理和維護云原生數據倉庫 AnalyticDB MySQL 版。本文將為您介紹使用阿里云CLI調用云原生數據倉庫 AnalyticDB MySQL 版的操作步驟和示例。
前置概念
閱讀本文前,若您還不了解阿里云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用戶授予
AliyunADBFullAccess
權限策略,在實際使用時,請根據業務情況按需分配權限后進行接口調用。AnalyticDB for MySQL的權限策略,請參見云原生數據倉庫AnalyticDB MySQL版系統權限策略參考。創建RAM用戶并授權后,您需要創建RAM用戶對應的AccessKey,并記錄
AccessKey ID
和AccessKey Secret
,以便后續配置身份憑證使用。具體操作,請參見創建AccessKey。您需要獲取并記錄可用的地域ID,以便后續配置身份憑證使用。阿里云CLI將使用您指定的地域發起API調用。企業版、基礎版或湖倉版可用地域請參見服務接入點。
說明使用阿里云CLI過程中您可使用
--region
選項指定地域發起命令調用,該選項在使用時將忽略默認身份憑證配置及環境變量設置中的地域信息。詳情請參見API命令可用選項。使用RAM用戶的AccessKey配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請參見配置示例。
生成CLI命令示例
登錄企業版、基礎版或湖倉版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命令可用選項。
調用示例
以下示例將為您展示如何使用阿里云CLI調用AnalyticDB for MySQL中的DescribeDBClusterAttribute
命令,查詢指定企業版、基礎版或湖倉版集群的信息。DescribeDBClusterAttribute
命令的詳細介紹,請參見DescribeDBClusterAttribute。
執行命令。
aliyun adb DescribeDBClusterAttribute --region cn-hangzhou --DBClusterId 'amv-bp15yg4o68****' --version 2021-12-01 --method POST --force
輸出結果。
{ "Items": { "DBCluster": [ { "ClickhouseEngineCacheSize": -1, "ClickhouseEngineEnabled": false, "CommodityCode": "ads", "ComputeResource": "0ACU", "ComputeResourceTotal": "0ACU", "ConnectionString": "amv-bp15yg4o68****.ads.aliyuncs.com", "CreationTime": "2024-09-26T05:25:46Z", "DBClusterDescription": "amv-bp15yg4o68****", "DBClusterId": "amv-bp15yg4o68****", "DBClusterNetworkType": "VPC", "DBClusterStatus": "Running", "DBClusterType": "Common", "DBVersion": "5.0", "Engine": "3.2.2.2", "EngineVersion": "3.2.2.2", "ExpireTime": "", "KmsId": "", "LockMode": "Unlock", "LockReason": "", "MaintainTime": "15:00Z-16:00Z", "Mode": "flexible", "PayType": "Postpaid", "Port": "3306", "ProductForm": "IntegrationForm", "ProductVersion": "EnterpriseVersion", "RegionId": "cn-hangzhou", "ReservedACU": "0ACU", "ReservedNodeCount": 3, "ReservedNodeSize": "8ACU", "ResourceGroupId": "rg-acfmz7u4zzrngoa", "StorageResource": "24ACU", "StorageResourceTotal": "24ACU", "SupportedFeatures": { "AutoMC": true, "ClickhouseEngine": true }, "UserENIStatus": false, "VPCId": "vpc-bp15lqdl91m0fdc****", "VSwitchId": "vsw-bp1k9jdi0yznq****", "ZoneId": "cn-hangzhou-k" } ] }, "RequestId": "C42A167C-620C-5CF4-B016-663E3****" }