1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeVpnGatewayCcnRoutes) is used to query VPN Gateway CCN routes.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-03-31 20:12:32.
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: DescribeVpnGatewayCcnRoutes |
| 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 |
| VpnGatewayId | Yes | No | String | VPN gateway instance ID Example: vpngw-jj72x8gx |
| Offset | No | No | Uint64 | Offset Example: 0 |
| Limit | No | No | Uint64 | Returned quantity Example: 10 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RouteSet | Array of VpngwCcnRoutes | List of CCN routes (IDC IP ranges). Example:View |
| TotalCount | Uint64 | Number of eligible objects. Example: 1 |
| 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 |
|---|---|
| ResourceNotFound | The resource does not exist |
| InternalServerError | Internal operation error. |