Contents:
1. API Description
Domain name for API request: vpc.tencentcloudapi.com.
This API (CreateVpnConnection) is used to create VPN tunnels.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: CreateVpnConnection |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12 |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| VpcId | Yes | String | VPC instance ID. You can obtain the parameter value from the VpcId field value in the returned result of API DescribeVpcs. |
| VpnGatewayId | Yes | String | VPN gateway instance ID. |
| CustomerGatewayId | Yes | String | Customer gateway ID, such as cgw-2wqq41m9. You can query the customer gateway via the API DescribeCustomerGateways. |
| VpnConnectionName | Yes | String | VPN tunnel name, which is limited to 60 characters. |
| PreShareKey | Yes | String | Pre-shared key. |
| SecurityPolicyDatabases.N | Yes | Array of SecurityPolicyDatabase | SPD policy group, such as {"10.0.0.5/24":["172.123.10.5/16"]}, where 10.0.0.5/24 is an IP address range of the VPC and 172.123.10.5/16 is an IP address range of the IDC. You can specify which IP address ranges in the VPC can communicate with which IP address ranges in your IDC. |
| IKEOptionsSpecification | No | IKEOptionsSpecification | IKE (Internet Key Exchange) configuration. IKE is provided with a self-protection mechanism. The network security protocol is configured by the user. |
| IPSECOptionsSpecification | No | IPSECOptionsSpecification | IPSec configuration. The IPSec secure session configuration is provided by Tencent Cloud. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| VpnConnection | VpnConnection | Tunnel instance object. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.Coexist | Parameters specified conflict with each other. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.VpcCidrConflict | Destination IP address range conflicts with CIDR of the current VPC. |
5. Example
Example 1 Create a VPN tunnel
Input example
https://vpc.tencentcloudapi.com/?Action=CreateVpnConnection
&Version=2017-03-12
&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
&<Common request parameters>Output example
{
"Response": {
"RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b",
"VpnConnection": {
"CustomerGatewayId": "cgw-qa9sxpy7",
"State": "PENDING",
"VpcId": "vpc-gapcv96p",
"VpnConnectionName": "TEST_CONN",
"VpnGatewayId": "vpngw-1w9tue3d"
}
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.