删除网络资源
功能介绍
删除网络资源接口用于移除指定的网络资源。该接口适用于以下场景:当网络资源不再需要、配置错误或需要清理资源时,用户可通过此接口删除指定的网络资源。使用该接口的前提条件是网络资源已存在且用户具有管理员权限。删除操作完成后,指定的网络资源将被永久移除,相关配置和关联关系也将被清理。若指定的网络资源不存在、用户无权限操作或资源被其他资源依赖,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
DELETE /v1/{project_id}/networks/{network_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
network_name |
是 |
String |
参数解释:网络资源名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释:资源的API版本。 取值范围:可选值如下:
|
|
kind |
String |
参数解释:资源的类型。 取值范围:可选值如下:
|
|
metadata |
NeworkMetadata object |
参数解释:网络资源的元信息。 |
|
spec |
NetworkSpec object |
参数解释:网络资源的规格信息。 |
|
status |
NetworkStatus object |
参数解释:网络资源的状态信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释:网络资源的ID。 取值范围:不涉及。 |
|
creationTimestamp |
String |
参数解释:网络的创建时间。例如"2025-11-01T03:49:41Z"。 取值范围:不涉及。 |
|
labels |
NetworkMetadataLabels object |
参数解释:网络的标签信息。 |
|
annotations |
NetworkMetadataAnnotations object |
参数解释:网络的注释信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
os.modelarts/name |
String |
参数解释:资源池的显示名称。 取值范围:只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为4-32。 |
|
os.modelarts/workspace.id |
String |
参数解释:工作空间ID。获取方法请参见查询工作空间列表。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
os.modelarts/description |
String |
参数解释:网络的描述信息。 取值范围:不能包含字符!<>=&"'。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cidr |
String |
参数解释:网络的cidr值。 取值范围:
|
|
connection |
NetworkConnection object |
参数解释:当前网络与其他资源的连通信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
phase |
String |
参数解释:网络资源的当前状态。 取值范围:可选值如下:
|
|
connectionStatus |
NetworkConnectionStatus object |
参数解释:网络与其他云服务联通状态。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
peerConnectionStatus |
Array of PeerConnectionStatus objects |
参数解释:Peer方式打通网络的状态信息列表。 |
|
sfsTurboStatus |
Array of SfsTurboConnectionStatus objects |
参数解释:网络可连通的SFS Turbo信息列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
peerVpcId |
String |
参数解释:对端的VPC ID。 取值范围:不涉及。 |
|
peerSubnetId |
String |
参数解释:对端的子网ID。 取值范围:不涉及。 |
|
defaultGateWay |
Boolean |
参数解释:创建默认路由的开关。 取值范围:默认为false不创建。 |
|
phase |
String |
参数解释:网络的连接状态。 取值范围:可选值如下:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释:sfsTurbo实例的名称。 取值范围:不涉及。 |
|
sfsId |
String |
参数解释:sfsTurbo实例的ID。 取值范围:不涉及。 |
|
connectionType |
String |
参数解释:关联方式。 取值范围:可选值如下:
|
|
ipAddr |
String |
参数解释:SFS Turbo的访问地址。 取值范围:不涉及。 |
|
status |
String |
参数解释:与SFS Turbo的连接状态信息。 取值范围:可选值如下:
|
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
|
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
删除网络。
DELETE https://{endpoint}/v1/{project_id}/networks/{network_name}
{ }
响应示例
状态码:200
OK。
{
"kind" : "Network",
"apiVersion" : "v1",
"metadata" : {
"name" : "network-7a03-86c13962597848eeb29c5861153a391f",
"creationTimestamp" : "2022-09-16T09:44:59Z",
"deletionTimestamp" : "2022-09-16T10:06:27Z",
"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" : {
"peerConnectionStatus" : [ {
"peerVpcId" : "03e4f4d7-fc62-409b-9c52-df885525e30b",
"peerSubnetId" : "42aeebc3-f7c7-45aa-b884-e6e9ac2f841d",
"defaultGateWay" : false,
"phase" : "Active"
} ]
}
}
}
状态码:404
Not Found。
{
"error_code" : "ModelArts.50025001",
"error_msg" : "Network not exist."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
404 |
Not Found。 |
错误码
请参见错误码。