Help Center/ ModelArts/ API Reference/ Resource Management/ Network Management/ Creating Network Resources

Updated on 2024-06-13 GMT+08:00

View PDF

Creating Network Resources

Function

This API is used to create network resources.

URI

POST /v1/{project_id}/networks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
apiVersion	Yes	String	API version. Options: v1
kind	Yes	String	Resource type. Options: Network
metadata	Yes	NetworkMetadataCreation object	Metadata of network resources.
spec	Yes	NetworkSpec object	Description of network resources.

**Table 3** NetworkMetadataCreation
Parameter	Mandatory	Type	Description
labels	Yes	NetworkMetadataLabels object	Metadata labels of network resources.

**Table 4** NetworkMetadataLabels
Parameter	Mandatory	Type	Description
os.modelarts/name	Yes	String	Specified network name. Minimum: 4 Maximum: 32

**Table 5** NetworkSpec
Parameter	Mandatory	Type	Description
ipv6enable	No	Boolean	Whether to enable IPv6. Once IPv6 is enabled, it cannot be disabled.
cidr	Yes	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	No	NetworkConnection object	Automatically interconnected endpoint.

**Table 6** NetworkConnection
Parameter	Mandatory	Type	Description
peerConnectionList	No	Array of peerConnectionList objects	Peering connections
sfsTurboConnectionList	No	Array of sfsTurboConnectionList objects	SFS Turbo connections through attached NICs

**Table 7** peerConnectionList
Parameter	Mandatory	Type	Description
peerVpcId	Yes	String	VPC ID of the peer end
peerSubnetId	Yes	String	Subnet ID of the peer end

**Table 8** sfsTurboConnectionList
Parameter	Mandatory	Type	Description
sfsId	Yes	String	ID of an SFS Turbo instance
name	Yes	String	Name of an SFS Turbo instance

Response Parameters

Status code: 200

**Table 9** 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 10** 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 11** NetworkMetadataLabels
Parameter	Type	Description
os.modelarts/name	String	Specified network name. Minimum: 4 Maximum: 32

**Table 12** 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 13** 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 14** NetworkConnection
Parameter	Type	Description
peerConnectionList	Array of peerConnectionList objects	Peering connections
sfsTurboConnectionList	Array of sfsTurboConnectionList objects	SFS Turbo connections through attached NICs

**Table 15** peerConnectionList
Parameter	Type	Description
peerVpcId	String	VPC ID of the peer end
peerSubnetId	String	Subnet ID of the peer end

**Table 16** sfsTurboConnectionList
Parameter	Type	Description
sfsId	String	ID of an SFS Turbo instance
name	String	Name of an SFS Turbo instance

**Table 17** 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 18** 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 19** 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 20** 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: 400

**Table 21** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Create a network.

POST {endpoint}/v2/{project_id}/pools

{
  "apiVersion" : "v1",
  "kind" : "Network",
  "metadata" : {
    "labels" : {
      "os.modelarts/name" : "network-7a03",
      "os.modelarts/workspace.id" : "0"
    }
  },
  "spec" : {
    "cidr" : "192.168.128.0/17"
  }
}

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

Status code: 400

Bad request.

{
  "error_code" : "ModelArts.50004000",
  "error_msg" : "Bad request."
}

Status Codes

Status Code	Description
200	OK
400	Bad request.

Error Codes

See Error Codes.

Parent topic: Network Management

Previous topic: Network Management

Next topic: Obtaining Network Resources

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.

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