DescribeRoutes
DescribeRoutes
1. API Description
This API is used to query the details of routes. You can filter the query results with the route ID or name.
2. Input Parameters
The following request parameter list only provides API request parameters.
routeIds
No
Array of String
Route ID(s).
ipVersion
No
String
IP type.
The optional values are as follows:
IPv4
, IPv6
type
No
String
Route type.
The optional values are as follows: RouteTypeSubnet
, RouteTypeStatic
name
No
String
Route name. Fuzzy query is supported.
cidrBlock
No
String
CIDR block of route.
pageSize
No
Integer
Number of items in the current page result.
Default value: 20;
Maximum value: 1000.
pageNum
No
Integer
Number of pages returned.
Default value: 1.
3. Output Parameters
requestId
String
The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalCount
Integer
Number of routes meeting the filtering conditions.
4. Code Example
Query all the available routes with a CIDR block of 10.0.0.0/24
.
5. Developer Resources
Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.
6. Error Codes
No error codes related to the API business logic. For other error codes, see Common Error Codes.
Last updated