文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考连接管理CreateDBEndpoint
复制全文
下载 pdfCreateDBEndpoint
文档反馈
问问助手调用 CreateDBEndpoint 接口为目标 MongoDB 实例创建连接地址。
请求类型
异步请求。
注意事项
- 当前仅支持通过接口创建实例或组件级别的连接地址。接口调用成功后，系统自动为该实例或组件下的所有节点（包括主节点和从节点）生成对应的连接地址。
- MongoDB 实例类型不同，支持申请或释放的连接地址类型也不同。更多信息，请参见连接地址类型。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 必选 示例值：mongo-shard-011d2479****
实例 ID。
说明
ObjectId String 可选 示例值：mongo-shard-011d2479****-s0
需要创建连接地址的单个 Shard 分片或 ConfigServer 组件 ID。
说明
- 该参数仅对分片集群实例生效。
- 当为分片集群中的 Shard（或 ConfigServer 组件）申请连接地址时，仅允许从 ObjectId、ObjectIds 或 AllShard 中选择一个参数传入，否则调用接口时会报错。
- 您可以调用 DescribeDBEndpoint 接口查看目标分片集群实例下的所有组件 ID。
- 当前仅支持通过接口创建实例或组件级别的连接地址，不支持为组件下的某个节点（如主节点或从节点）创建单独的连接地址。
ObjectIds String[] 可选 示例值：[mongo-shard-011d2479****-s0]
需要创建连接地址的 Shard 分片或 ConfigServer 组件 ID 列表。
说明
- 该参数仅对分片集群实例生效。
- 当为分片集群中的 Shard（或 ConfigServer 组件）申请连接地址时，仅允许从 ObjectId、ObjectIds 或 AllShard 中选择一个参数传入，否则调用接口时会报错。
- 您可以调用 DescribeDBEndpoint 接口查看目标分片集群实例下的所有组件 ID。
- 当前仅支持通过接口创建实例或组件级别的连接地址，不支持为组件下的某个节点（如主节点或从节点）创建单独的连接地址。
AllShard Boolean 可选 示例值：false
是否为当前实例中的所有 Shard 分片批量创建连接地址。取值范围如下：
- true：批量创建。
- false：不批量创建。
说明
- 该参数仅对分片集群实例生效。
- 当为分片集群中的 Shard（或 ConfigServer 组件）申请连接地址时，仅允许从 ObjectId、ObjectIds 或 AllShard中选择一个参数传入，否则调用接口时会报错。
NetworkType String 可选 示例值：Private
连接地址的网络类型，取值范围如下：
- Private（默认）：私网连接地址。
- Public：公网连接地址。
MongosNodeIds String[] 可选 示例值：[ "mongo-shard-9a554522****-0", "mongo-shard-9a554522****-1" ]
需要申请公网连接地址的 Mongos 节点 ID。
说明
- 仅当申请分片集群实例中 Mongos 节点的公网地址时，该参数必填。
- 支持同时申请多个 Mongos 节点的公网地址，多个 Mongos 节点 ID 间用英文逗号（,）分隔。
- 您可以调用 DescribeDBInstanceDetail接口查询目标实例分片集群实例下所有 Mongos 节点的信息，包括 Mongos 的节点 ID。
EipIds String[] 可选 示例值：[ "eip-2d744t595x6o058ozfeht****", "eip-2byu2l2b27lz42dx0efko****" ]
申请公网地址时需要绑定的 EIP ID 列表。
说明
- 仅当 NetworkType 为 Public 时，该参数必填。实例或组件类型不同，需要填入的 EIP 数量也不同，其中：
- 当为 Mongos 节点申请公网地址时，传入的 EIP 数量必须和 MongosNodeIds 的数量一致。例如，仅传入了 1 个 Mongos 节点 ID，那么也只需传入 1 个 EIP ID。
- 当为副本集实例、Shard 分片或 ConfigServer 申请公网地址时，必须为每个实例或组件同时填入 2 个 EIP ID。关于每个公网地址需绑定的 EIP 数量详情，请参见查看连接地址。
- 您可以调用 DescribeEipAddresses接口查询所有 EIP 信息列表，包括可用的 EIP ID。
返回参数
示例
请求示例 1
为副本集实例申请公网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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=****
{
"NetworkType":"Public",
"InstanceId":"mongo-replica-617a883d****",
"EipIds":[
"eip-2d744t595x6o058ozfeht****",
"eip-2byu2l2b27lz42dx0efko****"
]
}
返回示例 1
{
"ResponseMetadata": {
"RequestId": "20220314172456010212194039160D160D",
"Action": "CreateDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 2
为分片集群实例中的某一 Shard 分片申请私网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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=****
{
"ObjectId": "mongo-shard-9a554522****-s0",
"NetworkType": "Private",
"InstanceId": "mongo-shard-9a554522****"
}
返回示例 2
{
"ResponseMetadata": {
"RequestId": "20220314172456010212194039160D160D",
"Action": "CreateDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 3
为分片集群实例中的 ConfigServer 申请公网地址。
说明
为 ConfigServer（或 Shard）申请公网地址前，需先申请对应组件的私网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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=****
{
"ObjectId":"mongo-shard-9a554522****-config",
"NetworkType":"Public",
"InstanceId":"mongo-shard-9a554522****",
"EipIds":[
"eip-2d744t595x6o058ozfeht****",
"eip-2byu2l2b27lz42dx0efk****"
]
}
返回示例 3
{
"ResponseMetadata": {
"RequestId": "20220314172456010212194039160D160D",
"Action": "CreateDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
请求示例 4
为分片集群实例中的某一 Mongos 节点申请公网地址。
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.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=****
{
"ObjectId":"mongo-shard-9a554522****",
"NetworkType":"Public",
"InstanceId":"mongo-shard-9a554522****",
"MongosNodeIds":[
"mongo-shard-9a554522****-0"
],
"EipIds":[
"eip-2d744t595x6o058ozfeht****"
]
}
返回示例 4
{
"ResponseMetadata": {
"RequestId": "20220314172456010212194039160D160D",
"Action": "CreateDBEndpoint",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": null
}
错误码
最近更新时间：2026.06.17 16:16:21
这个页面对您有帮助吗？
有用
有用
无用
无用