开启外网访问地址

最近更新时间:2026-05-08 02:22:36

我的收藏

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口(OpenWanService)用于开启当前实例的外网访问地址。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:EnableWanService。
Version String 公共参数,本接口取值:2019-07-25。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID。
示例值:cmgo-abcdef
LoadBalancerId String 负载均衡ID。
示例值:lb-dabkt44i
NodeList.N Array of WanServiceNodeList 节点及监听端口信息。

3. 输出参数

参数名称 类型 描述
FlowId Integer 异步任务ID。
示例值:1745484844
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开启实例的外网访问地址。

实例未开启外网访问,请求该接口开启外网访问。

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableWanService
<公共请求参数>

{
    "InstanceId": "cmgo-qwla****",
    "LoadBalancerId": "lb-94d6****",
    "NodeList": [
        {
            "VipVport": "10.0.30.*:27017",
            "ListenerPort": "10001"
        },
        {
            "VipVport": "10.0.30.*:27017",
            "ListenerPort": "10002"
        },
        {
            "VipVport": "10.0.30.1*:27017",
            "ListenerPort": "10003"
        }
    ]
}

输出示例

{
    "Response": {
        "FlowId": 174548484400,
        "RequestId": "ce73f291-7ffd-4390-9434-7c****12sa1b0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameterValue.LockFailed 实例锁定失败。
InvalidParameterValue.NotFoundInstance 未找到实例。
InvalidParameterValue.SecurityLevelNotAllowOpenWanService 当前实例已开通免密访问,或未绑定安全组,安全级别较低不允许打开外网访问服务。