ListRoutes - DataWorks - Alibaba Cloud Documentation Center

Queries a list of routes of a network resource.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	Yes	The ID of the resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
NetworkId	long	No	The network ID.	1000
PageSize	integer	No	The number of entries per page.	100
PageNumber	integer	No	The page number.	1
SortBy	string	No	The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values: Id (Desc/Asc): the route ID DestinationCidr (Desc/Asc): the destination CIDR block of the route CreateTime (Desc/Asc): the time when the route is created Default value: CreateTime Asc.	CreateTime Asc

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
RouteList	array<object>	The list of network resource routing information obtained.
Data	object
Id	long	Route ID	1000
ResourceGroupId	string	Unique identifier of the resource group to which it belongs	Serverless_res_group_524257424564736_6831777003****
ResourceId	string	Unique identifier of network resource	ns-679XXXXXX
DestinationCidr	string	Route destination CIDR	192.168.0.0/16
CreateTime	long	The creation time, which is a 64-bit timestamp.	1727055811000
NetworkId	long	Network Resource ID	1000
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
TotalCount	integer	All data entries	100
RequestId	string	The ID of the request. It is used to locate logs and troubleshoot problems.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "PagingInfo": {
    "RouteList": [
      {
        "Id": 1000,
        "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003****",
        "ResourceId": "ns-679XXXXXX",
        "DestinationCidr": "192.168.0.0/16",
        "CreateTime": 1727055811000,
        "NetworkId": 1000
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-01-23	The request parameters of the API has changed	View Change Details
2025-01-02	The request parameters of the API has changed. The response structure of the API has changed	View Change Details