删除集群

最近更新时间: 2026-10-11 00:12:01

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

删除集群

默认接口请求频率限制:10000次/秒。

接口更新时间:2026-02-04 22:28:11。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DeleteCluster
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId 是 否 String 集群ID,按照【集群ID】进行过滤,可通过调用DescribeClusters查询已创建的项目列表或登录控制台进行查看;也可以调用CreateCluster创建新的项目。集群ID例如:cls-6a79x94v。仅在集群下无部署组、命名空间、云主机时可以删除。
示例值:  
Unbind 否 否 Bool 是否只解绑,不删除容器集群,默认不传则删除容器集群。
示例值:  

3. 输出参数

参数名称 类型 描述
Result Bool 删除集群操作是否成功。
true:操作成功。
false:操作失败。
示例值:  
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。

错误码 描述
ResourceNotFound.ContainergroupGroupNamespaceClusterNotFound 无法找到该部署组所属集群和命名空间。
InvalidParameter.ParamError 参数错误。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
InternalError.CpClusterUnavailable 容器平台集群不可用,当前状态 %s。
ResourceInUse.CvmcaeMasterCannotDelete 资源仍在使用中 无法删除。
FailedOperation.TkeClusterDeleteFailed TKE 集群删除失败。
InternalError.CloudApiProxyError TSF云API请求调用失败。
InternalError.UnhandledException [%s]模块未处理异常。。
ResourceInUse.GroupExists 集群下存在分组。
ResourceInUse.InstanceExists 实例已经存在。
ResourceInUse.NonDefaultNamespaceExists 集群下存在非默认命名空间。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
ResourceNotFound.TkeClusterNotExists TKE 中不存在该集群。
FailedOperation.CloudApiProxyError TSF云API请求调用失败。
FailedOperation.ContainergroupKubernetesTkeClusterAbnormal
FailedOperation.CpClusterUnavailable
FailedOperation.ClusterOperateEnvIllegalError
MissingParameter.ClusterIdRequired 集群ID未填写。

5. 示例

示例1 删除集群示例

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=DeleteCluster
&ClusterId=cluster-jy96p5gy
&<Common Parameters>

输出示例

{
  "Response": {
    "RequestId": "d6cdf4d3-6258-48b1-b205-688cd44c420f",
    "Result": true
  }
}