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

文档中心

立即注册

导航

ModifyDBEndpointPort

最近更新时间：2025.08.27 21:39:36首次发布时间：2025.08.27 21:39:36

调用 ModifyDBEndpointPort 接口修改目标 MongoDB 实例对应连接地址的端口号。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-e405f8e2****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
Port	String	是	1000	修改后的连接地址端口号，取值范围：1000~65535。注意当前仅支持修改副本集实例或分片集群实例中 Mongos 节点所对应连接地址的端口号。且实例或组件类型不同，新端口的生效范围不同。具体生效范围，请参见修改端口号。修改端口会将导致部分服务的访问在短时间内受到影响，请谨慎操作。修改端口后，原有的连接会断开，请及时修改客户端的连接信息，使用新的端口来连接实例。连接实例的具体方法，请参见通过 Mongo Shell 工具连接实例。

返回参数

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

示例

请求示例 1

将副本集实例中连接地址所对应的端口号改为 1000。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyDBEndpointPort&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=****
{
    "InstanceId": "mongo-replica-e405f8e2****",
    "Port": "1000"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20230604110420100232280022D31****",
        "Action": "ModifyDBEndpointPort",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

请求示例 2

将分片集群实例中 Mongos 节点所对应连接地址的端口号改为 1001。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyDBEndpointPort&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=****
{
    "InstanceId": "mongo-shard-011d2479****",
    "Port": "1001"
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20230604110420100232280022D31****",
        "Action": "ModifyDBEndpointPort",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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