全部产品
Search
文档中心

云数据库 MongoDB:DescribeShardingNetworkAddress - 查询MongoDB分片集群实例的连接信息

更新时间:Jan 17, 2023

查询MongoDB分片集群实例的连接信息。

接口说明

该接口仅支持分片集群实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
dds:DescribeShardingNetworkAddress READ
  • MongoDB
    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

返回参数

名称 类型 描述 示例值
object
CompatibleConnections array

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 array

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

示例

正常返回示例

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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。