点击领取2000元阿里云代金券,付款抵现金用,云服务器69元/年限时抢>>> 点击咨询成为阿里云VIP客户享永久折扣>>>
点击领取2860元腾讯云代金券,付款抵现金用,云服务器88元/年限时抢>>> 点击成为腾讯云VIP客户享永久折扣优惠>>> 点击进入华为云最新优惠活动现场>>> 点击成为华为云VIP客户享永久折扣优惠>>>
1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateVpnConnection)用于创建VPN通道。
默认接口请求频率限制:100次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
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安全会话设置 |
Tags.N |
否 |
Array of Tag |
指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}] |
EnableHealthCheck |
否 |
Boolean |
是否支持隧道内健康检查 |
HealthCheckLocalIp |
否 |
String |
健康检查本端地址 |
HealthCheckRemoteIp |
否 |
String |
健康检查对端地址 |
3. 输出参数
参数名称 |
类型 |
描述 |
VpnConnection |
VpnConnection |
通道实例对象。 |
RequestId |
String |
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建VPN通道
输入示例
https://vpc.tencentcloudapi.com/?Action=CreateVpnConnection
&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
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<公共请求参数>
输出示例
{
"Response": {
"VpnConnection": {
"VpnConnectionId": "vpnr-12ds042",
"VpnConnectionName": "TEST_CONN",
"PreShareKey": "654321",
"VpcId": "vpc-gapcv96p",
"HealthCheckRemoteIp": "",
"NetStatus": "",
"EnableHealthCheck": true,
"EncryptProto": "IKE",
"VpnProto": "IPSEC",
"IPSECOptionsSpecification": {
"PfsDhGroup": "",
"IPSECSaLifetimeTraffic": 1,
"EncryptAlgorithm": "",
"IPSECSaLifetimeSeconds": 1,
"IntegrityAlgorith": ""
},
"SecurityPolicyDatabaseSet": [
{
"LocalCidrBlock": "10.8.4.0/24",
"RemoteCidrBlock": [
"58.211.1.0/24"
]
}
],
"State": "PENGDING",
"HealthCheckLocalIp": "",
"HealthCheckStatus": "",
"VpnGatewayId": "vpngw-1w9tue3d",
"CreatedTime": "2020-09-22 00:00:00",
"CustomerGatewayId": "cgw-qa9sxpy7",
"IKEOptionsSpecification": {
"IKEVersion": "",
"RemoteIdentity": "",
"PropoAuthenAlgorithm": "",
"RemoteAddress": "",
"LocalFqdnName": "",
"LocalIdentity": "",
"LocalAddress": "",
"RemoteFqdnName": "",
"ExchangeMode": "",
"IKESaLifetimeSeconds": 1,
"PropoEncryAlgorithm": "",
"DhGroupName": ""
},
"RouteType": "STATIC"
},
"RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 |
描述 |
InvalidParameter.Coexist |
参数不支持同时指定。 |
InvalidParameterValue.Malformed |
入参格式不合法。 |
InvalidParameterValue.VpcCidrConflict |
目的网段和当前VPC的CIDR冲突。 |
InvalidParameterValue.VpnConnCidrConflict |
目的网段和当前VPN通道的CIDR冲突。 |
LimitExceeded |
超过配额限制。 |
ResourceInUse |
资源被占用。 |
ResourceNotFound |
资源不存在。 |
UnsupportedOperation |
操作不支持。 |
UnsupportedOperation.InvalidState |
资源状态不合法。 |
|