DescribeRoleZoneInfo - 查詢節點和所屬可用性區域資訊 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體中各節點的角色、類型、小版本和所屬的可用性區域。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeRoleZoneInfo

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID，可調用 DescribeInstances 介面擷取。	r-t4nlenc2p04uvb****
QueryType	integer	否	查詢的目標節點類型，取值： 0：Proxy（代理）節點。說明該參數僅支援叢集與讀寫分離架構執行個體。 1：資料節點，預設值。	0
PageNumber	integer	否	頁碼，大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	integer	否	每頁可展示的記錄數，取值：10、20、50，預設值為 10.	10

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	224B97FB-A275-4EAC-86E9-8922FEA2****
PageNumber	integer	頁碼。	1
PageSize	integer	每頁可展示的記錄數。	10
TotalCount	integer	總記錄數。	2
Node	object
NodeInfo	array<object>	執行個體中各節點的詳細資料。
	object
DefaultBandWidth	integer	節點預設的預設頻寬，單位為 MB/s。	96
CurrentMinorVersion	string	節點當前的小版本。	redis-5.0_0.3.10
CurrentBandWidth	integer	節點當前的頻寬，單位為 MB/s，由節點的預設頻寬和增加的頻寬組成。說明您可以調用 EnableAdditionalBandwidth 介面設定要增加的頻寬。通過本參數也可推算出增加的頻寬大小，例如節點預設頻寬為 96 MB/s，本參數傳回值為 100，則增加了 4 MB/s 的頻寬。	100
InsType	integer	是否為唯讀節點，如果為唯讀節點，本參數傳回值為 3。說明如果不是唯讀節點，不返回本參數。	3
IsLatestVersion	integer	是否為最新的小版本，傳回值： 0：不是最新版本。 1：是最新版本。說明如需升級小版本，請調用 ModifyInstanceMinorVersion 介面。	1
InsName	string	節點 ID。	r-t4nlenc2p04uvb****
NodeType	string	節點類型，傳回值： db：資料節點。 proxy：代理節點。 normal：普通節點（標準架構的執行個體會返回該值）。	normal
ZoneId	string	可用性區域 ID。	cn-hangzhou-b
IsOpenBandWidthService	boolean	該節點是否增加了頻寬，取值： true：未增加頻寬。 false：已增加頻寬。	true
CustinsId	string	資料分區節點 ID。	30381****
Role	string	節點角色，傳回值： master：主節點。 slave：備節點。	master
NodeId	string	本參數僅作為執行個體內部維護使用。	10065****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Node": {
    "NodeInfo": [
      {
        "DefaultBandWidth": 96,
        "CurrentMinorVersion": "redis-5.0_0.3.10",
        "CurrentBandWidth": 100,
        "InsType": 3,
        "IsLatestVersion": 1,
        "InsName": "r-t4nlenc2p04uvb****",
        "NodeType": "normal",
        "ZoneId": "cn-hangzhou-b",
        "IsOpenBandWidthService": true,
        "CustinsId": "30381****",
        "Role": "master",
        "NodeId": "10065****"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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