私有网络 创建VPN通道 - API文档

1. 接口描述

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

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

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

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

2. 输入参数

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

3. 输出参数

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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