調用DescribeReplicaSetRole查詢執行個體的角色與串連資訊-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢MongoDB執行個體中的角色資訊及串連資訊。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeReplicaSetRole

get

*Instance

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

無

請求參數

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

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
DBInstanceId	string	執行個體 ID。	dds-bpxxxxxxxx
ReplicaSets	object
ReplicaSet	array<object>	複本集角色資訊列表。
	object
ConnectionPort	string	節點的串連連接埠。	3717
ReplicaSetRole	string	該節點在複本集中的角色。 Primary：主節點。 Secondary：從節點。	Primary
ExpiredTime	string	保留的傳統網路地址剩餘時間長度，單位為秒。	1209582
ConnectionDomain	string	節點的串連地址。	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NetworkType	string	網路類型。 VPC：專用網路。 Classic：傳統網路。 Public：公網。	VPC
RoleId	string	節點的角色 ID。	651xxxxx
ConnectionType	string	連線類型。	SRV
ConnectionStringSuffix	string	串連串網域名稱尾碼。	.mongodb.rds.aliyuncs.com

樣本

正常返回樣本

JSON格式

{
  "RequestId": "DB4A0595-FCA9-437F-B2BB-25DBFC009D3E",
  "DBInstanceId": "dds-bpxxxxxxxx",
  "ReplicaSets": {
    "ReplicaSet": [
      {
        "ConnectionPort": "3717",
        "ReplicaSetRole": "Primary",
        "ExpiredTime": "1209582",
        "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NetworkType": "VPC",
        "RoleId": "651xxxxx",
        "ConnectionType": "SRV"
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com\n"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden	User not authorized to operate on the specified resource.	使用者未授權標籤鑒權。

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

變更歷史

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