使用DescribeShardingNetworkAddress查詢分區叢集執行個體串連資訊-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢MongoDB分區叢集執行個體的串連資訊。

介面說明

該介面僅支援分區叢集執行個體。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeShardingNetworkAddress

get

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-bpxxxxxxxx
NodeId	string	否	分區叢集執行個體中 Mongos 節點 ID、Shard 節點 ID 或 ConfigServer 節點 ID。說明您可以調用 DescribeDBInstanceAttribute 介面查詢 Mongos/Shard/ConfigServer 節點 ID。	d-bpxxxxxxxx
NetworkType	string	否	網路類型，取值： VPC：專用網路。 Classic：傳統網路。 Public：公網。	VPC

返回參數

名稱	類型	描述	樣本值
	object
CompatibleConnections	object
CompatibleConnection	array<object>	DynamoDB 協議類型執行個體的串連地址資訊列表。
	object
VswitchId	string	專用網路中交換器 ID。說明當網路類型為 VPC 時返回該參數。	vsw-bpxxxxxxxx
ExpiredTime	string	保留的傳統網路地址剩餘時間長度，單位為秒。	2591963
NetworkType	string	網路類型。 VPC：專用網路。 Classic：傳統網路。 Public：公網。	VPC
Port	string	串連連接埠。	3717
NetworkAddress	string	串連地址。	dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com
VPCId	string	專用網路 ID。說明當網路類型為 VPC 時返回該參數。	vpc-bpxxxxxxxx
IPAddress	string	IP 位址。	10.140.xxx.xx
RequestId	string	請求 ID。	18D8AAFD-6BEB-420F-8164-810CB0C0AA39
NetworkAddresses	object
NetworkAddress	array<object>	MongoDB 協議類型執行個體的串連地址資訊列表。
	object
NodeType	string	節點類型，傳回值為 mongos：mongos 節點。 shard：shard 節點。 configserver：configserver 節點。	mongos
VswitchId	string	專用網路中交換器 ID。說明當網路類型為 VPC 時返回該參數。	vsw-bpxxxxxxxx
ExpiredTime	string	保留的傳統網路地址剩餘時間長度，單位為秒。	2591963
NetworkType	string	網路類型。 VPC：專用網路。 Classic：傳統網路。 Public：公網。	VPC
Role	string	節點角色，傳回值： Primary：主節點。 Secondary：從節點。	Primary
Port	string	串連連接埠。	3717
VPCId	string	專用網路 ID。說明當網路類型為 VPC 時返回該參數。	vpc-bpxxxxxxxx
NetworkAddress	string	串連地址（字串）。	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NodeId	string	Mongos 節點 ID。	s-bpxxxxxxxx
IPAddress	string	IP 位址。	10.140.xxx.xx
ConnectionType	string	公網地址類型，可選值： SRV Normal	SRV
TxtRecord	string	TXT 記錄，用來儲存 MongoDB 相關的元資訊，如版本資訊、配置參數等，可結合 SRV 記錄等其他技術實現複雜的服務發現和配置傳遞等功能。	mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
ConnectionStringSuffix	string	串連串網域名稱尾碼。	.mongodb.rds.aliyuncs.com

樣本

正常返回樣本

JSON格式

{
  "CompatibleConnections": {
    "CompatibleConnection": [
      {
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Port": "3717",
        "NetworkAddress": "dds-bpxxxxxxxxxxxxxx.mongodb.rds.aliyuncs.com",
        "VPCId": "vpc-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx"
      }
    ]
  },
  "RequestId": "18D8AAFD-6BEB-420F-8164-810CB0C0AA39",
  "NetworkAddresses": {
    "NetworkAddress": [
      {
        "NodeType": "mongos",
        "VswitchId": "vsw-bpxxxxxxxx",
        "ExpiredTime": "2591963",
        "NetworkType": "VPC",
        "Role": "Primary",
        "Port": "3717",
        "VPCId": "vpc-bpxxxxxxxx",
        "NetworkAddress": "s-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NodeId": "s-bpxxxxxxxx",
        "IPAddress": "10.140.xxx.xx",
        "ConnectionType": "SRV",
        "TxtRecord": "mongo.example.com. IN TXT \"config=replicaSet=myReplicaSet\""
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com"
}

錯誤碼

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

變更歷史

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