更新时间:2026-11-12 GMT+08:00

更新网络资源 - PatchNetwork

功能介绍

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

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    modelarts:network:update

    Write

    network *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    modelarts:workspace:get

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制:1 - 64字符,字母、数字和中划线。

取值范围:不涉及。

默认取值:不涉及。

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

参数解释:网络资源的注释信息。

约束限制:不涉及。

labels

否

NetworkUpdateLabels object

参数解释:网络资源的标签信息。

约束限制:不涉及。

表5 NetworkMetadataAnnotations

参数

是否必选

参数类型

描述

os.modelarts/description

否

String

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

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

表6 NetworkUpdateLabels

参数

是否必选

参数类型

描述

os.modelarts/workspace.id

否

String

参数解释:网络所在的工作空间ID。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

表7 NetworkSpecUpdate

参数

是否必选

参数类型

描述

ipv6enable

否

Boolean

参数解释:是否启用ipv6,一旦开启,将不能关闭。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

extendCidrs

否

Array of strings

参数解释:扩展网段列表,更新时支持新增或删除扩展网段;删除的扩展网段下不能仍有子网使用。

约束限制:最多5个;仅支持IPv4;掩码范围为3~28;新增的扩展网段不能与主网段、预留网段、其他扩展网段以及已打通的对端VPC网段重叠。

取值范围:不涉及。

默认取值:不涉及。

subnets

否

Array of Subnet objects

参数解释:子网列表,更新时支持新增或删除子网;删除的子网需未被资源池或其他网络资源使用,且无业务端口占用。

约束限制:子网名称不能重复;子网cidr一旦创建不可修改,新增子网的cidr必须包含在网络cidr或某个扩展网段内,且子网间cidr不能重叠;至少包含一个普通子网。

取值范围:不涉及。

默认取值:不涉及。

expressGateway

否

ExpressGateway object

参数解释:网络是否开启ExpressGateway能力。

约束限制:不涉及。

connection

否

NetworkConnection object

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

约束限制:不涉及。

表8 Subnet

参数

是否必选

参数类型

描述

cidr

是

String

参数解释:子网的cidr。

约束限制:子网cidr必须包含在网络cidr或某个扩展网段内。

取值范围:不涉及。

name

是

String

参数解释:子网的名称。

约束限制:只能包含4-64个字符,以小写字母或数字开头,可包含中划线,不能以中划线结尾。

取值范围:不涉及。

type

否

String

参数解释:子网类型。

取值范围:可选值如下:

  • 空:普通子网

  • baremetal-dedicated:裸金属专用子网

  • clouddcn:CloudDCN子网

remark

否

String

参数解释:子网的备注信息,用于描述子网的使用场景。

取值范围:不涉及。

表9 ExpressGateway

参数

是否必选

参数类型

描述

enable

是

Boolean

参数解释:是否开启ExpressGateway。

约束限制:开启后为关联该网络的作业提供弹性网卡能力。

取值范围:不涉及。

表10 NetworkConnection

参数

是否必选

参数类型

描述

peerConnectionList

否

Array of PeerConnectionItem objects

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

sfsTurboConnectionList

否

Array of SfsTurboConnectionItem objects

参数解释:挂载网卡方式打通sfsturbo列表。

表11 PeerConnectionItem

参数

是否必选

参数类型

描述

peerVpcId

是

String

参数解释:对端的VPC ID。

取值范围:不涉及。

peerSubnetId

是

String

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

取值范围:不涉及。

defaultGateWay

否

Boolean

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

取值范围:不涉及。

表12 SfsTurboConnectionItem

参数

是否必选

参数类型

描述

name

是

String

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

取值范围:不涉及。

sfsId

是

String

参数解释:sfsTurbo实例的ID。

取值范围:不涉及。

响应参数

状态码:200

表13 响应Body参数

参数

参数类型

描述

apiVersion

String

参数解释:API版本。

取值范围:可选值如下:

  • v1

kind

String

参数解释:资源类型。

取值范围:可选值如下:

  • Network:网络

metadata

NetworkMetadata object

参数解释:网络资源的metadata信息。

spec

NetworkSpec object

参数解释:网络资源的描述信息。

status

NetworkStatus object

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

表14 NetworkMetadata

参数

参数类型

描述

name

String

参数解释:系统自动生成的network名称,相当于networkId。

取值范围:不涉及。

creationTimestamp

String

参数解释:时间戳,"2021-11-01T03:49:41Z"。

取值范围:不涉及。

deletionTimestamp

String

参数解释:网络的删除时间。例如"2025-12-01T03:49:41Z"。

取值范围:不涉及。

labels

NetworkMetadataLabels object

参数解释:网络资源的标签信息。

annotations

NetworkMetadataAnnotations object

参数解释:网络资源的注释信息。

表15 NetworkMetadataLabels

参数

参数类型

描述

os.modelarts/name

String

参数解释:用户指定的network名称。

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

os.modelarts/workspace.id

String

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

取值范围:不涉及。

表16 NetworkMetadataAnnotations

参数

参数类型

描述

os.modelarts/description

String

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

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

表17 NetworkSpec

参数

参数类型

描述

ipv6enable

Boolean

参数解释:是否启用ipv6,一旦开启,将不能关闭。

取值范围:不涉及。

cidr

String

参数解释:网络的cidr。

取值范围:不涉及。

extendCidrs

Array of strings

参数解释:扩展网段列表,主网段IP不足时可添加扩展网段扩充MA网段。

