创建VPN通道

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

1. 接口描述

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

本接口(CreateVpnConnection)用于创建VPN通道。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateVpnConnection
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
VpcId String VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
VpnGatewayId String VPN网关实例ID。
CustomerGatewayId String 对端网关ID,例如:cgw-2wqq41m9,可通过DescribeCustomerGateways接口查询对端网关。
VpnConnectionName String 通道名称,可任意命名,但不得超过60个字符。
PreShareKey String 预共享密钥。
SecurityPolicyDatabases.N Array of SecurityPolicyDatabase SPD策略组,例如:{"10.0.0.5/24":["172.123.10.5/16"]},10.0.0.5/24是vpc内网段172.123.10.5/16是IDC网段。用户指定VPC内哪些网段可以和您IDC中哪些网段通信。
IKEOptionsSpecification IKEOptionsSpecification IKE配置(Internet Key Exchange,因特网密钥交换),IKE具有一套自保护机制,用户配置网络安全协议
IPSECOptionsSpecification IPSECOptionsSpecification IPSec配置,腾讯云提供IPSec安全会话设置

3. 输出参数

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

4. 示例

示例1 创VPN通道

输入示例

https://vpc.tencentcloudapi.com/?Action=CreateVpnConnection
&Version=2017-03-12
&VpcId=vpc-gapcv96p
&VpnGatewayId=vpngw-1w9tue3d
&CustomerGatewayId=cgw-qa9sxpy7
&VpnConnectionName=TEST_CONN
&PreShareKey=654321
&SecurityPolicyDatabases.0.LocalCidrBlock=10.8.4.0/24
&SecurityPolicyDatabases.0.RemoteCidrBlock.0=58.211.1.0/24
&IKEOptionsSpecification.DhGroupName=GROUP1
&IKEOptionsSpecification.ExchangeMode=MAIN
&IKEOptionsSpecification.IKEVersion=IKEV1
&IKEOptionsSpecification.LocalAddress=58.211.2.5
&IKEOptionsSpecification.LocalIdentity=ADDRESS
&IKEOptionsSpecification.PropoAuthenAlgorithm=MD5
&IKEOptionsSpecification.PropoEncryAlgorithm=3DES-CBC
&IKEOptionsSpecification.RemoteAddress=1.2.3.4
&IKEOptionsSpecification.RemoteIdentity=ADDRESS
&IPSECOptionsSpecification.EncryptAlgorithm=3DES-CBC
&IPSECOptionsSpecification.IntegrityAlgorith=MD5
&IPSECOptionsSpecification.PfsDhGroup=NULL
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b",
    "VpnConnection": {
      "CustomerGatewayId": "cgw-qa9sxpy7",
      "State": "PENDING",
      "VpcId": "vpc-gapcv96p",
      "VpnConnectionName": "TEST_CONN",
      "VpnGatewayId": "vpngw-1w9tue3d"
    }
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.Coexist 参数不支持同时指定。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.VpcCidrConflict 目的网段和当前VPC的CIDR冲突。