CreateDBEndpoint--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

CreateDBEndpoint

最近更新时间：2024.10.17 14:42:41首次发布时间：2022.04.12 11:06:53

调用 CreateDBEndpoint 接口为目标 MongoDB 实例创建连接地址。

请求类型

异步请求。

注意事项

当前仅支持通过接口创建实例或组件级别的连接地址。接口调用成功后，系统自动为该实例或组件下的所有节点（包括主节点和从节点）生成对应的连接地址。
MongoDB 实例类型不同，支持申请或释放的连接地址类型也不同。更多信息，请参见连接地址类型。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-011d2479****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
ObjectId	String	否	mongo-shard-011d2479****-s0	需要创建的连接地址所属组件（如 Shard 或 ConfigServer 组件）的 ID。说明当实例为分片集群实例时，该参数必填。您可以调用 DescribeDBEndpoint 接口查看目标分片集群实例下的所有组件 ID。当前仅支持通过接口创建实例或组件级别的连接地址，不支持为组件下的某个节点（如主节点或从节点）创建单独的连接地址。
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。您可以调用 DescribeEipAddresses 接口查询所有 EIP 信息列表，包括可用的 EIP ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例 1

为副本集实例申请公网地址。

POST https://mongodb.volcengineapi.com/?Action=CreateDBEndpoint&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=****
{
  "NetworkType": "Public",
  "InstanceId": "mongo-replica-617a883d****",
  "EipIds": [
      "eip-2d744t595x6o058ozfeht****",
      "eip-2byu2l2b27lz42dx0efko****"
  ]
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20220314172456010212194039160D****",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

请求示例 2

为分片集群实例中的某一 Shard 分片申请私网地址。

POST https://mongodb.volcengineapi.com/?Action=CreateDBEndpoint&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=****
{
  "ObjectId": "mongo-shard-9a554522****-s0",
  "NetworkType": "Private",
  "InstanceId": "mongo-shard-9a554522****"
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20220314172456010212194039160D****",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
 "Result": null
}

请求示例 3

为分片集群实例中的 ConfigServer 申请公网地址。

说明

为 ConfigServer（或 Shard）申请公网地址前，需先申请对应组件的私网地址。

POST https://mongodb.volcengineapi.com/?Action=CreateDBEndpoint&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=****
{
  "ObjectId": "mongo-shard-9a554522****-config",
  "NetworkType": "Public",
  "InstanceId": "mongo-shard-9a554522****",
  "EipIds": [
      "eip-2d744t595x6o058ozfeht****",
      "eip-2byu2l2b27lz42dx0efk****"
  ]
}

返回示例 3

{
    "ResponseMetadata": {
        "RequestId": "20220314172456010212194039160D****",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

请求示例 4

为分片集群实例中的某一 Mongos 节点申请公网地址。

POST https://mongodb.volcengineapi.com/?Action=CreateDBEndpoint&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=****
{
  "ObjectId": "mongo-shard-9a554522****",
  "NetworkType": "Public",
  "InstanceId": "mongo-shard-9a554522****",
  "MongosNodeIds": [
      "mongo-shard-9a554522****-0"
  ],
  "EipIds": [
      "eip-2d744t595x6o058ozfeht****"
  ]
}

返回示例 4

{
    "ResponseMetadata": {
        "RequestId": "20220314172456010212194039160D****",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。