Obtaining Network Resources

Function

This API is used to obtain network resources.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/networks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Number of resources returned in a single pagination query Constraints: N/A Range: 0 to 500 Default Value: 500
continue	No	String	Definition: Offset parameter of the pagination query. The value is obtained from the metadata.continue field in the response to the last pagination query. An empty value indicates no offset. Constraints: N/A Range: N/A Default Value: N/A
labelSelector	No	String	Definition: Tag filtering query Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
apiVersion	String	Definition: API version of a resource. Constraints: N/A Range: v1: The current resource version is v1. Default Value: N/A
kind	String	Definition: Resource type. Constraints: N/A Range: NetworkList: networks Default Value: N/A
metadata	metadata object	Definition: Metadata of network resources. Constraints: N/A Range: N/A Default Value: N/A
items	Array of Network objects	Definition: Network resource list. Constraints: N/A Range: N/A Default Value: N/A

**Table 4** metadata
Parameter	Type	Description
continue	String	Definition: Offset parameter of the pagination query. Constraints: This parameter is optional. Range: The value is obtained from the metadata.continue field in the response to the last pagination query. An empty value indicates no offset. Default Value: N/A
remainingItemCount	Integer	Definition: Number of remaining resources in a pagination query. Default Value: N/A

**Table 5** Network
Parameter	Type	Description
apiVersion	String	Definition: API version of a resource. Constraints: N/A Range: v1: The current resource version is v1. Default Value: N/A
kind	String	Definition: Resource type. Constraints: N/A Range: Network Default Value: N/A
metadata	NeworkMetadata object	Definition: Metadata of a network resource. Constraints: N/A Range: N/A Default Value: N/A
spec	NetworkSpec object	Definition: Specifications of a network resource. Constraints: N/A Range: N/A Default Value: N/A
status	NetworkStatus object	Definition: Status of a network resource. Constraints: N/A Range: N/A Default Value: N/A

**Table 6** NeworkMetadata
Parameter	Type	Description
name	String	Definition: Network resource ID. Constraints: N/A Range: N/A Default Value: N/A
creationTimestamp	String	Definition: Network creation time. Example: 2025-11-01T03:49:41Z. Constraints: N/A Range: N/A Default Value: N/A
labels	NetworkMetadataLabels object	Definition: Network labels. Constraints: N/A Range: N/A Default Value: N/A
annotations	NetworkMetadataAnnotations object	Definition: Network annotations. Constraints: N/A Range: N/A Default Value: N/A

**Table 7** NetworkMetadataLabels
Parameter	Type	Description
os.modelarts/name	String	Definition: Display name of a resource pool. Constraints: N/A *Range: The value can contain 4 to 32 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Digits and hyphens (-) are allowed. Default Value: N/A
os.modelarts/workspace.id	String	Definition: Workspace ID. For details about how to obtain the ID, see Querying the Workspace List. Constraints: N/A Range: N/A Default Value: 0

**Table 8** NetworkMetadataAnnotations
Parameter	Type	Description
os.modelarts/description	String	Definition: Network description. Constraints: N/A Range: The value cannot contain these characters: !<>=&"'. Default Value: N/A

**Table 9** NetworkSpec
Parameter	Type	Description
cidr	String	Definition: CIDR value of a network. Constraints: N/A Range: 172.16.0.0/12 to 172.16.0.0/24 192.168.0.0/16 to 192.168.0.0/24 Default Value: N/A
connection	NetworkConnection object	Definition: Connection information between the current network and other resources. Constraints: N/A Range: N/A Default Value: N/A

**Table 10** NetworkConnection
Parameter	Type	Description
peerConnectionList	Array of peerConnectionList objects	Definition: Peering connections. Constraints: N/A Range: N/A Default Value: N/A

**Table 11** peerConnectionList
Parameter	Type	Description
peerVpcId	String	Definition: Peer network ID. Constraints: N/A Range: N/A Default Value: N/A
peerSubnetId	String	Definition: Peer subnet ID. Constraints: N/A Range: N/A Default Value: N/A
defaultGateWay	Boolean	Definition: Specifies whether to create a default route. Constraints: N/A Range: true: A default route is created. false: A default route is not created. Default Value: false

**Table 12** NetworkStatus
Parameter	Type	Description
phase	String	Definition: Current status of a network resource. Constraints: N/A Range: Creating: The network is being created. Active: The network is functional. Abnormal: The network is abnormal. Default Value: N/A
connectionStatus	NetworkConnectionStatus object	Definition: Connection status between the network and other cloud services. Constraints: N/A Range: N/A Default Value: N/A

**Table 13** NetworkConnectionStatus
Parameter	Type	Description
peerConnectionStatus	Array of peerConnectionStatus objects	Definition: Peering connection statuses Constraints: N/A Range: N/A Default Value: N/A
sfsTurboStatus	Array of sfsTurboStatus objects	Definition: Statuses of network connection to SFS Turbo. Constraints: N/A Range: N/A Default Value: N/A

**Table 14** peerConnectionStatus
Parameter	Type	Description
peerVpcId	String	Definition: Peer network ID. Constraints: N/A Range: N/A Default Value: N/A
peerSubnetId	String	Definition: Peer subnet ID. Constraints: N/A Range: N/A Default Value: N/A
defaultGateWay	Boolean	Definition: Specifies whether to create a default route. Constraints: N/A Range: true: A default route is created. false: A default route is not created. Default Value: false
phase	String	Definition: Peer connection status. Constraints: N/A Range: Connecting: The network is being connected. Active: The network is connected properly. Abnormal: The network connection is abnormal. Default Value: N/A

**Table 15** sfsTurboStatus
Parameter	Type	Description
sfsId	String	Definition: ID of the connected SFS Turbo file system. Constraints: N/A Range: N/A Default Value: N/A
name	String	Definition: Name of the connected SFS Turbo file system. Constraints: N/A Range: N/A Default Value: N/A
status	String	Definition: Connection status of the SFS Turbo file system. Constraints: N/A Range: Active: The SFS connection is normal. Abnormal: The SFS connection is abnormal. Default Value: N/A
ipAddr	String	Definition: Access address of the connected SFS Turbo file system. Constraints: N/A Range: N/A Default Value: N/A

Example Requests

Obtain resource pools.

GET https://{endpoint}/v2/{project_id}/pools

{ }

Example Responses

Status code: 200

{
  "kind" : "NetworkList",
  "apiVersion" : "v1",
  "metadata" : { },
  "items" : [ {
    "kind" : "Network",
    "apiVersion" : "v1",
    "metadata" : {
      "name" : "network-7a03-86c13962597848eeb29c5861153a391f",
      "creationTimestamp" : "2022-09-16T09:44:59Z",
      "labels" : {
        "os.modelarts/name" : "network-7a03",
        "os.modelarts/workspace.id" : "0"
      },
      "annotations" : { }
    },
    "spec" : {
      "cidr" : "192.168.128.0/17",
      "connection" : { }
    },
    "status" : {
      "phase" : "Active",
      "connectionStatus" : { }
    }
  } ]
}