ListNetworks - DataWorks - Alibaba Cloud Documentation Center

Queries a list of network resources of a serverless resource group.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListNetworks	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	Yes	The ID of the resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
PageSize	integer	No	The number of entries per page.	10
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 network ID Status (Desc/Asc): the network status CreateUser (Desc/Asc): the user who created the network CreateTime (Desc/Asc): the time when the network was created Default value: CreateTime Asc.	CreateTime Asc

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
NetworkList	array<object>	The network resources of the serverless resource group.
Data	object	The information about the network resource of the serverless resource group.
Id	long	The network ID.	1000
ResourceGroupId	string	The ID of the serverless resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-m2et4f3oc8msfbccXXXXX
VswitchId	string	The VSwitch ID.	vsw-uf8usrhs7hjd9amsXXXXX
SecurityGroupId	string	The security group ID.	sg-2ze13vamugr7jenXXXXX
Status	string	The status of the network resource. Valid values: Pending, Creating, Running, Deleting, and Deleted.	Running
CreateUser	string	The ID of the user who creates the network resource.	11075500042XXXXX
CreateTime	long	The time when the network resource was created. The value is a 64-bit timestamp.	1727055811000
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

Sample success responses

JSONformat

{
  "Success": true,
  "PagingInfo": {
    "NetworkList": [
      {
        "Id": 1000,
        "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003XXXXX",
        "VpcId": "vpc-m2et4f3oc8msfbccXXXXX",
        "VswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
        "SecurityGroupId": "sg-2ze13vamugr7jenXXXXX",
        "Status": "Running",
        "CreateUser": "11075500042XXXXX",
        "CreateTime": 1727055811000
      }
    ],
    "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-02	The request parameters of the API has changed. The response structure of the API has changed	View Change Details