查詢專屬集群中的Redis實例信息。
接口說明
說明
如需查詢非專屬集群下的 Redis 實例的信息，請調用 DescribeInstanceAttribute 。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| kvstore:DescribeDedicatedClusterInstanceList | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID，您可以調用 DescribeRegions 查詢。 | cn-hangzhou |
| ZoneId | string | 否 | 可用區 ID，您可以調用 DescribeZones 查詢。 | cn-hangzhou-e |
| InstanceId | string | 否 | 實例 ID。 說明
該實例必須是通過專屬集群創建的，更多信息，請參見云數據庫專屬集群 MyBase。
| r-bp1zxszhcgatnx**** |
| InstanceStatus | integer | 否 | 實例狀態，取值：
| 1 |
| InstanceNetType | string | 否 | 實例連接地址的網絡類型，取值：
| 2 |
| Engine | string | 否 | 數據庫類型，取值固定為 Redis。 | Redis |
| EngineVersion | string | 否 | 數據庫版本號，取值固定為5.0。 | 5.0 |
| ClusterId | string | 否 | 專屬集群 ID，可在專屬集群控制臺的專屬集群信息頁獲取。 說明
如需傳入多個，ID 間使用英文逗號（,）分隔。
| dhg-5f2v98840ioq**** |
| DedicatedHostName | string | 否 | 專屬集群的主機 ID，可調用 DescribeDedicatedHosts 獲取。 說明
如需傳入多個，ID 間使用英文逗號（,）分隔。
| ch-t4n664a9mal4c**** |
| PageNumber | integer | 否 | 頁碼，大于 0 且不超過 Integer 數據類型的最大值，默認值為 1。 | 1 |
| PageSize | integer | 否 | 每頁可展示的最大記錄數，取值：30、50、100，默認值為 30。 | 30 |
返回參數
示例
正常返回示例
JSON格式
{
"PageNumber": 1,
"PageSize": 25,
"RequestId": "712CCF2A-16BD-411B-93F7-E978BEF2****",
"TotalCount": 0,
"Instances": [
{
"VpcId": "vpc-t4n2clc70t3hqwsrr****",
"CharacterType": "logic",
"VswitchId": "vsw-t4nvrca24dczppq44****",
"InstanceClass": "redis.cluster.sharding.common.ce",
"MaintainStartTime": "16:00Z",
"CreateTime": "2021-05-06T07:09:40Z",
"ConnectionDomain": "r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com",
"MaintainEndTime": "17:00Z",
"StorageType": "LOCAL_SSD",
"InstanceId": "r-bp1e7vl6ygf1yq****",
"BandWidth": 24,
"CurrentBandWidth": 50,
"EngineVersion": "5.0",
"RegionId": "cn-hangzhou",
"InstanceName": "testdb",
"ZoneId": "cn-hangzhou-e",
"ClusterName": "testname",
"InstanceStatus": "Normal",
"Engine": "redis",
"ShardCount": 3,
"CustomId": "4652****",
"ProxyCount": 1,
"ClusterId": "dhg-rx71fc5ndh9o****",
"InstanceNodeList": [
{
"NodeIp": "10.0.33.***",
"DedicatedHostName": "ch-bp13vf0y9gx3c****",
"NodeType": "normal",
"ZoneId": "cn-hangzhou-h",
"InstanceId": "r-bp1e7vl6ygf1yq****",
"Port": 3001,
"Role": "master",
"NodeId": 17921111
}
]
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。