DescribeClusterUserKubeconfig - 查询集群KubeConfig - 容器服务 Kubernetes 版 ACK

KubeConfig用于在客户端配置ACK集群的访问凭据，包含访问目标集群的身份和认证数据等信息。使用kubectl管理集群时，需要先通过KubeConfig来连接集群，您可以调用DescribeClusterUserKubeconfig接口查询指定集群的KubeConfig。

接口说明

KubeConfig 签发证书的默认有效期为 3 年。在临近过期 180 天内，您可以通过容器服务管理控制台或获取集群 KubeConfig 接口获取轮转后刷新的 KubeConfig，新 KubeConfig 证书的有效期仍为 3 年，老的 KubeConfig 凭据在证书过期前仍然有效，请您根据控制台显示或接口返回的 KubeConfig 过期时间及时获取轮转凭据。
请妥善管理集群的 KubeConfig 凭据，并在无需使用凭据时及时完成吊销，避免 KubeConfig 泄露带来的数据泄露等安全风险。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cs:DescribeClusterUserKubeconfig

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

cs:KubeConfigDurationMinutes

无

请求语法

GET /k8s/{ClusterId}/user_config HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	c5b5e80b0b64a4bf6939d2d8fbbc5****

请求参数

名称	类型	必填	描述	示例值
PrivateIpAddress	boolean	否	是否获取内网连接配置。取值： `true`：仅获取内网连接凭据。 `false`：仅获取公网连接凭据。默认值：`false`。	false
TemporaryDurationMinutes	integer	否	临时 KubeConfig 有效期，单位：分钟。取值范围：15（15 分钟）～4320（3 天）。说明当不设置该参数时，将由系统自动确定一个更长的有效期，具体过期时间通过返回的`expiration`字段的值确定。	15

返回参数

名称	类型	描述	示例值
	object	返回数据体。
config	string	集群的 KubeConfig。	apiVersion: v1\nclusters:\n- cluster:\n server: https://114.55.xx.xx:6443\n certificate-authority-data: LS0tLS****
expiration	string	KubeConfig 的过期时间。格式：RFC3339 格式的 UTC 时间。	2024-03-10T09:56:17Z

示例

正常返回示例

JSON格式

{
  "config": "apiVersion: v1\\nclusters:\\n- cluster:\\n    server: https://114.55.xx.xx:6443\\n    certificate-authority-data: LS0tLS****",
  "expiration": "2024-03-10T09:56:17Z"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。