All Products
Search
Document Center

DataWorks:GetNetwork

Last Updated:Jan 12, 2026

Queries the information about 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:GetNetworkget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdlongYes

The network ID.

1000

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Indicates whether the request was successful.

true
Networkobject

The information about the network resource.

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: The network resource is waiting to be created.
  • Creating: The network resource is being created.
  • Running: The network resource is running as expected.
  • Deleting: The network resource is being deleted.
  • Deleted: The network resource is 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
RequestIdstring

The request ID.

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Network": {
    "Id": 1000,
    "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003XXXXX",
    "VpcId": "vpc-m2et4f3oc8msfbccXXXXX",
    "VswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
    "SecurityGroupId": "sg-2ze13vamugr7jenXXXXX",
    "Status": "Running",
    "CreateUser": "11075500042XXXXX",
    "CreateTime": 1727055811000
  },
  "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
No change history