DescribeRoutes

1. 接口描述

本接口用于查询路由列表。用户可以根据ID、名称等信息来搜索Route信息。路由列表包括系统生成的以及用户创建的路由。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
routeIds	否	Array of String	根据路由ID过滤。 最多同时传入100个ID。
vpcId	否	String	根据路由关联的VPC ID过滤。
ipVersion	否	IpType	根据IP类型过滤。 支持IPv4和IPv6两种类型。
routeType	否	RouteType	根据路由类型过滤。
name	否	String	根据名称类型过滤。 该字段支持模糊搜索。
destinationCidrBlock	否	String	根据Ipv4或IPv6的目标网段过滤。 例如：10.0.1.0/24。
pageSize	否	Integer	返回的分页大小。 可选值范围：[1, 1000]。
pageNum	否	Integer	返回的分页数。 可选值范围：[1, +)。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of RouteInfo	路由列表数据。

4. 代码示例

示例

1. 查询路由列表。

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",
      "ipVersion": "IPv4",
      "name": "Test-Route",
      "nextHopId": "<nextHopId>",
      "nextHopName": "VPC-Default",
      "nextHopType": "VPC",
      "priority": 0,
      "routeId": "<routeId>",
      "sourceCidrBlock": "",
      "type": "RouteTypeSubnet",
      "vpcId": "<vpcId>",
      "vpcName": "VPC-Default"
    }
  ],
  "requestId": "T1626541C-64A5-4E90-B080-D85429447A69",
  "totalCount": 1
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码