DeleteKubeconfigs--容器服务-火山引擎

文档中心

立即注册

导航

容器服务

DeleteKubeconfigs

最近更新时间：2024.09.14 18:01:02首次发布时间：2022.12.14 14:54:08

吊销集群的 Kubeconfig 凭证。

使用说明

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=DeleteKubeconfigs&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	DeleteKubeconfigs	接口名称。当前 API 的名称为 `DeleteKubeconfigs`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
ClusterId	String	是	cc5silum****	集群 ID。可以调用 ListClusters 接口，获取集群 ID。注意集群必须处于`{Running,[Ok]}`或`{Updating,[Progressing]}`状态。可调用 ListClusters 接口获取集群当前的状态。
Ids	Array of String	是	["kc5silumrsfeqxxxx"]	Kubeconfig ID。在容器服务控制台的集群页面，单击目标集群名称后，在集群的基本信息页面连接信息页签获取 Kubeconfig ID，也可以查看调用 CreateKubeconfig 接口后保存的 Kubeconfig ID 信息。

请求示例

POST https://open.volcengineapi.com/?Action=DeleteKubeconfigs&Version=2022-05-12
Content-Type:application/json

{
    "ClusterId": "cc5sil****",
    "Ids": ["kc5silumrsfeq****"]
}

返回参数

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

返回示例

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

错误码

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

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