有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(OpenWanService)用于开通实例外网访问。

注意,实例开通外网访问之前,需要先将实例进行 实例初始化 操作。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:OpenWanService。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。
示例值:cdb-ezq1vzem

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
示例值:b4a719b5-ffb34ab6-816c43c1-8c6a23eb
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开通实例外网访问

输入示例

https://cdb.tencentcloudapi.com/?Action=OpenWanService
&InstanceId=cdb-ezq1vzem
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation.StatusConflict 任务状态冲突。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。
OperationDenied.ActionNotSupport 不支持的操作。
OperationDenied.WrongStatus 后端任务状态非法。