You need to enable JavaScript to run this app.
导航
DescribeDBEndpoint
最近更新时间:2024.07.10 22:19:48首次发布时间:2022.04.12 11:06:53

调用 DescribeDBEndpoint 接口查询目标 MongoDB 实例下的连接地址信息。

请求类型

同步请求。

注意事项

调用 DescribeDBEndpoint 接口查询实例连接地址信息时,会同时返回连接地址的域名和IP地址信息。但不建议使用 IP:port 的方式来连接实例,因为切换子网后 IP 地址会改变,客户端代码如果没有及时更新则会出现实例连接失败的问题。
建议您使用 域名:port 的方式来访问 MongoDB 实例,避免出现因 IP 地址改变导致实例无法连接的问题。连接 MongoDB 实例的具体步骤,请参见通过 Mongo Shell 工具连接实例

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mongo-replica-617a883d5****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

返回参数

参数
类型
示例值
描述
DBEndpoints
Object[]
连接地址信息列表。

示例

请求示例 1

查询副本集实例的连接地址详情。

POST https://mongodb.volcengineapi.com/?Action=DescribeDBEndpoint&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId":"mongo-replica-617a883d5****"
}

返回示例 1

副本集实例返回结果。
如下示例仅展示了实例中部分节点的连接地址信息,具体返回数据以接口调用的实际返回结果为准。

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
        "Result": {
        "DBEndpoints": [
            {
                "DBAddresses": [
                    {
                        "AddressDomain": "mongoreplicae405f8e2c****0.mongodb.ivolces.com",
                        "AddressIP": "192.168.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Primary",
                        "EipId": "",
                        "NodeId": "mongo-replica-e405f8e2c****-0"
                    }
                ],
                "EndpointId": "Ak5BUhxJAkgSVR****",
                "EndpointStr": "mongodb://<user>:<password>@mongoreplicae405f8e2c****.mongodb.ivolces.com:3717,mongoreplicae405f8e2c****.mongodb.ivolces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-e405f8e2****&retryWrites=true",
                "EndpointType": "ReplicaSet",
                "NetworkType": "Private",
                "SubnetId": "subnet-3rfc6bfv8lssg5zsk2h7z****",
                "VpcId": "vpc-2bzrc4aszyg3k2dx0eeic****"
            }
        ]
    }
}

请求示例 2

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

POST https://mongodb.volcengineapi.com/?Action=DescribeDBEndpoint&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-shard-bb7108c2****"
}

返回示例 2

分片集群实例返回结果。
如下示例仅展示了实例中部分节点的连接地址信息,具体返回数据以接口调用的实际返回结果为准。

{
    "ResponseMetadata": {
        "RequestId": "202205281742120102250821990282****",
        "Action": "DescribeDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBEndpoints": [
            {
                "DBAddresses": [
                    {
                        "AddressDomain": "mongoshardbb7108c2****0.mongodb.ivolces.com",
                        "AddressIP": "192.168.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Primary",
                        "EipId": "",
                        "NodeId": "mongo-shard-bb7108c2****-0"
                    }
                ],
                "EndpointId": "BRhGVkpJBEhEBB****",
                "EndpointStr": "mongodb://<user>:<password>@mongoshardbb7108c2****0.mongodb.ivolces.com:3717,mongoshardbb7108c2****1.mongodb.ivolces.com:3717/?authSource=admin&retryWrites=true",
                "EndpointType": "Mongos",
                "NetworkType": "Private",
                "ObjectId": "mongo-shard-bb7108c2****",
                "SubnetId": "subnet-22ixzr4pcvnk07r2qr0o0****",
                "VpcId": "vpc-22ixzq18qmk1s7r2qr0mr****"
            },
            {
                "DBAddresses": [
                    {
                        "AddressDomain": "mongoshardbb7108c2****0.mongodb.volces.com",
                        "AddressIP": "14.103.***.***",
                        "AddressPort": "3717",
                        "AddressType": "Primary",
                        "EipId": "eip-5go9gekhuigw73inqlts****",
                        "NodeId": "mongo-shard-bb7108c2****-0"
                    }
                ],
                "EndpointId": "BRhGVkpJBEhEBB****",
                "EndpointStr": "mongodb://<user>:<password>@mongoshardbb7108c2****0.mongodb.volces.com:3717/?authSource=admin&retryWrites=true",
                "EndpointType": "Mongos",
                "NetworkType": "Public",
                "ObjectId": "mongo-shard-bb7108c2****",
                "SubnetId": "subnet-22ixzr4pcvnk07r2qr0o0****",
                "VpcId": "vpc-22ixzq18qmk1s7r2qr0mr****"
            }
        ]
    }
}

错误码

更多详情,请参见错误码