创建对端网关

最近更新时间:2018-10-26 15:00:58

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
CustomerGateway CustomerGateway 对端网关对象
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建对端网关

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateCustomerGateway
&Version=2017-03-12
&CustomerGatewayName=test-cgw
&IpAddress=58.211.1.12
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue.Duplicate 入参重复。
VpcLimitExceeded 已经达到指定区域vpc资源申请数量上限。