有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

说明:

本接口为异步接口,可调用 DescribeVpcTaskResult 接口查询任务执行结果,待任务执行成功后再进行其他操作。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateVpnConnection。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpnGatewayId String VPN网关实例ID。
示例值:vpngw-1w9tue3d
CustomerGatewayId String 对端网关ID。例如:cgw-2wqq41m9,可通过DescribeCustomerGateways接口查询对端网关。
示例值:cgw-qa9sxpy7
VpnConnectionName String 通道名称,可任意命名,但不得超过60个字符。
示例值:TEST_CONN
PreShareKey String 预共享密钥。
示例值:654321
VpcId String VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
CCN VPN 形的通道 可以不传VPCID
示例值:vpc-gapcv96p
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 是否支持隧道内健康检查,默认为False。
HealthCheckLocalIp String 健康检查本端地址,默认值为随机在169.254.128.0/17分配一个IP。
HealthCheckRemoteIp String 健康检查对端地址,默认值为随机在169.254.128.0/17分配一个IP。
RouteType String 通道类型, 例如:["STATIC", "StaticRoute", "Policy"]
示例值:STATIC
NegotiationType String 协商类型,默认为active(主动协商)。可选值:active(主动协商),passive(被动协商),flowTrigger(流量协商)
示例值:active
DpdEnable Integer DPD探测开关。默认为0,表示关闭DPD探测。可选值:0(关闭),1(开启)
示例值:1
DpdTimeout String DPD超时时间。即探测确认对端不存在需要的时间。dpdEnable为1(开启)时有效。默认30,单位为秒
示例值:30
DpdAction String DPD超时后的动作。默认为clear。dpdEnable为1(开启)时有效。可取值为clear(断开)和restart(重试)
示例值:clear
Route CreateVpnConnRoute 创建通道路由信息。
BgpConfig BgpConfig BGP配置。

3. 输出参数

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

4. 示例

示例1 创建VPN通道

创建VPN通道

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpnConnection
<公共请求参数>

{
    "VpnConnectionName": "TEST_CONN",
    "PreShareKey": "654321",
    "VpcId": "vpc-gapcv96p",
    "Tags": [
        {
            "Value": "shanghai",
            "Key": "city"
        }
    ],
    "IPSECOptionsSpecification": {
        "PfsDhGroup": "NULL",
        "EncryptAlgorithm": "3DES-CBC",
        "IntegrityAlgorith": "MD5"
    },
    "SecurityPolicyDatabases": [
        {
            "LocalCidrBlock": "10.8.4.0/24",
            "RemoteCidrBlock": [
                "58.211.1.0/24"
            ]
        }
    ],
    "VpnGatewayId": "vpngw-1w9tue3d",
    "CustomerGatewayId": "cgw-qa9sxpy7",
    "IKEOptionsSpecification": {
        "IKEVersion": "IKEV1",
        "RemoteIdentity": "ADDRESS",
        "PropoAuthenAlgorithm": "MD5",
        "RemoteAddress": "1.2.3.4",
        "LocalIdentity": "ADDRESS",
        "LocalAddress": "58.211.2.5",
        "ExchangeMode": "MAIN",
        "PropoEncryAlgorithm": "3DES-CBC",
        "DhGroupName": "GROUP1"
    }
}

输出示例

