文档首页/ AI开发平台ModelArts/ API参考/ 资源管理/ 更新网络资源

更新时间：2025-08-19 GMT+08:00

查看PDF

更新网络资源

功能介绍

更新指定网络资源。

调试

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

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 peerConnectionList objects	参数解释：Peer方式打通网络列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表8 peerConnectionList
参数	是否必选	参数类型	描述
peerVpcId	是	String	参数解释：Peer方式打通对端网络ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
peerSubnetId	是	String	参数解释：Peer方式打通对端子网ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
defaultGateWay	否	Boolean	参数解释：创建默认路由的开关。约束限制：不涉及。取值范围：取值范围： true：创建默认路由开关。 false：不创建默认路由开关。默认取值：false。

响应参数

状态码：200

表9 响应Body参数
参数	参数类型	描述
apiVersion	String	参数解释：资源的API版本。约束限制：不涉及。取值范围：可选值如下： v1：当前资源版本为v1。默认取值：不涉及。
kind	String	参数解释：资源的类型。约束限制：不涉及。取值范围：可选值如下： Network：网络。默认取值：不涉及。
metadata	NeworkMetadata object	参数解释：网络资源的元信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
spec	NetworkSpec object	参数解释：网络资源的规格信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
status	NetworkStatus object	参数解释：网络资源的状态信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

**表10** NeworkMetadata
参数	参数类型	描述
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。约束限制：不涉及。取值范围：不涉及。默认取值：0。

**表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 peerConnectionList objects	参数解释：Peer方式打通网络列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

**表15** peerConnectionList
参数	参数类型	描述
peerVpcId	String	参数解释：Peer方式打通对端网络ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
peerSubnetId	String	参数解释：Peer方式打通对端子网ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
defaultGateWay	Boolean	参数解释：创建默认路由的开关。约束限制：不涉及。取值范围：取值范围： true：创建默认路由开关。 false：不创建默认路由开关。默认取值：false。

**表16** NetworkStatus
参数	参数类型	描述
phase	String	参数解释：网络资源的当前状态。约束限制：不涉及。取值范围：可选值如下： Creating：网络创建中。 Active：网络正常。 Abnormal：网络异常。默认取值：不涉及。
connectionStatus	NetworkConnectionStatus object	参数解释：网络与其他云服务联通状态。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

**表17** NetworkConnectionStatus
参数	参数类型	描述
peerConnectionStatus	Array of peerConnectionStatus objects	参数解释：网络对端连接的状态列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
sfsTurboStatus	Array of sfsTurboStatus objects	参数解释：网络连接SFS Turbo的状态列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

**表18** peerConnectionStatus
参数	参数类型	描述
peerVpcId	String	参数解释：对端方式打通对端网络ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
peerSubnetId	String	参数解释：对端方式打通对端子网ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
defaultGateWay	Boolean	参数解释：创建默认路由的开关。约束限制：不涉及。取值范围：取值范围： true：创建默认路由开关。 false：不创建默认路由开关。默认取值：false。
phase	String	参数解释：对端连接状态。约束限制：不涉及。取值范围：可选值如下： Connecting：网络连接中。 Active：网络连接正常。 Abnormal：网络连接异常。默认取值：不涉及。

**表19** sfsTurboStatus
参数	参数类型	描述
sfsId	String	参数解释：连接的SFS Turbo实例ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
name	String	参数解释：连接的SFS Turbo实例名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
status	String	参数解释：SFS Turbo的连接状态。约束限制：不涉及。取值范围：可选值如下： Active：SFS连通状态正常。 Abnormal：SFS连通状态异常。默认取值：不涉及。
ipAddr	String	参数解释：连接的SFS Turbo实例访问地址。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

状态码：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。

错误码

请参见错误码。

父主题： 资源管理

上一篇：删除网络资源

下一篇：查询资源实时利用率

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消