Retrieve Paginated Network Routes Using the ListRoutes API - DataWorks - Alibaba Cloud - DataWorks

Operation description

This API operation is available for all DataWorks editions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	Yes	The ID of the resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
NetworkId	integer	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 elements

Element	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
RouteList	array<object>	The routes of the network resource.
	object
Id	integer	The route ID.	1000
ResourceGroupId	string	The ID of the resource group.	Serverless_res_group_524257424564736_6831777003****
ResourceId	string	The ID of the network resource.	ns-679XXXXXX
DestinationCidr	string	The destination CIDR block of the route.	192.168.0.0/16
CreateTime	integer	The creation time, which is a 64-bit timestamp.	1727055811000
NetworkId	integer	The network resource ID.	1000
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
TotalCount	integer	The total number of entries returned.	100
RequestId	string	The ID of the request. It is used to locate logs and troubleshoot problems.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.