Help Center/ ModelArts/ API Reference/ Network Management/ Obtaining Network Resources

Updated on 2025-05-30 GMT+08:00

View PDF

Obtaining Network Resources

Function

This API is used to obtain network resources.

URI

GET /v1/{project_id}/networks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
workspaceId	No	String	Workspace ID. The default value is 0.
labelSelector	No	String	Filter by label.
limit	No	Integer	Number of records returned for a single pagination query.
continue	No	String	Previous query location in pagination query.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
apiVersion	String	API version. Options: v1
kind	String	Resource type. Options: NetworkList: networks
metadata	NeworkListMetadata object	Metadata of network resources.
items	Array of Network objects	Network resources.

**Table 4** NeworkListMetadata
Parameter	Type	Description
continue	String	Next query position in pagination query.
remainingItemCount	Integer	Remaining resources.

**Table 5** Network
Parameter	Type	Description
apiVersion	String	API version. Options: v1
kind	String	Resource type. Options: Network
metadata	NetworkMetadata object	Metadata of network resources.
spec	NetworkSpec object	Description of network resources.
status	NetworkStatus object	Status of network resources.

**Table 6** NetworkMetadata
Parameter	Type	Description
name	String	Automatically generated network name, which is equivalent to networkId.
creationTimestamp	String	Timestamp, for example, 2021-11-01T03:49:41Z.
labels	NetworkMetadataLabels object	Labels of network resources.
annotations	NetworkMetadataAnnotations object	Annotations of network resources.

**Table 7** NetworkMetadataLabels
Parameter	Type	Description
os.modelarts/name	String	Specified network name.
os.modelarts/workspace.id	String	Workspace ID. The default value is 0.

**Table 8** NetworkMetadataAnnotations
Parameter	Type	Description
os.modelarts/description	String	Network resource description, which is used to describe a scenario. The following special characters are not allowed: !<>=&"'

**Table 9** NetworkSpec
Parameter	Type	Description
ipv6enable	Boolean	Whether to enable IPv6. Once IPv6 is enabled, it cannot be disabled.
cidr	String	Network CIDR.
connection	NetworkConnection object	Automatically interconnected endpoint.

**Table 10** NetworkConnection
Parameter	Type	Description
peerConnectionList	Array of PeerConnectionItem objects	Peering connections
sfsTurboConnectionList	Array of SfsTurboConnectionItem objects	SFS Turbo connections through attached NICs

**Table 11** PeerConnectionItem
Parameter	Type	Description
peerVpcId	String	VPC ID of the peer end.
peerSubnetId	String	Subnet ID of the peer end.
defaultGateWay	Boolean	Whether to create a default route. The default value is false.

**Table 12** SfsTurboConnectionItem
Parameter	Type	Description
name	String	Name of an SFS Turbo instance.
sfsId	String	ID of an SFS Turbo instance.

**Table 13** NetworkStatus
Parameter	Type	Description
phase	String	Current network status. Options: Creating: The network is being created. Active: The network is functional. Abnormal: The network malfunctions.
connectionStatus	NetworkConnectionStatus object	Network connection status.

**Table 14** NetworkConnectionStatus
Parameter	Type	Description
peerConnectionStatus	Array of PeerConnectionStatus objects	Peering connection status
sfsTurboStatus	Array of SfsTurboConnectionStatus objects	Status of SFS Turbo accessible to the network

**Table 15** PeerConnectionStatus
Parameter	Type	Description
peerVpcId	String	VPC ID of the peer end.
peerSubnetId	String	Subnet ID of the peer end.
defaultGateWay	Boolean	Whether to create a default route. The default value is false.
phase	String	Network connection status. The options are as follows: Connecting: The network is being connected. Active: The network is connected properly. Abnormal: The network connection is abnormal.

**Table 16** SfsTurboConnectionStatus
Parameter	Type	Description
name	String	Name of an SFS Turbo instance.
sfsId	String	ID of an SFS Turbo instance.
connectionType	String	Connection type. The options are as follows: VpcPort: passthrough through attached NICs Peering: connection through VPC peering
ipAddr	String	SFS Turbo access address.
status	String	Status of the connection to SFS Turbo. The options are as follows: 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}/v1/{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"
      },
      "annotations" : { }
    },
    "spec" : {
      "cidr" : "192.168.128.0/17",
      "connection" : { }
    },
    "status" : {
      "phase" : "Active",
      "connectionStatus" : { }
    }
  } ]
}