GetNetwork-阿里云帮助中心

Queries the information about a network resource.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:GetNetwork

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The network ID.	1000

Response elements

Element	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful.	true
Network	object	The information about the network resource.
Id	integer	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: 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
CreateUser	string	The ID of the user who creates the network resource.	11075500042XXXXX
CreateTime	integer	The time when the network resource was created. The value is a 64-bit timestamp.	1727055811000
RequestId	string	The request ID.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.