DescribeDedicatedClusterInstanceList - 查看專屬叢集執行個體的列表 - Tair (Redis® OSS-Compatible)

查詢專屬叢集中的雲資料庫 Tair（相容 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	否	執行個體狀態，取值： 0：建立中。 1：運行中。 3：刪除中。 5：變更配置中。 6：遷移中。 7：備份恢複中。 8：切換中。 9：刪除到期資料。	1
InstanceNetType	string	否	執行個體串連地址的網路類型，取值： 0：公網。 1：傳統網路。 2：Virtual Private Cloud。	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 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	integer	否	每頁可展示的最大記錄數，取值：30、50、100，預設值為 30。	30

返回參數

名稱	類型	描述	樣本值
	object
PageNumber	integer	頁碼。	1
PageSize	integer	每頁可展示的記錄數。	25
RequestId	string	請求 ID。	712CCF2A-16BD-411B-93F7-E978BEF2****
TotalCount	integer	總記錄數。	0
Instances	array<object>	執行個體資訊列表。
	array<object>	執行個體資訊列表。
VpcId	string	Virtual Private Cloud ID。	vpc-t4n2clc70t3hqwsrr****
CharacterType	string	架構類型，傳回值： logic：叢集架構。 normal：標準架構。	logic
VswitchId	string	虛擬交換器 ID。	vsw-t4nvrca24dczppq44****
InstanceClass	string	執行個體規格。	redis.cluster.sharding.common.ce
MaintainStartTime	string	可維護時間段的開始時間，格式為HH:mmZ（UTC 時間）。	16:00Z
CreateTime	string	執行個體的建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2021-05-06T07:09:40Z
ConnectionDomain	string	直連地址。	r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com
MaintainEndTime	string	可維護時間段的結束時間，格式為HH:mmZ（UTC 時間）。	17:00Z
StorageType	string	儲存類型，傳回值固定為 LOCAL_SSD（ ESSD 雲端硬碟）。	LOCAL_SSD
InstanceId	string	執行個體 ID。	r-bp1e7vl6ygf1yq****
BandWidth	integer	執行個體的預設頻寬，單位為 MB/s。	24
CurrentBandWidth	integer	執行個體當前的頻寬，單位為 MB/s，由預設頻寬和增加的頻寬組成。	50
EngineVersion	string	資料庫版本，傳回值固定為5.0。	5.0
RegionId	string	地區 ID。	cn-hangzhou
InstanceName	string	執行個體名稱。	testdb
ZoneId	string	可用性區域 ID。	cn-hangzhou-e
ClusterName	string	專屬叢集名稱。	testname
InstanceStatus	string	執行個體狀態，傳回值： Normal：正常。 Creating：建立中。 Changing：修改中。 Inactive：被禁用。 Flushing：清除中。 Released：已釋放。 Transforming：轉換中。 Unavailable：服務停止。 Error：建立失敗。 Migrating：遷移中。 BackupRecovering：備份恢複中。 MinorVersionUpgrading：小版本升級中。 NetworkModifying：網路變更中。 SSLModifying：SSL 變更中。 MajorVersionUpgrading：大版本升級中，可正常訪問。	Normal
Engine	string	資料庫類型，傳回值固定為 redis。	redis
ShardCount	integer	資料分區數量。說明僅當執行個體為叢集架構時，才會返回本參數。	3
CustomId	string	內部參數，維護執行個體使用。	4652****
ProxyCount	integer	代理節點數量。說明傳回值為 0 時，表示執行個體未開啟代理模式；傳回值為大於 0 的整數時（例如 1），表示執行個體已開啟代理模式。僅當執行個體為叢集架構時，才會返回本參數。	1
ClusterId	string	專屬叢集 ID。	dhg-rx71fc5ndh9o****
InstanceNodeList	array<object>	節點資訊列表。
	object	執行個體節點的列表。
NodeIp	string	節點 IP 位址。	10.0.33.***
DedicatedHostName	string	專屬叢集的主機 ID。	ch-bp13vf0y9gx3c****
NodeType	string	節點類型，傳回值： db：資料節點。 proxy：代理節點。 normal：普通節點（標準架構的執行個體會返回該值）。	normal
ZoneId	string	節點所屬的可用性區域。	cn-hangzhou-h
InstanceId	string	執行個體 ID。	r-bp1e7vl6ygf1yq****
Port	integer	節點的連接埠。	3001
Role	string	節點角色，傳回值： master：主節點。 slave：備節點。	master
NodeId	integer	節點 ID。	17921111

樣本

正常返回樣本

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
        }
      ]
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。