Help Center/ ModelArts/ API Reference/ Resource Management/ Network Management/ Obtaining a Network Resource
Updated on 2024-06-13 GMT+08:00
View PDF

Obtaining a Network Resource

Function

This API is used to obtain details about a specified network resource.

URI

GET /v1/{project_id}/networks/{network_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

network_name

Yes

String

Automatically generated network name.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

apiVersion

String

API version. Options:

  • v1

kind

String

Resource type. Options:

  • Network

metadata

NeworkMetadata object

Metadata of network resources.

spec

NetworkSpec object

Description of network resources.

status

NetworkStatus object

Status of network resources.
Table 3 NeworkMetadata

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 4 NetworkMetadataLabels

Parameter

Type

Description

os.modelarts/name

String

Specified network name.

Minimum: 4

Maximum: 32
Table 5 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: !<>=&"'

Minimum: 0

Maximum: 100
Table 6 NetworkSpec

Parameter

Type

Description

ipv6enable

Boolean

Whether to enable IPv6. Once IPv6 is enabled, it cannot be disabled.

cidr

String

Network CIDR. Value range:

  • 172.16.0.0/12-172.16.0.0/24

  • 192.168.0.0/16-192.168.0.0/24

connection

NetworkConnection object

Automatically interconnected endpoint.
Table 7 NetworkConnection

Parameter

Type

Description

peerConnectionList

Array of peerConnectionList objects

Peering connections

sfsTurboConnectionList

Array of sfsTurboConnectionList objects

SFS Turbo connections through attached NICs
Table 8 peerConnectionList

Parameter

Type

Description

peerVpcId

String

VPC ID of the peer end

peerSubnetId

String

Subnet ID of the peer end
Table 9 sfsTurboConnectionList

Parameter

Type

Description

sfsId

String

ID of an SFS Turbo instance

name

String

Name of an SFS Turbo instance
Table 10 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 11 NetworkConnectionStatus

Parameter

Type

Description

peerConnectionStatus

Array of peerConnectionStatus objects

Peering connection status

sfsTurboStatus

Array of sfsTurboStatus objects

Status of SFS Turbo accessible to the network
Table 12 peerConnectionStatus

Parameter

Type

Description

peerVpcId

String

VPC ID of the peer end

peerSubnetId

String

Subnet ID of the peer end

phase

String

Network connection status. Options:

  • Connecting: The network is being connected.

  • Active: The network is connected properly.

  • Abnormal: The network connection is abnormal.
Table 13 sfsTurboStatus

Parameter

Type

Description

sfsId

String

SFS Turbo ID

name

String

SFS Turbo name

status

String

Status of the connection to SFS Turbo. Options:

  • 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.

ipAddr

String

SFS Turbo access address

connectionType

String

Connection type. Options:

  • VpcPort: passthrough through attached NICs

  • Peering: connection through VPC peering

Status code: 404

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Obtain details about a network.

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

{ }

Example Responses

Status code: 200

OK

{
  "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: Network Management