帮你快速理解、总结文档立即下载
文档中心>API 中心

创建对端网关

最近更新时间:2025-09-12 01:16:08
我的收藏

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2025-09-11 10:19:37

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

90天无调用

本接口(CreateCustomerGateway)用于创建对端网关。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateCustomerGateway。
Version 是 String 公共参数,本接口取值:2018-06-25。
Region 是 String 公共参数,详见产品支持的 地域列表。
CustomerGatewayName 是 String 对端网关名称,可任意命名,但不得超过60个字符。
IpAddress 是 String 对端网关公网IP。
Zone 是 String 可用区ID

3. 输出参数

参数名称 类型 描述
CustomerGateway CustomerGateway 对端网关对象
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建对端网关

输入示例

https://bmvpc.tencentcloudapi.com/?Action=CreateCustomerGateway
&Version=2018-06-25
&CustomerGatewayName=test-cgw
&IpAddress=58.211.1.12
&Zone=ap-guangzhou
&<公共请求参数>

输出示例

{
    "Response": {
        "CustomerGateway": {
            "CustomerGatewayId": "bmcgw-mgp33pll",
            "IpAddress": "58.211.1.12",
            "CustomerGatewayName": "test-cgw",
            "CreateTime": "2018-04-18 10:00:00"
        },
        "RequestId": "5bd98433-263a-47b6-9a1c-84aa613a8ff6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound.CustomerGatewayNotExist 对端网关不存在。
UnsupportedOperation.CustomerGatewayAddrExist 对端网关地址已存在。
UnsupportedOperation.CustomerGatewayAddrInvalid 对端网关地址不合法。
UnsupportedOperation.VpnConnInUse 存在VPN通道引用。