All Products
Search
Document Center

DataWorks:ListNetworks

Last Updated:Mar 14, 2025

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringYes

Unique identifier of a Serverless resource group

Serverless_res_group_524257424564736_6831777003XXXXX
PageSizeintegerNo

The number of entries per page.

10
PageNumberintegerNo

The page number.

1
SortBystringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Whether the request is successful

true
PagingInfoobject

The pagination information.

NetworkListarray<object>

The network resources of the serverless resource group.

Dataobject

The information about the network resource of the serverless resource group.

Idlong

The network ID.

1000
ResourceGroupIdstring

The ID of the serverless resource group.

Serverless_res_group_524257424564736_6831777003XXXXX
VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-m2et4f3oc8msfbccXXXXX
VswitchIdstring

The VSwitch ID.

vsw-uf8usrhs7hjd9amsXXXXX
SecurityGroupIdstring

The security group ID.

sg-2ze13vamugr7jenXXXXX
Statusstring

The status of the network resource. Valid values: Pending, Creating, Running, Deleting, and Deleted.

Running
CreateUserstring

The ID of the user who creates the network resource.

11075500042XXXXX
CreateTimelong

The time when the network resource was created. The value is a 64-bit timestamp.

1727055811000
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

100
TotalCountinteger

The total number of entries returned.

100
RequestIdstring

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 timeSummary of changesOperation
2025-01-02The request parameters of the API has changed. The response structure of the API has changedView Change Details