{
    "Response": {
        "VpnConnection": {
            "VpcId": "vpc-kozprpc9",
            "VpnConnectionId": "vpnx-p0j11j28",
            "VpnConnectionName": "test-con",
            "VpnGatewayId": "vpngw-ecvft20x",
            "CustomerGatewayId": "cgw-7lhl5331",
            "State": "PENDING",
            "PreShareKey": "123456",
            "NegotiationType": "",
            "DpdEnable": -1,
            "DpdTimeout": "",
            "DpdAction": "",
            "VpnProto": "IPSEC",
            "EncryptProto": "IKE",
            "RouteType": "STATIC",
            "CreatedTime": "0000-00-00 00:00:00",
            "NetStatus": "",
            "SecurityPolicyDatabaseSet": [],
            "IKEOptionsSpecification": {
                "PropoEncryAlgorithm": "AES-CBC-256",
                "PropoAuthenAlgorithm": "SHA",
                "ExchangeMode": "AGGRESSIVE",
                "LocalIdentity": "ADDRESS",
                "RemoteIdentity": "ADDRESS",
                "LocalAddress": "122.152.199.99",
                "RemoteAddress": "39.97.38.104",
                "LocalFqdnName": "",
                "RemoteFqdnName": "",
                "DhGroupName": "GROUP2",
                "IKESaLifetimeSeconds": 86400,
                "IKEVersion": "IKEV1"
            },
            "IPSECOptionsSpecification": {
                "EncryptAlgorithm": "AES-CBC-256",
                "IntegrityAlgorith": "SHA1",
                "IPSECSaLifetimeSeconds": 3600,
                "IPSECSaLifetimeTraffic": 1843200,
                "PfsDhGroup": "NULL"
            },
            "EnableHealthCheck": false,
            "HealthCheckLocalIp": "",
            "HealthCheckRemoteIp": "",
            "HealthCheckStatus": "",
            "TagSet": []
        },
        "RequestId": "4b71dd4d-a3ee-4ac1-b99a-99d65f6443fd"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.Coexist 参数不支持同时指定。
InvalidParameterValue.Duplicate 入参重复。
InvalidParameterValue.Empty 缺少参数。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.TagDuplicateKey 标签键重复。
InvalidParameterValue.TagDuplicateResourceType 重复的标签资源类型。
InvalidParameterValue.TagInvalidKey 标签键无效。
InvalidParameterValue.TagInvalidKeyLen 标签键长度无效。
InvalidParameterValue.TagInvalidVal 标签值无效。
InvalidParameterValue.TagKeyNotExists 标签键不存在。
InvalidParameterValue.TagNotAllocatedQuota 标签没有分配配额。
InvalidParameterValue.TagNotExisted 该标签不存在。
InvalidParameterValue.TagNotSupportTag 不支持的标签。
InvalidParameterValue.TagResourceFormatError 标签资源格式错误。
InvalidParameterValue.TagTimestampExceeded 标签时间戳超配。
InvalidParameterValue.TagValNotExists 标签值不存在。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
InvalidParameterValue.VpcCidrConflict 目的网段和当前VPC的CIDR冲突。
InvalidParameterValue.VpnConnBgpTunnelCidrConflict 当前BGP隧道网段:%(key)s和已有BGP隧道网段:%(value)s重叠。
InvalidParameterValue.VpnConnBgpTunnelCidrMask BGP隧道网段必须为掩码为30的网段。
InvalidParameterValue.VpnConnBgpTunnelCidrNotSupported 云端或用户端BGP地址:%(value)s必须在BGP隧道网段%(key)s内。
InvalidParameterValue.VpnConnCidrConflict 目的网段和当前VPN通道的CIDR冲突。
InvalidParameterValue.VpnConnHealthCheckIpConflict VPN通道探测ip冲突。
LimitExceeded 超过配额限制。
LimitExceeded.TagKeyExceeded 标签键已达到上限。
LimitExceeded.TagKeyPerResourceExceeded 每个资源的标签键已达到上限。
LimitExceeded.TagNotEnoughQuota 没有足够的标签配额。
LimitExceeded.TagQuota 标签配额已满,无法创建资源。
LimitExceeded.TagQuotaExceeded 标签配额已达到上限。
LimitExceeded.TagTagsExceeded 标签键的数目已达到上限。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InvalidState 资源状态不合法。
UnsupportedOperation.TagAllocate 标签正在分配中。
UnsupportedOperation.TagFree 标签正在释放中。
UnsupportedOperation.TagNotPermit 标签没有权限。
UnsupportedOperation.TagSystemReservedTagKey 不支持使用系统预留的标签键。
UnsupportedOperation.VpnUnsupportedBgp VPN不支持BGP
UnsupportedOperation.VpnUnsupportedBgpAsnEqual 对端网关BGP ASN和已有的通道对端或云上VPN的BGP ASN相同。
UnsupportedOperation.VpnUnsupportedNotExistBgpAsn VPN未配置BGP ASN。