删除集群

最近更新时间:2024-03-12 02:00:22

我的收藏

1. 接口描述

接口请求域名: tsf.tencentcloudapi.com 。

删除集群

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteCluster。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID
Unbind Boolean 是否只解绑,不删除容器集群,默认不传则删除容器集群。

3. 输出参数

参数名称 类型 描述
Result Boolean 删除集群操作是否成功。
true:操作成功。
false:操作失败。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除集群示例

输入示例

https://tsf.tencentcloudapi.com/?Action=DeleteCluster
&ClusterId=cluster-jy96p5gy
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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