調用DescribeRoleZoneInfo查詢執行個體的節點角色與可用性區域-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

介面說明

說明

更多詳情請參見查看節點所屬的可用性區域。

本介面適用於複本集執行個體和分區叢集執行個體，暫不支援單節點執行個體。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeRoleZoneInfo

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-bpxxxxxxxx

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	728B9A96-E262-4AE5-915E-3A51CCE2FDA9
ZoneInfos	object
ZoneInfo	array<object>	節點在可用性區域中的分布資訊列表。
	object
InsName	string	節點 ID。	dds-bpxxxxxxxx
NodeType	string	節點類型，傳回值為： normal：普通節點。 configServer：設定管理員節點。 shard：Shard 節點。 mongos：Mongos 節點。說明當執行個體類型為複本集執行個體時，傳回值為 normal；當執行個體類型為分區叢集執行個體時，傳回值中包含 configServer、shard 和 mongos。	normal
RoleType	string	節點的角色，傳回值為： Primary：主節點。 Secondary：從節點。 Hidden：隱藏節點。	Primary
ZoneId	string	可用性區域 ID。	cn-hangzhou-e
RoleId	string	角色 ID。	83xxxxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "728B9A96-E262-4AE5-915E-3A51CCE2FDA9",
  "ZoneInfos": {
    "ZoneInfo": [
      {
        "InsName": "dds-bpxxxxxxxx",
        "NodeType": "normal",
        "RoleType": "Primary",
        "ZoneId": "cn-hangzhou-e",
        "RoleId": "83xxxxx"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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