1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
Create SSL VPN service
Default interface request rate limit: 20 times per second.
Interface update time: 2023-02-03 22:59:18.
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: CreateVpnGatewaySSLServer |
| 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 | Unique VPC ID, e.g., vpc-7izaqk5h. Example: vpc-cd20bl9o |
| VpnGatewayId | Yes | No | String | VPN instance ID, e.g., vpngw-7izaqk5h. Example: vpngw-1u2xtmbz |
| SSLVpnServerName | Yes | No | String | SSL VPN service name Example: server-name |
| LocalAddress | Yes | No | String | Local IP range Example: 10.0.0.0/16 |
| RemoteAddress | Yes | No | String | Peer IP range Example: 172.0.0.0/16 |
| SSLVpnProtocol | No | No | String | SSL VPN server listening protocol. The default value is UDP. Currently, only UDP is supported (UDP by default). Example: UDP |
| SSLVpnPort | No | No | Int64 | SSL VPN server listening protocol port. The default value is 1194. Currently, only 1194 is supported (1194 by default). Example: 1194 |
| EncryptAlgorithm | No | No | String | Encryption algorithm, AES-128 by default. Only AES-128 is supported in phase I (AES-128 by default). Example: AES-128-CBC |
| IntegrityAlgorith | No | No | String | Encryption algorithm. The default is HMAC-SHA1, supporting only HMAC-SHA1 in phase I (HMAC-SHA1 by default). Example: SHA1 |
| Compress | No | No | Bool | Support for compression. Default is false, which indicates no compression. Only false is supported in phase I (true is 1; false is 0. Default: 0) Example: False |
| MaxConnection | No | No | Int64 | Maximum number of connections. Values: 5, 10, 20, 50, 100 (a default value is required) (Default value: 5) Example: 5 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TaskId | Int64 | Des task taskId Example: |
| SslVpnServerId | String | SSL VPN server instance ID. Example: |
| 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 |
|---|---|
| InvalidParameter | Invalid input parameters. |