Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to query VPN gateway routes.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeVpnGatewayRoutes. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
VpnGatewayId | Yes | String | Instance ID of the VPN gateway |
Filters.N | No | Array of Filter | Filter condition. Valid values: DestinationCidr , InstanceId , and InstanceType . |
Offset | No | Integer | Offset. Default value: 0 |
Limit | No | Integer | Number of returned results per page. Default value: 20; maximum value: 100 |
Parameter Name | Type | Description |
---|---|---|
Routes | Array of VpnGatewayRoute | Destination routes of the VPN gateway |
TotalCount | Integer | Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query destination routes of a VPN gateway.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpnGatewayRoutes
<Common request parameters>
{
"VpnGatewayId": "vpngw-7lhl5331",
"Offset": "0"
}
{
"Response": {
"Routes": [
{
"RouteId": "vpnr-h53fo5tv",
"DestinationCidrBlock": "10.0.0.0/16",
"Status": "ENABLE",
"InstanceId": "vpnx-f99clft2",
"InstanceType": "VPNCONN",
"Priority": 0,
"Type": "Static",
"CreateTime": "2022-12-05 11:02:44",
"UpdateTime": "2022-12-05 11:02:44"
}
],
"TotalCount": 1,
"RequestId": "cf5ec1b0-ec85-4e28-bc05-763c617b57a0"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | An internal error occurred. |
InvalidParameter | A parameter error occurred. |
InvalidParameter.FilterInvalidKey | The specified filter condition does not exist. |
InvalidParameterValue.Malformed | Invalid input parameter format. |
InvalidParameterValue.Range | The parameter value is not in the specified range. |
LimitExceeded | Quota limit is reached. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
UnknownParameter | Unknown parameter error. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?