You need to enable JavaScript to run this app.
导航
删除边缘集群
最近更新时间:2023.10.11 17:27:07首次发布时间:2023.08.24 19:59:29

本接口用于删除边缘集群。

使用说明

此接口为异步接口,当此接口返回成功时,集群进入{Deleting, [Progressing]})状态。此时,不代表集群已成功删除,需要您调用获取集群列表及详情接口查看集群是否存在,若未查询到,那么集群已删除成功。有关状态说明,请参见资源状态说明

请求方式

POST

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

参数名称

类型

是否必选

示例值

描述

Action

String

DeleteCluster

公共参数,本接口取值为DeleteCluster

Version

String

2022-05-12

公共参数,本接口取值为2022-05-12

Id

String

待删除的集群 ID。在 集群 页面,鼠标指针悬浮到集群名称上,获取集群 ID。您也可以调用获取集群列表及详情接口,获取集群 ID。

说明

待删除的集群必须处于以下任一状态,可调用获取集群列表及详情接口获取集群当前的状态:

  • {Running, [*]}
  • {Failed, [*]}
  • {Stopped, [Balance]}

Force

Boolean

强制删除集群,取值:

  • false:(默认值)关闭。
  • true:开启。取该值时,即使是开启删除保护(DeleteProtection=true)的集群,可以被强制删除。

CascadingDeleteResources

[]String

["NodePoolResource", "Clb", "Nat"]

同步删除指定集群内的相关资源,取值:

  • DefaultNodePoolResource:同步删除集群内默认节点池中按量计费的 ECS 实例。不支持删除和从集群中移除包年包月的云服务器实例。
  • NodePoolResource:同步删除集群内的所有自定义节点池、节点池内的 ECS 实例及其关联的弹性块存储。不包含 PV 卷所对应的块存储资源
  • Clb:同步删除集群创建的负载均衡器(CLB)。
  • Nat:同步删除集群创建的 NAT 网关

说明

在删除过程中,若这些资源开启了删除保护则无法被删除,未开启删除保护的资源,会被继续删除。建议在调用接口前按需调整删除保护设置。

请求示例

POST /?Action=DeleteCluster&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "Id": "cc9l74mvqtofjnoj5****",
    "Force": true,
    "CascadingDeleteResources": ["DefaultNodePoolResource", "NodePoolResource", "Clb", "Nat"]
}

返回参数


返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "021635330810134****",
        "Action": "DeleteCluster",
        "Version": "2022-05-12",
        "Service": "veecp_openapi",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

本接口错误码如下所示,其他错误码请参见错误码

HTTP 状态码

错误码

错误信息

描述

400

OperationDenied.DeleteProtection

The deletion protection of specified {{resourceType}} is enabled.

删除失败,指定资源开启了删除保护。您可以使用强制删除,也可以取消删除保护后重试。

400

OperationDenied.ClusterStatus

The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].

指定集群的当前状态不支持该操作,确认集群状态并等待状态变更后重试。