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. The route list includes both system-generated routes and user-created routes.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
routeIds	No	Array of String	Route ID(s).
vpcId	No	String	Global VPC ID.
ipVersion	No	IpType	IP type. The optional values are as follows: IPv4, IPv6
routeType	No	RouteType	Route type.
name	No	String	Route name. Fuzzy query is supported.
destinationCidrBlock	No	String	Destination CIDR block for IPv4 or IPv6. For example: 10.0.1.0/24.
pageSize	No	Integer	Number of items in the current page result. Available value range: [1, 1000].
pageNum	No	Integer	Number of pages returned. Available value range: [1, +).

3. Output Parameters

Parameter Name	Type	Description
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.
dataSet	Array of RouteInfo	Information on a route.

4. Code Example

Example

Query all the available routes.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeRoutes
<Common Request Params>

Request：
{}

Response：
{
  "dataSet": [
    {
      "cidrBlock": "10.130.0.0/20",
      "createTime": "2025-08-27T03:39:00Z",
      "destinationCidrBlock": "10.130.0.0/20",
      "ipVersion": "IPv4",
      "name": "<name>",
      "nextHopId": "<nextHopId>",
      "nextHopName": "<nextHopName>",
      "nextHopType": "VPC",
      "priority": 0,
      "routeId": "<routeId>",
      "sourceCidrBlock": "",
      "type": "RouteTypeSubnet",
      "vpcId": "<vpcId>",
      "vpcName": "<vpcName>"
    }
  ],
  "requestId": "T1626541C-64A5-4E90-B080-D85429447A69",
  "totalCount": 1
}

5. Developer Resources

Zenlayer Cloud API 2.0 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.​