文档

DeleteCluster - 删除集群

更新时间:

如果您的集群无需使用,请删除集群并选择是否删除或保留集群的相关资源。删除集群前,请手动清理工作负载(无状态、有状态、任务和定时任务),否则可能导致集群删除失败。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DeleteClusterWrite
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

DELETE /clusters/{ClusterId}

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

c905d1364c2dd4b6284a3f41790c4****
retain_all_resourcesboolean

是否保留所有资源。如果设置该值为true,则会忽略retain_resources

  • true:保留所有资源。
  • false:不保留所有资源。

默认值:false

false
keep_slbdeprecatedboolean

是否保留 SLB,取值:

  • true:保留创建的 SLB 资源。
  • false:不保留创建的 SLB 资源。

默认值:false

false
retain_resourcesarray

资源列表。删除集群时如果需要保留资源,则需要提供对应资源的 ID。

string

资源名称。

sg-2ze6ess9kho6fdn9****
delete_optionsobject []

集群关联资源的删除选项。

resource_typestring

资源类型,可取值:

  • SLB:通过 service 创建的 SLB 资源,默认删除,可选择保留
  • ALB:ALB Ingress Controller 创建的 ALB 资源,默认保留,可选择删除
  • SLS_Data:集群日志功能所使用的日志服务 Project,默认保留,可选择删除
  • SLS_ControlPlane:托管版集群控制平面日志所使用的日志服务 Project,默认保留,可选择删除
  • PrivateZone:ACK Serverless 集群创建的 PrivateZone 资源,默认保留,可选择删除
delete_modestring

该类型资源的删除策略,可取值:

  • delete:删除该类资源
  • retain:保留该类资源

返回参数

名称类型描述示例值
object

返回体数据。

cluster_idstring

集群 ID。

cb95aa626a47740afbf6aa099b650****
request_idstring

请求 ID。

687C5BAA-D103-4993-884B-C35E4314****
task_idstring

任务 ID。

T-5a54309c80282e39ea****

示例

正常返回示例

JSON格式

{
  "cluster_id": "cb95aa626a47740afbf6aa099b650****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****",
  "task_id": "T-5a54309c80282e39ea****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-11API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-25OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)