创建VPN通道

最近更新时间:2019-11-28 09:11:04

1. 接口描述

本接口(AddVpnConnEx)用于创建 VPN 通道。
接口请求域名:vpc.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 AddVpnConnEx。

参数名称 必选 类型 描述
vpcId string 网络 ID 或者统一 ID,建议使用统一 ID,可通过 DescribeVpcEx 接口查询。
vpnGwId String 系统分配的 VPN 网关 ID,可使用 vpnGwId 或 unVpnGwId,建议 unVpnGwId,例如:vpngw-dystbrkv。可通过 DescribeVpnGw 接口查询。
userGwId String 对端网关 ID 值,可使用 userGwId 或 unUserGwId,建议使用 unUserGwId,例如:cgw-e098slul。可通过 DescribeUserGw接口查询。
vpnConnName String 通道名称,可任意命名,但不得超过60个字符。
preSharedKey String 预共享密钥。
userGwCidrBlock.n Array 对端网段 CIDR 地址,可写多个,指定 vpc 可以和哪些 IDC 网段通信,后面升级为 spdAcl(粒度更细),userGwCidrBlock 和 spdAcl 必须填一项。
spdAcl String SPD 策略组,json格式,例如:{"10.0.0.5/24":["172.123.10.5/16"]},10.0.0.5/24是 vpc 内网段172.123.10.5/16是 IDC 网段。用户指定 VPC 内哪些网段可以和您 IDC 中哪些网段通信,由 userGwCidrBlock 升级而来,userGwCidrBlock 和 spdAcl 必须填一项。
IKESet Array IKE 配置(Internet Key Exchange,因特网密钥交换),IKE具有一套自我保护机制,用户配置网络安全协议,详见 VPN 连接-IKE 配置
IPsecSet Array IPSec 配置,腾讯云提供 IPSec 安全会话设置,详见 VPN 连接-IPsec 配置

IKE 配置详情

参数名称 必选 类型 描述
IKESet.propoEncryAlgorithm String IKE 配置,加密算法,可选值:'3des-cbc','aes-cbc-128','aes-cbc-192','aes-cbc-256','des-cbc',默认为3des-cbc,更多详见产品说明文档。
IKESet.propoAuthenAlgorithm String IKE 配置,认证算法:可选值:'md5','sha',默认为 md5,更多详见产品说明文档。
IKESet.exchangeMode String IKE 配置,协商模式:可选值:'aggressive','main',默认为 main,更多详见产品说明文档。
IKESet.localIdentity String IKE 配置,本端标识类型:可选值:'address','fqdn',默认为 address,更多详见产品说明文档。
IKESet.remoteIdentity String IKE 配置,对端标识类型:可选值:'address','fqdn',默认为 address,更多详见产品说明文档。
IKESet.localAddress String IKE 配置,本端标识,当 localIdentity 选为 address 时,localAddress 必填。localAddress 默认为 VPN 网关公网 IP,更多详见产品说明文档。
IKESet.remoteAddress String IKE 配置,对端标识,当 remoteIdentity 选为 address 时,remoteAddress 必填,更多详见产品说明文档。
IKESet.localFqdnName String IKE 配置,本端标识,当 localIdentity 选为 fqdn 时,localFqdnName 必填,更多详见产品说明文档。
IKESet.remoteFqdnName String IKE 配置,对端标识,当 remoteIdentity 选为 fqdn 时,remoteFqdnName 必填,更多详见产品说明文档。
IKESet.dhGroupName String IKE 配置,DH group,指定 IKE 交换密钥时使用的 DH 组,可选值:'group1','group2','group5','group14','group24',更多详见产品说明文档。
IKESet.ikeSaLifetimeSeconds Int IKE 配置,IKE SA Lifetime,单位:秒,设置 IKE SA 的生存周期,取值范围:60-604800,更多详见产品说明文档。
IKESet.encryptAlgorithm String IPsec 配置,加密算法,取值:'3des-cbc','aes-cbc-128','aes-cbc-192','aes-cbc-256','des-cbc','null',默认为3des-cbc,更多详见产品说明文档。

IPsec 配置详情

参数名称 必选 类型 描述
IPsecSet.integrityAlgorith String IPsec 配置,认证算法:可选值:'md5','sha',默认为md5,更多详见产品说明文档。
IPsecSet.ipsecSaLifetimeSeconds Int IPsec 配置,IPsec SA lifetime(s):单位秒,取值范围:180-604800,更多详见产品说明文档。
IPsecSet.ipsecSaLifetimeTraffic Int IPsec 配置,IPsec SA lifetime(KB):单位KB,取值范围:2560-604800,更多详见产品说明文档。
IPsecSet.pfsDhGroup String IPsec 配置,PFS:可选值:'null','dh-group1','dh-group14','dh-group2','dh-group24','dh-group5',默认为 null,更多详见产品说明文档。

3. 输出参数

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码

参数名称 类型 描述
code Int 错误码,0:成功,其他值:失败
message String 错误信息
data.taskId Int 任务ID,操作结果可以用taskId查询,详见 查询任务执行结果接口

4. 错误码表

错误码 描述
InvalidVpc.NotFound 无效的 VPC。VPC 资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询 VPC。
InvalidVpnGw.NotFound 无效的 VPN 网关。VPN 网关资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeVpnGw 接口查询 VPN 网关。
InvalidUserGw.NotFound 无效的对端网关。对端网关资源不存在,请再次核实您输入的资源信息是否正确,可通过 DescribeUserGw 接口查询对端网关。
InvalidVpnConnName VPN 名称不合法。可任意命名,但不得超过60个字符。
VpnConnLimitExceeded 您已经达到指定区域vpn通道资源申请数量上限。如果需要更多资源,请联系客服申请。更多 vpc 资源限制信息详见 VPC 使用限制

5. 示例

输入

  https://vpc.api.qcloud.com/v2/index.php?Action=AddVpnConnEx
  &<公共请求参数>
  &vpcId=vpc-amhnnao5
  &userGwId=cgw-e098slul
  &vpnGwId=vpngw-dystbrkv
  &userGwCidrBlock.0=10.56.20.1/24
  &preSharedKey=dgdgd33

输出

{
    "code": 0,
    "message": "",
    "data": {
        "vpnGwId": "vpngw-dystbrkv",
        "userGwId": "cgw-e098slul",
        "vpnConnId": 0,
        "taskId": 12613,
        "vpnConnStatus": 0,
        "preSharedKey": "dgdgd33",
        "userGwSubnetList": [
            "10.56.20.1/24"
        ]
    }
}