文档首页/魔坊（ModelArts）模型训推平台/API参考/资源管理/更新网络资源 - PatchNetwork
更新时间：2026-02-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新网络资源 - PatchNetwork

功能介绍

更新网络资源接口用于修改指定网络资源的配置信息。该接口适用于以下场景：当需要调整网络资源的属性、修复配置错误或优化资源设置时，用户可通过此接口更新指定网络资源的详细信息。使用该接口的前提条件是网络资源已存在且用户具有管理员权限。更新操作完成后，指定网络资源的配置信息将被成功修改，系统将反映最新的资源状态和属性。若指定的网络资源不存在、用户无权限操作或输入参数有误，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts:network:update

    Write

    network *

    g:ResourceTag/<tag-key>

    -

    -

    -

    g:EnterpriseProjectId

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

network_name

是

String

参数解释：网络资源名称。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：消息体的类型（格式）。

约束限制：不涉及。

取值范围：可选值如下：

  • application/merge-patch+json

默认取值：不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

metadata

否

NetworkMetadataUpdate object

参数解释：网络资源的metadata更新信息。

约束限制：不涉及。

spec

否

NetworkSpecUpdate object

参数解释：网络资源的描述更新信息。

约束限制：不涉及。

表4 NetworkMetadataUpdate

参数

是否必选

参数类型

描述

annotations

否

NetworkMetadataAnnotations object

参数解释：资源注释信息。

约束限制：不涉及。

表5 NetworkMetadataAnnotations

参数

是否必选

参数类型

描述

os.modelarts/description

否

String

参数解释：网络的描述信息。

取值范围：不能包含字符!<>=&"'。

表6 NetworkSpecUpdate

参数

是否必选

参数类型

描述

connection

否

NetworkConnection object

参数解释：网络连接更新信息。

约束限制：不涉及。

表7 NetworkConnection

参数

是否必选

参数类型

描述

peerConnectionList

否

Array of PeerConnectionItem objects

参数解释：Peer方式打通网络列表。

表8 PeerConnectionItem

参数

是否必选

参数类型

描述

peerVpcId

是

String

参数解释：对端的VPC ID。

取值范围：不涉及。

peerSubnetId

是

String

参数解释：对端的子网ID。

取值范围：不涉及。

defaultGateWay

否

Boolean

参数解释：创建默认路由的开关，默认为false不创建。

取值范围：不涉及。

响应参数

状态码：200

表9 响应Body参数

参数

参数类型

描述

apiVersion

String

参数解释：资源的API版本。

取值范围：可选值如下：

  • v1：当前资源版本为v1。

kind

String

参数解释：资源的类型。

取值范围：可选值如下：

  • Network：网络。

metadata

NetworkMetadata object

参数解释：网络资源的元信息。

spec

NetworkSpec object

参数解释：网络资源的规格信息。

status

NetworkStatus object

参数解释：网络资源的状态信息。

表10 NetworkMetadata

参数

参数类型

描述

name

String

参数解释：网络资源的ID。

取值范围：不涉及。

creationTimestamp

String

参数解释：网络的创建时间。例如"2025-11-01T03:49:41Z"。

取值范围：不涉及。

labels

NetworkMetadataLabels object

参数解释：网络的标签信息。

annotations

NetworkMetadataAnnotations object

参数解释：网络的注释信息。

表11 NetworkMetadataLabels

参数

参数类型

描述

os.modelarts/name

String

参数解释：资源池的显示名称。

取值范围：只能以小写字母开头，数字、中划线组成，不能以中划线结尾，且长度为4-32。

os.modelarts/workspace.id

String

参数解释：工作空间ID。获取方法请参见查询工作空间列表。

取值范围：不涉及。

表12 NetworkMetadataAnnotations

参数

参数类型

描述

os.modelarts/description

String

参数解释：网络的描述信息。

取值范围：不能包含字符!<>=&"'。

表13 NetworkSpec

参数

参数类型

描述

cidr

String

参数解释：网络的cidr值。

取值范围：

  • 172.16.0.0/12~24

  • 192.168.0.0/16~24

connection

NetworkConnection object

参数解释：当前网络与其他资源的连通信息。

表14 NetworkConnection

参数

参数类型

描述

peerConnectionList

Array of PeerConnectionItem objects

参数解释：Peer方式打通网络列表。

表15 PeerConnectionItem

参数

参数类型

描述

peerVpcId

String

参数解释：对端的VPC ID。

取值范围：不涉及。

peerSubnetId

String

参数解释：对端的子网ID。

取值范围：不涉及。

defaultGateWay

Boolean

参数解释：创建默认路由的开关，默认为false不创建。

取值范围：不涉及。

表16 NetworkStatus

参数

参数类型

描述

phase

String

参数解释：网络资源的当前状态。

取值范围：可选值如下：

  • Creating：网络创建中。

  • Active：网络正常。

  • Abnormal：网络异常。

connectionStatus

NetworkConnectionStatus object

参数解释：网络与其他云服务联通状态。

表17 NetworkConnectionStatus

参数

参数类型

描述

peerConnectionStatus

Array of PeerConnectionStatus objects

参数解释：Peer方式打通网络的状态信息列表。

sfsTurboStatus

Array of SfsTurboConnectionStatus objects

参数解释：网络可连通的SFS Turbo信息列表。

表18 PeerConnectionStatus

参数

参数类型

描述

peerVpcId

String

参数解释：对端的VPC ID。

取值范围：不涉及。

peerSubnetId

String

参数解释：对端的子网ID。

取值范围：不涉及。

defaultGateWay

Boolean

参数解释：创建默认路由的开关。

取值范围：默认为false不创建。

phase

String

参数解释：网络的连接状态。

取值范围：可选值如下：

  • Connecting：网络连接中

  • Active：网络连接正常

  • Abnormal：网络连接不正常

表19 SfsTurboConnectionStatus

参数

参数类型

描述

name

String

参数解释：sfsTurbo实例的名称。

取值范围：不涉及。

sfsId

String

参数解释：sfsTurbo实例的ID。

取值范围：不涉及。

connectionType

String

参数解释：关联方式。

取值范围：可选值如下：

  • VpcPort：通过挂载网卡直通

  • Peering：通过对等连接打通

ipAddr

String

参数解释：SFS Turbo的访问地址。

取值范围：不涉及。

status

String

参数解释：与SFS Turbo的连接状态信息。

取值范围：可选值如下：

  • Active：SFS连通状态正常

  • Abnormal：SFS连通状态异常

  • Creating：SFS连通状态创建关联中

  • Deleting：SFS连通状态解除关联中

状态码：400

表20 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

状态码：404

表21 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：ModelArts错误码。

取值范围：不涉及。

error_msg

String

参数解释：具体错误信息。

取值范围：不涉及。

请求示例

打通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" : false
      } ]
    }
  }
}

响应示例

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

状态码：400

Bad request

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

状态码：404

Not Found。

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

状态码

状态码

描述

200

OK。

400

Bad request

404

Not Found。

错误码

请参见错误码。

父主题：资源管理

相关文档