DescribeLogicInstanceTopology - 查詢執行個體的邏輯拓撲結構 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的邏輯拓撲結構。

介面說明

僅叢集與讀寫分離架構執行個體支援本介面。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeLogicInstanceTopology

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	r-bp1zxszhcgatnx****

返回參數

名稱	類型	描述	樣本值
	object
InstanceId	string	執行個體的 ID。	r-bp1zxszhcgatnx****
RequestId	string	請求 ID。	794120D1-E0CF-4713-BAE4-EBAEA04506AF
RedisProxyList	object
NodeInfo	array<object>	代理詳情，包含代理節點資訊。
	object
Capacity	string	節點的容量，單位為 MB。	5120
Connection	string	串連數限制。	320000
NodeType	string	節點類型，傳回值： db：資料節點。 normal：管理節點，由 Proxy 節點（代理節點）和 CS 節點（組態管理節點）組成。部分執行個體不會返回 normal，而是分別返回 proxy 和 cs。	proxy
Bandwidth	string	節點的頻寬節流設定，單位為 MB/s。	96
NodeId	string	節點 ID。	r-bp10noxlhcoim2**-proxy-3#542**
RedisShardList	object
NodeInfo	array<object>	分區詳情，包含 NodeInfo 等子節點資訊。
	object
Capacity	string	節點的容量，單位為 MB。	2048
Connection	string	串連數限制。	10000
NodeType	string	節點類型，傳回值： proxy：代理節點。 db：資料節點。	db
Bandwidth	string	節點的頻寬節流設定，單位為 MB/s。	96
NodeId	string	節點 ID。	r-bp10noxlhcoim2**-db-0#688**
SubInstanceType	string	子執行個體類型，傳回值： master：主節點類型。 readonly：唯讀執行個體類型。	master

樣本

正常返回樣本

JSON格式

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
  "RedisProxyList": {
    "NodeInfo": [
      {
        "Capacity": "5120",
        "Connection": "320000",
        "NodeType": "proxy",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-proxy-3#542****"
      }
    ]
  },
  "RedisShardList": {
    "NodeInfo": [
      {
        "Capacity": "2048",
        "Connection": "10000",
        "NodeType": "db",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-db-0#688****",
        "SubInstanceType": "master"
      }
    ]
  }
}

異常返回樣本

JSON格式

{
  "RedisShardList":
    {"NodeInfo":[{
  "NodeId":"r-xxxxxxxxxxxxxxx-proxy-3#5425423",
  "NodeType":"proxy",
   "Capacity":"5120",
   "Connection":"320000",
   "Bandwidth":96
				 }]},
  "InstanceId":"r-xxxxxxxxxxxxxxx",
  "RequestId":"5F749626-2B6A-4DC2-A010-B51F7C33084E"
 }

錯誤碼

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

變更歷史

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