CLI整合樣本 - Tair (Redis® OSS-Compatible)

阿里雲CLI（Alibaba Cloud Command Line Interface）是基於OpenAPI構建的通用命令列工具。該工具與Tair (Redis OSS-compatible)的OpenAPI一一對應，您可以使用該工具管理阿里雲產品Tair (Redis OSS-compatible)執行個體。本文將為您示範通過阿里雲CLI查詢指定地區下的Tair (Redis OSS-compatible)執行個體列表。

前置概念

閱讀本文前，若您還不瞭解阿里雲CLI，請參見什麼是阿里雲CLI。

當您需要使用CLI調用API完成相對複雜的任務時，建議將CLI整理成Shell指令碼後再執行，以提高效率。

建立RAM使用者並完成授權

如您已建立RAM使用者且已完成授權，可跳過此步驟。

建立RAM使用者：
1. 訪問RAM使用者列表，單擊建立使用者。
2. 設定登入名稱稱為redis-openapi-operator，選擇訪問方式為使用永久 AccessKey 訪問。
3. 單擊確定，建立RAM使用者並儲存AccessKey ID與AccessKey Secret資訊。
完成授權：
1. 訪問RAM使用者列表，單擊目標RAM使用者操作列的添加許可權。
2. 在文字框中搜尋AliyunKvstore，選擇AliyunKvstoreReadOnlyAccess策略。
  說明
  AliyunKvstoreReadOnlyAccess策略擁有查詢Tair執行個體的操作許可權，您也可以按需選擇AliyunKvstoreFullAccess許可權（具有查詢、修改Tair執行個體的完全控制許可權）或進行自訂策略，更多資訊請參見身份管理。
3. 單擊確認新增授權，完成授權操作。

安裝阿里雲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
}