Help Center/ ModelArts/ API Reference/ Resource Management/ Obtaining a Network Resource

Updated on 2025-11-19 GMT+08:00

View PDF

Obtaining a Network Resource

Function

This API is used to obtain the details of a specified network resource. This API is used when you need to query details about a specified network resource, such as its configuration, status, or attributes. Before using this API, ensure that you have the required permission and the specified network resource exists in the system. After the query, the API returns the details of the specified network resource, including the resource ID, type, status, and configuration parameters. If the specified network resource does not exist, you do not have the operation permission, or the input parameters are 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/{network_name}

**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
network_name	Yes	String	Definition: Network ID. The value is obtained from the metadata.name field in the network details. *Constraints: The value can contain 36 to 63 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Digits and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** 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: 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 3** 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 4** 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 5** NetworkMetadataAnnotations
Parameter	Type	Description
os.modelarts/description	String	Definition: Network description. Range: The value cannot contain these characters: !<>=&"'.

**Table 6** 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 7** NetworkConnection
Parameter	Type	Description
peerConnectionList	Array of objects	Definition: Peering connections.

**Table 8** 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 9** 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 10** 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 11** 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.

Status code: 404

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Example Requests

Obtain details about a network.

GET https://{endpoint}/v1/{project_id}/networks/{network_name}

{ }

Example Responses

Status code: 200

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

Status code: 404

Not found.

{
  "error_code" : "ModelArts.50025001",
  "error_msg" : "Network not exist."
}

Status Codes

Status Code	Description
200	OK
404	Not found.

Error Codes

See Error Codes.

Parent topic: Resource Management

Previous topic: Obtaining Network Resources

Next topic: Deleting a Network Resource

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot