创建VPN通道

1. 接口描述

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

本接口（CreateVpnConnection）用于创建VPN通道。

说明：

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

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 创建VPN通道

创建VPN通道

输入示例

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

{
    "VpnConnectionName": "TEST_CONN",
    "PreShareKey": "6325ac",
    "VpcId": "vpc-gapcv96p",
    "Tags": [
        {
            "Value": "shanghai",
            "Key": "city"
        }
    ],
    "IPSECOptionsSpecification": {
        "PfsDhGroup": "NULL",
        "EncryptAlgorithm": "3DES-CBC",
        "IntegrityAlgorith": "SHA1"
    },
    "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-gapcv96p",
            "VpnConnectionId": "vpnx-axc13cega",
            "VpnConnectionName": "TEST_CONN",
            "VpnGatewayId": "vpngw-1w9tue3d",
            "CustomerGatewayId": "cgw-qa9sxpy7",
            "State": "PENDING",
            "PreShareKey": "6325ac",
            "NegotiationType": "active",
            "DpdEnable": -1,
            "DpdTimeout": "30",
            "DpdAction": "clear",
            "VpnProto": "IPSEC",
            "EncryptProto": "IKE",
            "RouteType": "STATIC",
            "CreatedTime": "0000-00-00 00:00:00",
            "NetStatus": "AVAILABLE",
            "SecurityPolicyDatabaseSet": [],
            "IKEOptionsSpecification": {
                "PropoEncryAlgorithm": "3DES-CBC",
                "PropoAuthenAlgorithm": "MD5",
                "ExchangeMode": "MAIN",
                "LocalIdentity": "ADDRESS",
                "RemoteIdentity": "ADDRESS",
                "LocalAddress": "58.211.2.5",
                "RemoteAddress": "1.2.3.4",
                "LocalFqdnName": "local-name",
                "RemoteFqdnName": "remote-name",
                "DhGroupName": "GROUP1",
                "IKESaLifetimeSeconds": 86400,
                "IKEVersion": "IKEV1"
            },
            "IPSECOptionsSpecification": {
                "EncryptAlgorithm": "3DES-CBC",
                "IntegrityAlgorith": "SHA1",
                "IPSECSaLifetimeSeconds": 3600,
                "IPSECSaLifetimeTraffic": 1843200,
                "PfsDhGroup": "NULL"
            },
            "EnableHealthCheck": false,
            "HealthCheckLocalIp": "169.254.168.2",
            "HealthCheckRemoteIp": "169.254.168.1",
            "HealthCheckStatus": "AVAILABLE",
            "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。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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