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

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

View PDF

Updating a Network Resource

Function

This API is used to update a specified network resource.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PATCH /v1/{project_id}/networks/{network_name}

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Type (format) of the message body. The value is application/merge-patch+json.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
metadata	No	NetworkMetadataUpdate object	Updated network resource metadata.
spec	No	NetworkSpecUpdate object	Updated network resource description.

**Table 4** NetworkMetadataUpdate
Parameter	Mandatory	Type	Description
annotations	No	NetworkMetadataAnnotations object	Resource annotations.

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

**Table 6** NetworkSpecUpdate
Parameter	Mandatory	Type	Description
connection	No	NetworkConnection object	Updated network connection.

**Table 7** NetworkConnection
Parameter	Mandatory	Type	Description
peerConnectionList	No	Array of peerConnectionList objects	List of networks that can be connected in peer mode.

**Table 8** peerConnectionList
Parameter	Mandatory	Type	Description
peerVpcId	Yes	String	Indicates the ID of the peer VPC.
peerSubnetId	Yes	String	ID of the peer subnet.
defaultGateWay	Yes	Boolean	Whether the default gateway is enabled.

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	Network name automatically generated by the system, which is equivalent to networkId. networkId indicates the unique ID generated by ModelArts based on the network name entered by the user.
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.
os.modelarts/workspace.id	String	Workspace ID The default value is 0, indicating the default workspace.

**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: !<>=&"'

**Table 13** NetworkSpec
Parameter	Type	Description
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	Information about the connection between the current network and other cloud services.

**Table 14** NetworkConnection
Parameter	Type	Description
peerConnectionList	Array of peerConnectionList objects	List of networks that can be connected in peer mode.

**Table 15** peerConnectionList
Parameter	Type	Description
peerVpcId	String	Indicates the ID of the peer VPC.
peerSubnetId	String	ID of the peer subnet.
defaultGateWay	Boolean	Whether the default gateway is enabled.

**Table 16** 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	Indicates the connection status between the network and other cloud services.

**Table 17** NetworkConnectionStatus
Parameter	Type	Description
peerConnectionStatus	Array of peerConnectionStatus objects	Indicates the status information list of the network in peer mode.
sfsTurboStatus	Array of sfsTurboStatus objects	Specifies the list of SFS Turbos that can be connected to the network.

**Table 18** peerConnectionStatus
Parameter	Type	Description
peerVpcId	String	Indicates the ID of the peer VPC.
peerSubnetId	String	ID of the peer subnet.
defaultGateWay	Boolean	Whether the default gateway is enabled.
phase	String	Connection status of the network. The options are as follows: Connecting: The network is being connected. Active: The network connection is normal. Abnormal: The network connection is abnormal.

**Table 19** sfsTurboStatus
Parameter	Type	Description
sfsId	String	Specifies the SFS Turbo ID.
name	String	Specifies the name of the SFS Turbo.
status	String	Specifies the status of the connection to the SFS Turbo. The options are as follows: Active: The SFS connection status is normal. Abnormal: The SFS connection status is abnormal.
ipAddr	String	Specifies the address for accessing SFS Turbo.

Status code: 400

**Table 20** Response body parameters
Parameter	Type	Description
error_code	String	Error codes of ModelArts.
error_msg	String	Error message.

Status code: 404

**Table 21** Response body parameters
Parameter	Type	Description
error_code	String	Error codes of ModelArts.
error_msg	String	Error message.

Example Requests

Interconnect with a VPC.

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

{
  "spec" : {
    "connection" : {
      "peerConnectionList" : [ {
        "peerVpcId" : "03e4f4d7-fc62-409b-9c52-df885525e30b",
        "peerSubnetId" : "42aeebc3-f7c7-45aa-b884-e6e9ac2f841d",
        "defaultGateWay" : true
      } ]
    }
  }
}

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" : {
      "peerConnectionList" : [ {
        "peerVpcId" : "03e4f4d7-fc62-409b-9c52-df885525e30b",
        "peerSubnetId" : "42aeebc3-f7c7-45aa-b884-e6e9ac2f841d",
        "defaultGateWay" : true
      } ]
    }
  },
  "status" : {
    "phase" : "Active",
    "connectionStatus" : { }
  }
}

Status code: 400

Bad request

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

Status code: 404

Not found.

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

Status Codes

Status Code	Description
200	OK
400	Bad request
404	Not found.

Error Codes

See Error Codes.

Parent topic: Resource Management

Previous topic: Deleting a Network Resource

Next topic: Querying the Real-Time Resource Usage

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