1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (CreateVpnGateway) is used to create VPN gateways.
Default interface request rate limit: 100 times per second.
Interface update time: 2020-11-12 00:12:20.
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: CreateVpnGateway |
| 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-ngenl4az |
| VpnGatewayName | Yes | No | String | VPN gateway name, up to 60 bytes in length. Example: demo_POSTPAID_VPNGW |
| InstanceChargeType | No | No | String | VPN gateway billing mode. PREPAID: prepaid, i.e., monthly subscription, POSTPAID_BY_HOUR: postpaid, i.e., pay-as-you-go. The default is POSTPAID_BY_HOUR. If a prepaid mode is specified, the parameter InstanceChargePrepaid is required. Example: POSTPAID_BY_HOUR |
| InternetMaxBandwidthOut | Yes | No | Uint64 | Public network bandwidth setting. Available bandwidth options: 5, 10, 20, 50, 100. Unit: Mbps. Example: 5 |
| InstanceChargePrepaid | No | No | InstanceChargePrepaid | Prepaid mode, namely setting of parameters related to monthly subscription. Through this parameter, you can specify the duration of purchase for monthly subscription instances, whether to set auto-renewal, and other attributes. This parameter is required when the specified instance is subject to a payment mode of prepaid. Example:View |
| Zone | No | No | String | Availability zone. For example, ap-region-2. Example: ap-region |
| Type | No | No | String | VPN gateway type. Value CCN indicates CCN type VPN gateway. Example: CCN |
| IspType | No | No | String | Public IP ISP Example: 5 |
| VsModelTag | No | No | String | VPN model tag, e.g., VS_VPN_INTEL. Example: vs_vpn_intel |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| VpnGateway | VpnGateway | VPN gateway 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.VpnConnCidrConflict | The destination IP range conflicts with the CIDR of current VPN tunnel. |
| InvalidVpcId.Malformed | Invalid VPC. The VPC instance ID is invalid. |
| InvalidVpcId.NotFound | Invalid VPC. The VPC resource does not exist. |
| InvalidParameterValue | The parameter value is invalid. |