删除节点池
功能介绍
删除节点池接口用于移除已创建的节点池,包周期资源池不支持。该接口适用于以下场景:当节点池完成任务、配置错误或需要清理资源时,用户可通过此接口删除指定的节点池。使用该接口的前提条件是节点池已存在且用户具有管理员权限。删除操作完成后,节点池将被永久移除,相关资源和配置也将被清理。若节点池不存在、用户无权限操作或节点池处于不可删除状态(如包周期资源池或节点池正在使用中),接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
DELETE /v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
pool_name |
是 |
String |
参数解释:资源池名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
nodepool_name |
是 |
String |
参数解释:节点池名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释: API版本。 取值范围: 可选值如下:
|
|
kind |
String |
参数解释:节点池类型。 取值范围: 可选值如下:
|
|
metadata |
NodePoolMetadata object |
参数解释: 节点池的metadata信息。 |
|
spec |
NodePoolSpec object |
参数解释:节点池的期望信息。 |
|
status |
NodePoolStatus object |
参数解释: 节点池的状态信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
PoolResource object |
参数解释: 节点池中的资源信息列表,包括资源规格和相应规格的资源数量,自定义配置等。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavor |
String |
参数解释: 资源规格名称,比如:modelarts.vm.gpu.t4u8。 取值范围: 不涉及。 |
|
count |
Integer |
参数解释: 规格保障使用量。 取值范围: 不涉及。 |
|
maxCount |
Integer |
参数解释: 资源规格的弹性使用量,物理池该值和count相同,逻辑池该值大于等于count。 取值范围: 不涉及。 |
|
azs |
Array of PoolNodeAz objects |
参数解释: 节点池az分布。 |
|
nodePool |
String |
参数解释: 节点池名称。比如:nodePool-1。 取值范围: 不涉及。 |
|
taints |
Array of Taints objects |
参数解释: 支持给创建出来的节点加taints来设置反亲和性,非特权池不能指定。 |
|
labels |
Map<String,String> |
参数解释: k8s标签,格式为key/value键值对。 取值范围: 不涉及。 |
|
tags |
Array of UserTags objects |
参数解释: 资源标签,非特权池不能指定。 取值范围: 不涉及。 |
|
network |
NodeNetwork object |
参数解释:网络配置,非特权池不能指定。 |
|
extendParams |
Map<String,String> |
参数解释:自定义配置参数。
|
|
creatingStep |
CreatingStep object |
参数解释:批量创建信息。 |
|
os |
Os object |
参数解释:操作系统镜像信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释:键。 取值范围:不涉及。 |
|
value |
String |
参数解释:值。 取值范围:不涉及。 |
|
effect |
String |
参数解释:作用效果。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释:键。不得以"CCE-"或"__type_baremetal"开头"。 取值范围:不涉及。 |
|
value |
String |
参数解释:值。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vpc |
String |
参数解释:vpc id。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
subnet |
String |
参数解释:子网id。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
securityGroups |
Array of strings |
参数解释:安全组id集合。 约束限制:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
step |
Integer |
参数解释:超节点的步长。仅支持资源规格详情中包含的步长。 取值范围:不涉及。 |
|
type |
String |
参数解释:批量创建类型。 取值范围:可选值如下:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释:操作系统名称。 取值范围:不涉及。 |
|
imageId |
String |
参数解释:操作系统镜像ID。 取值范围:不涉及。 |
|
imageType |
String |
参数解释:操作系统镜像类型。 取值范围:可选值如下:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
creating |
PoolResourceFlavorCount object |
参数解释:状态为创建中状态的资源量。 |
|
available |
PoolResourceFlavorCount object |
参数解释:状态为可用状态的资源量。 |
|
abnormal |
PoolResourceFlavorCount object |
参数解释:状态为非正常状态的资源量。 |
|
deleting |
PoolResourceFlavorCount object |
参数解释:状态为删除中状态的资源量。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
flavor |
String |
参数解释:资源规格ID。 取值范围:不涉及。 |
|
count |
Integer |
参数解释:资源池中资源规格实例数量。 取值范围:不涉及。 |
|
maxCount |
Integer |
参数解释:资源池中资源规格实例弹性数量。物理池中该值和count相同。 取值范围:不涉及。 |
|
azs |
Array of PoolNodeAz objects |
参数解释:资源池中期望创建的资源规格实例的az分布。 |
|
nodePool |
String |
参数解释:节点池ID。 取值范围:不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
|
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
删除节点池。
DELETE https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name}
{ }
响应示例
状态码:200
success
{
"kind" : "NodePool",
"apiVersion" : "v2",
"metadata" : {
"name" : "nodepool-1"
},
"spec" : {
"resources" : {
"nodePool" : "nodepool-1",
"flavor" : "modelarts.vm.2u4g.dcc",
"count" : 1,
"maxCount" : 1,
"network" : {
"vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
"subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
"securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
}
}
},
"status" : {
"resources" : {
"available" : {
"nodePool" : "nodepool-1",
"flavor" : "modelarts.vm.2u4g.dcc",
"count" : 1,
"maxCount" : 1,
"azs" : [ {
"az" : "cn-north-7c",
"count" : 1
} ]
}
}
}
}
状态码:400
Bad request
{
"error_code" : "ModelArts.50004000",
"error_msg" : "Bad request."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
success |
|
400 |
Bad request |
错误码
请参见错误码。