取值范围:不涉及。

subnets

Array of Subnet objects

参数解释:子网列表。更新时支持新增或删除子网,删除的子网需未被任何资源使用。

取值范围:不涉及。

expressGateway

ExpressGateway object

参数解释:网络是否开启ExpressGateway能力。

connection

NetworkConnection object

参数解释:当前网络与其他云服务的连通信息。

表18 Subnet

参数

参数类型

描述

cidr

String

参数解释:子网的cidr。

取值范围:不涉及。

name

String

参数解释:子网的名称。

取值范围:不涉及。

type

String

参数解释:子网类型。

取值范围:可选值如下:

  • 空:普通子网

  • baremetal-dedicated:裸金属专用子网

  • clouddcn:CloudDCN子网

remark

String

参数解释:子网的备注信息,用于描述子网的使用场景。

取值范围:不涉及。

表19 ExpressGateway

参数

参数类型

描述

enable

Boolean

参数解释:是否开启ExpressGateway。

取值范围:不涉及。

表20 NetworkConnection

参数

参数类型

描述

peerConnectionList

Array of PeerConnectionItem objects

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

sfsTurboConnectionList

Array of SfsTurboConnectionItem objects

参数解释:挂载网卡方式打通sfsturbo列表。

表21 PeerConnectionItem

参数

参数类型

描述

peerVpcId

String

参数解释:对端的VPC ID。

取值范围:不涉及。

peerSubnetId

String

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

取值范围:不涉及。

defaultGateWay

Boolean

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

取值范围:不涉及。

表22 SfsTurboConnectionItem

参数

参数类型

描述

name

String

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

取值范围:不涉及。

sfsId

String

参数解释:sfsTurbo实例的ID。

取值范围:不涉及。

表23 NetworkStatus

参数

参数类型

描述

phase

String

参数解释:网络的当前状态。

取值范围:可选值如下:

  • Creating:网络创建中

  • Active:网络正常

  • Abnormal:网络不正常

message

String

参数解释:网络异常原因的描述信息。

取值范围:不涉及。

ipv6enable

Boolean

参数解释:网络是否已启用ipv6。

取值范围:不涉及。

vpcId

String

参数解释:网络对应的VPC ID。

取值范围:不涉及。

extendCidrs

Array of strings

参数解释:已添加的扩展网段列表。

取值范围:不涉及。

subnets

Array of SubnetStatus objects

参数解释:网络中子网的状态信息列表。

expressGateway

ExpressGatewayStatus object

参数解释:网络ExpressGateway的状态信息。

connectionStatus

NetworkConnectionStatus object

参数解释:网络与其他云服务连通状态信息。

表24 SubnetStatus

参数

参数类型

描述

cidr

String

参数解释:子网的cidr。

取值范围:不涉及。

name

String

参数解释:子网的名称。

取值范围:不涉及。

type

String

参数解释:子网类型。

取值范围:可选值如下:

  • 空:普通子网

  • baremetal-dedicated:裸金属专用子网

  • clouddcn:CloudDCN子网

remark

String

参数解释:子网的备注信息。

取值范围:不涉及。

networkId

String

参数解释:子网对应的network ID,取值可用于查询网络可用IP数量(network_id参数)。

取值范围:不涉及。

state

String

参数解释:子网的当前状态。

取值范围:可选值如下:

  • Creating:子网创建中

  • Active:子网正常

  • Abnormal:子网不正常

message

String

参数解释:子网状态异常时的原因描述。

取值范围:不涉及。

表25 ExpressGatewayStatus

参数

参数类型

描述

status

String

参数解释:ExpressGateway的当前状态。

取值范围:可选值如下:

  • Creating:创建中

  • Active:正常

  • Abnormal:不正常

message

String

参数解释:ExpressGateway状态异常时的原因描述。

取值范围:不涉及。

表26 NetworkConnectionStatus

参数

参数类型

描述

peerConnectionStatus

Array of PeerConnectionStatus objects

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

sfsTurboStatus

Array of SfsTurboConnectionStatus objects

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

表27 PeerConnectionStatus

参数

参数类型

描述

peerVpcId

String

参数解释:对端的VPC ID。

取值范围:不涉及。

peerSubnetId

String

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

取值范围:不涉及。

defaultGateWay

Boolean

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

取值范围:不涉及。

phase

String

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

取值范围:可选值如下:

  • Connecting:网络连接中

  • Active:网络连接正常

  • Abnormal:网络连接不正常

表28 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

表29 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

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

取值范围:不涉及。

状态码:404

表30 响应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
          } ]
        }
      }
    }
  • 关联sfsTurbo。

    PATCH https://{endpoint}/v1/{project_id}/networks/{network_name}
    
    {
      "spec" : {
        "connection" : {
          "sfsTurboConnectionList" : [ {
            "sfsId" : "2a220ce2-936c-4041-8478-c731bf934b11",
            "name" : "sfs-turbo-a066-bbb"
          } ]
        }
      }
    }

响应示例

状态码: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" : false
      } ],
      "sfsTurboConnectionList" : [ {
        "sfsId" : "97beb2bb-1a5b-41dd-b7fb-65a9c7954517",
        "name" : "mulVpc-02"
      } ]
    }
  },
  "status" : {
    "phase" : "Active",
    "connectionStatus" : { }
  }
}

状态码:400

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

状态码:404

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

状态码

状态码

描述

200

OK。

400

Bad request

404

Not Found。

错误码

请参见错误码。