Obtaining Network Resources

Function

This API is used to obtain information about created network resources in the system. This API is used when you need to query the network resource list recorded in the system when monitoring network status, planning resources, locating network faults, or auditing. Before using this API, ensure that you have the required permission and the network resources exist in the system. After the query, the API returns the network resource list, including the resource ID, type, status, and creation time. If you do not have the required permission, the network resources do not exist in the system, or the query parameter is incorrect, the API will return an error message.

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

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 4** NetworkListMetadata
Parameter	Type	Description
continue	String	Definition: Next query position in pagination query. Range: N/A
remainingItemCount	Integer	Definition: Number of remaining resources. Range: N/A

**Table 5** Network
Parameter	Type	Description
apiVersion	String	Definition: API version of the resource. Range: v1: The current resource version is v1.
kind	String	Definition: Resource type. Range: Network
metadata	NetworkMetadata object	Definition: Metadata of a network resource.
spec	NetworkSpec object	Definition: Specifications of a network resource.
status	NetworkStatus object	Definition: Status of a network resource.

**Table 6** NetworkMetadata
Parameter	Type	Description
name	String	Definition: Network resource ID. Range: N/A
creationTimestamp	String	Definition: Network creation time. For example, 2025-11-01T03:49:41Z. Range: N/A
labels	NetworkMetadataLabels object	Definition: Network labels.
annotations	NetworkMetadataAnnotations object	Definition: Network annotations.

**Table 7** NetworkMetadataLabels
Parameter	Type	Description
os.modelarts/name	String	Definition: Displayed name of a resource pool. *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.
os.modelarts/workspace.id	String	Definition: Workspace ID. [For details about how to obtain the ID, see Querying the Workspace List.] (tag:hc) Range: N/A

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

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

**Table 10** NetworkConnection
Parameter	Type	Description
peerConnectionList	Array of objects	Definition: Peering connections.

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

**Table 12** NetworkConnectionStatus
Parameter	Type	Description
peerConnectionStatus	Array of PeerConnectionStatus objects	Definition: Status of peering connections.
sfsTurboStatus	Array of SfsTurboConnectionStatus objects	Definition: Status of SFS Turbo accessible to the network.

**Table 13** PeerConnectionStatus
Parameter	Type	Description
peerVpcId	String	Definition: VPC ID of the peer end. Range: N/A
peerSubnetId	String	Definition: Subnet ID of the peer end. Range: N/A
defaultGateWay	Boolean	Definition: Specifies whether to create a default route. Range: false (default value, indicating that no default route is created)
phase	String	Definition: Connection status of the network. Range: Connecting: The network is being connected. Active: The network is connected properly. Abnormal: The network connection is abnormal.

**Table 14** SfsTurboConnectionStatus
Parameter	Type	Description
name	String	Definition: Name of the SFS Turbo instance. Range: N/A
sfsId	String	Definition: ID of the SFS Turbo instance. Range: N/A
connectionType	String	Definition: association mode. Range: VpcPort: passthrough through attached NICs Peering: connection through VPC peering
ipAddr	String	Definition: Access address of SFS Turbo. Range: N/A
status	String	Definition: Connection status of SFS Turbo. Range: Active: The SFS connection is normal. Abnormal: The SFS connection is abnormal. Creating: The SFS connection is being set up. Deleting: The SFS connection is being deleted.

Example Requests

Obtain resource pools.

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

{ }

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" : { }
    }
  } ]
}