前置概念

閱讀本文前，若您還不了解阿里云CLI，請參見什么是阿里云CLI。

當(dāng)您需要使用CLI調(diào)用API完成相對復(fù)雜的任務(wù)時，建議將CLI整理成Shell腳本后再執(zhí)行，以提高效率。

創(chuàng)建RAM用戶并完成授權(quán)

如您已創(chuàng)建RAM用戶且已完成授權(quán)，可跳過此步驟。

1. 創(chuàng)建RAM用戶：

   1. 訪問RAM用戶列表，單擊創(chuàng)建用戶。

   2. 設(shè)置登錄名稱為redis-openapi-operator，選擇訪問方式為使用永久 AccessKey 訪問。

   3. 單擊確定，創(chuàng)建RAM用戶并保存AccessKey ID與AccessKey Secret信息。

2. 完成授權(quán)：

   1. 訪問RAM用戶列表，單擊目標(biāo)RAM用戶操作列的添加權(quán)限。

   2. 在文本框中搜索AliyunKvstore，選擇AliyunKvstoreReadOnlyAccess策略。

      說明

      AliyunKvstoreReadOnlyAccess策略擁有查詢Tair實(shí)例的操作權(quán)限，您也可以按需選擇AliyunKvstoreFullAccess權(quán)限（具有查詢、修改Tair實(shí)例的完全控制權(quán)限）或進(jìn)行自定義策略，更多信息請參見身份管理。

   3. 單擊確認(rèn)新增授權(quán)，完成授權(quán)操作。

安裝阿里云CLI

• 在Windows上安裝阿里云CLI

• 在Linux上安裝阿里云CLI

• 在macOS上安裝阿里云CLI

您也可使用阿里云提供的云命令行Cloud Shell調(diào)試阿里云CLI命令。關(guān)于云命令行的更多信息，請參見什么是云命令行？。

生成CLI命令

1. 訪問DescribeInstancesOverview，進(jìn)入該接口在OpenAPI門戶的調(diào)試地址。

2. 在左側(cè)的參數(shù)配置頁簽，填寫需要的參數(shù)信息，本示例需在RegionId參數(shù)中輸入cn-hangzhou。

3. 單擊右側(cè)的CLI示例頁簽，即可生成攜帶參數(shù)的命令示例。

   

   • 單擊運(yùn)行命令按鈕，可喚出云命令行Cloud Shell并在其中快速完成命令調(diào)試。

   • 單擊復(fù)制按鈕，將CLI示例復(fù)制到剪貼板中，可粘貼至本地Shell工具中運(yùn)行。

     說明

     • 將CLI示例復(fù)制到本地Shell工具中進(jìn)行調(diào)試時，請注意參數(shù)格式。關(guān)于阿里云CLI命令參數(shù)使用格式的詳細(xì)信息，請參見參數(shù)格式說明。

     • 將命令復(fù)制到本地調(diào)用時，阿里云CLI將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息，優(yōu)先使用指定的地域調(diào)用命令，您可根據(jù)需要對該選項(xiàng)進(jìn)行刪除或保留。OpenAPI門戶生成示例中會默認(rèn)添加--region選項(xiàng)。

調(diào)用示例

以下代碼示例將為您展示如何使用阿里云CLI調(diào)用DescribeInstancesOverview接口，查詢?nèi)A東1（杭州、cn-hangzhou）地域中的實(shí)例列表。獲取更多阿里云CLI命令，請參見生成命令。

1. 執(zhí)行命令。

   aliyun r-kvstore DescribeInstancesOverview --region cn-hangzhou --RegionId 'cn-hangzhou'

2. 輸出結(jié)果。

   {
           "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
   }