1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API is used to query an SSL VPN server.
Default interface request rate limit: 20 times per second.
Interface update time: 2023-02-03 21:00:15.
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: DescribeVpnGatewaySSLServers |
| 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 |
| SSLVpnServerIds | No | No | Array of String | SSL VPN Client Instance ID Example: ['vpns-n5hvzrbk', 'vpns-jbm6ft08'] |
| Filters | No | No | Array of Filter | Filter Criteria Example:View |
| Offset | No | No | Int64 | Offset. Default value: 0 Example: 0 |
| Limit | No | No | Int64 | Returned quantity Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Number of eligible instances. Example: 3 |
| SSLVpnSeverSet | Array of SSLVpnServer | SSL VPN client instance ID. 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 |
|---|---|
| InvalidParameter | Invalid input parameters. |