DeleteCluster_容器服务Kubernetes版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

风险提示:

  • 集群内包年包月类型 ECS、灵骏计算节点等资源无法自动释放,为避免不必要的费用,请您手动释放。关于更多细节,请参见 集群删除及节点释放规则 。
  • 包年包月类型的 APIServer SLB 资源无法自动释放,为避免不必要的费用,请您手动释放。
  • VPC、交换机、安全组、RamRole 如被其他资源占用无法删除时会默认保留,请您手动释放。
  • 通过虚拟节点创建的弹性容器实例 ECI 会被自动释放。
  • 部分通过集群创建的云资源在删除集群时不会被自动释放,集群删除后会继续计费,请根据实际需要释放或保留。这些资源包括:集群自动创建的日志服务 SLS Project;通过动态存储卷购买的云盘。

流控信息

请求速率为200/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
cs:DeleteCluster
Delete
Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

DELETE /clusters/{ClusterId} HTTP/1.1

路径参数

字段名称字段详情
ClusterIdstring

集群 ID。

示例值:c905d1364c2dd4b6284a3f41790c4****参考取值来源:
    InstallClusterAddons
    CreateClusterNodePool
    DescribeClustersV1

请求参数

字段名称字段详情
retain_all_resourcesboolean

是否保留所有资源。如果设置该值为true,则会忽略retain_resources,通过DescribeClusterResources接口查询到的通过集群创建的云资源将被保留。如果该值为false,请注意delete_options中默认保留的资源仍将被保留,如需删除相关资源,请单独在delete_options中设置delete_modedelete展开详情

示例值:false
deprecatedkeep_slbboolean

是否保留 SLB,取值:展开详情

示例值:false
retain_resourcesarray<string>

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

delete_optionsarray<object>

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

返回参数

字段名称字段详情
cluster_idstring

集群 ID。

示例值:cb95aa626a47740afbf6aa099b650****
request_idstring

请求 ID。

示例值:687C5BAA-D103-4993-884B-C35E4314****
task_idstring

任务 ID。

示例值:T-5a54309c80282e39ea****

返回示例

变更历史

变更时间变更内容概要操作
2024-05-09
新增请求参数delete_options
2024-01-11
变更请求参数retain_all_resources
变更请求参数keep_slb
2023-12-25
新增返回参数
2023-12-21
删除返回参数
  • 1
  • 2
  • 10 条/页

相关示例

删除指定 K8s 集群
2020-12-30