1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (CreateVpnConnection) is used to create a VPN tunnel.
Default interface request rate limit: 100 times per second.
Interface update time: 2019-01-18 01:22:36.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateVpnConnection |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| VpcId | Yes | No | String | VPC instance ID, which can be obtained through the VpcId returned by the DescribeVpcs API. Example: vpc-gapcv96p |
| VpnGatewayId | Yes | No | String | VPN gateway instance ID. Example: vpngw-1w9tue3d |
| CustomerGatewayId | Yes | No | String | Customer gateway ID, e.g., cgw-2wqq41m9, which can be queried through the DescribeCustomerGateways API. Example: cgw-qa9sxpy7 |
| VpnConnectionName | Yes | No | String | Channel name. The name can be given arbitrarily, but must not exceed 60 characters. Example: demo_CONN |
| PreShareKey | Yes | No | String | Preshared key. Example: 654321 |
| SecurityPolicyDatabases | Yes | No | Array of SecurityPolicyDatabase | SPD policy group, for example: {"10.0.0.5/24":["172.jkt.10.5/16"]}. Here, 10.0.0.5/24 represents the VPC’s private IP range, and 172.jkt.10.5/16 represents the IDC’s IP range. Users can specify which IP ranges within the VPC are allowed to communicate with specific IP ranges in their IDC. Example:View |
| IKEOptionsSpecification | No | No | IKEOptionsSpecification | IKE (Internet Key Exchange) configuration, which involves a set of self-protection mechanisms for user-configured network security protocols. Example:View |
| IPSECOptionsSpecification | No | No | IPSECOptionsSpecification | IPSec session security settings. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| VpnConnection | VpnConnection | Tunnel instance object. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.Malformed | Invalid input format. |
| InvalidParameter.Coexist | The parameters must not be specified simultaneously. |
| InvalidParameterValue.VpcCidrConflict | The destination IP range conflicts with the current VPC's CIDR. |