阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構建的通用命令行工具。該工具與云數據庫 Tair(兼容 Redis)的OpenAPI一一對應,您可以使用該工具管理阿里云產品云數據庫 Tair(兼容 Redis)實例。本文將為您演示通過阿里云CLI查詢指定地域下的云數據庫 Tair(兼容 Redis)實例列表。
前置概念
閱讀本文前,若您還不了解阿里云CLI,請參見什么是阿里云CLI。
當您需要使用CLI調用API完成相對復雜的任務時,建議將CLI整理成Shell腳本后再執行,以提高效率。
創建RAM用戶并完成授權
如您已創建RAM用戶且已完成授權,可跳過此步驟。
創建RAM用戶:
訪問RAM用戶列表,單擊創建用戶。
設置登錄名稱為redis-openapi-operator,選擇訪問方式為OpenAPI 調用訪問。
單擊確定,創建RAM用戶并保存AccessKey ID與AccessKey Secret信息。
完成授權:
安裝阿里云CLI
您也可使用阿里云提供的云命令行Cloud Shell調試阿里云CLI命令。關于云命令行的更多信息,請參見什么是云命令行?。
生成CLI命令
訪問DescribeInstancesOverview,進入該接口在OpenAPI門戶的調試地址。
在左側的參數配置頁簽,填寫需要的參數信息,本示例需在RegionId參數中輸入cn-hangzhou。
單擊右側的CLI示例頁簽,即可生成攜帶參數的命令示例。
單擊運行命令按鈕,可喚出云命令行Cloud Shell并在其中快速完成命令調試。
單擊復制按鈕,將CLI示例復制到剪貼板中,可粘貼至本地Shell工具中運行。
說明將CLI示例復制到本地Shell工具中進行調試時,請注意參數格式。關于阿里云CLI命令參數使用格式的詳細信息,請參見參數格式說明。
將命令復制到本地調用時,阿里云CLI將忽略默認身份憑證配置及環境變量設置中的地域信息,優先使用指定的地域調用命令,您可根據需要對該選項進行刪除或保留。OpenAPI門戶生成示例中會默認添加
--region
選項。
調用示例
以下代碼示例將為您展示如何使用阿里云CLI調用DescribeInstancesOverview接口,查詢華東1(杭州、cn-hangzhou)地域中的實例列表。獲取更多阿里云CLI命令,請參見生成命令。
執行命令。
aliyun r-kvstore DescribeInstancesOverview --region cn-hangzhou --RegionId 'cn-hangzhou'
輸出結果。
{ "Instances": [ { "ArchitectureType": "cluster", "Capacity": 1024, "ChargeType": "PostPaid", "ConnectionDomain": "r-bp1y****svonly41sr.redis.rds.aliyuncs.com", "CreateTime": "2023-11-27T05:42:50Z", "EngineVersion": "6.0", "InstanceClass": "tair.rdb.cluster.sharding.common", "InstanceId": "r-bp1y****svonly41sr", "InstanceName": "yaluTest", "InstanceStatus": "Normal", "InstanceType": "tair_rdb", "NetworkType": "VPC", "RegionId": "cn-hangzhou", "ResourceGroupId": "rg-acfm****zzrngoa", "VSwitchId": "vsw-bp1g****keaw3xvndvvz0", "VpcId": "vpc-bp1o****4yvz4kxeik3uu", "ZoneId": "cn-hangzhou-k" }, { "ArchitectureType": "cluster", "Capacity": 1024, "ChargeType": "PostPaid", "ConnectionDomain": "r-bp1s****lvbzmgedgj.redis.rds.aliyuncs.com", "CreateTime": "2024-03-04T05:08:46Z", "EngineVersion": "6.0", "InstanceClass": "tair.rdb.cluster.sharding.common", "InstanceId": "r-bp1s****lvbzmgedgj", "InstanceName": "LidTest", "InstanceStatus": "Normal", "InstanceType": "tair_rdb", "NetworkType": "VPC", "RegionId": "cn-hangzhou", "ResourceGroupId": "rg-acfm****zzrngoa", "VSwitchId": "vsw-bp12****3z4zu9k4dhaew", "VpcId": "vpc-bp1o****4yvz4kxeik3uu", "ZoneId": "cn-hangzhou-k" } ], "RequestId": "0E89ADAB-D582-5F49-9D7F-F482D15BE426", "TotalCount": 2 }