You need to enable JavaScript to run this app.
导航
容器服务
  • 文档首页
    • /
  • 容器服务

DeleteKubeconfigs

最近更新时间：2024.02.26 20:17:38

首次发布时间：2022.12.14 14:54:08

我的收藏

吊销集群的 Kubeconfig 凭证。

使用说明

  • 此接口为异步接口，当此接口返回成功时，不代表 Kubeconfig 已成功吊销，需要您等待 5 秒后调用 ListKubeconfigs 接口查看该 Kubeconfig 是否存在，若未查询到，表示已删除成功。
  • 吊销集群 Kubeconfig 凭证时，根据接口调用者权限的区别，包含如下两种：
    • 调用者拥有火山引擎账号（主账号）权限，则可以吊销自身以及其下子用户的 Kubeconfig 凭证。
    • 调用者拥有子用户权限，则只能吊销自身的 Kubeconfig 凭证。

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 公共参数。

参数名称类型是否必选示例值描述
ActionString是DeleteKubeconfigs公共参数，本接口值：DeleteKubeconfigs。
VersionString是2022-05-12公共参数，本接口值：2022-05-12。

ClusterId

String

是

cc5silumrsfeq****

集群 ID。
可以调用 ListClusters 接口，获取集群 ID。

注意

集群必须处于{Running,[Ok]}或{Updating,[Progressing]}状态。可调用 ListClusters 接口获取集群当前的状态。

Ids

Array of String

是

["kc5silumrsfeq****"]

Kubeconfig ID。
在 容器服务控制台 的 集群 页面，单击目标集群名称后，在集群的 基本信息 页面 连接信息 页签获取 Kubeconfig ID，也可以查看调用 CreateKubeconfig 接口后保存的 Kubeconfig ID 信息。

请求示例

POST /?Action=DeleteKubeconfigs&Version=2022-05-12
Content-Type:application/json
{
    "ClusterId": "cc5silumrsfeq****",
    "Ids": ["kc5silumrsfeq****"]
}

返回参数

本接口无专有返回参数，公共返回参数请参见 返回结果。

返回示例

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

错误码

本接口错误码如下表所示，公共错误码请参见 公共错误码。

HTTP 状态码错误码错误信息描述
400OperationDenied.ClusterStatusThe action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}].指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。
400OperationDenied.KubeconfigStatusThe action has been denied due to wrong kubeconfig status {{statusPhase}}.当前 Kubeconfig 状态下无法执行此操作。请您等待 5 秒后重试。