调用DescribeClusterUserKubeconfig返回包含当前登录用户身份信息的Kubernetes集群访问kubeconfig。

调试

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

请求语法

GET /k8s/ClusterId/user_config?PrivateIpAddress=Boolean&TemporaryDurationMinutes=Long HTTP/1.1
Content-Type:application/json

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
ClusterId String c5b5e80b0b64a4bf6939d2d8fbbc5****

集群ID。

表 2. 请求Query参数
参数名称 类型 是否必选 示例 说明
PrivateIpAddress Boolean true

是否获取内网连接配置。取值:

  • ture:仅获取内网连接凭据。
  • false:仅获取公网连接凭据。

默认值:false

TemporaryDurationMinutes Long 15

临时kubeconfig有效期,单位:分钟。取值范围:15(15分钟)~4320(3天)。

说明
  • 当设置该参数时,将返回具有指定有效期限的集群访问配置,具体过期时间通过返回的expiration字段的值确定。
  • 当不设置该参数时,将返回长期有效的集群访问配置。

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "config" : "String",
  "expiration" : "String"
}

响应参数

表 3. 响应Body参数
参数名称 类型 示例 说明
config String apiVersion: v1****

集群访问配置。关于如何查看访问集群配置信息,请参见配置集群凭据

expiration String 2024-03-10T09:56:17Z

kubeconfig的过期时间。格式:RFC3339格式的UTC时间。

获取集群kubeconfig接口示例

请求示例

GET /k8s/c5b5e80b0b64a4bf6939d2d8fbbc5****/user_config?PrivateIpAddress=true&TemporaryDurationMinutes=15 HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<config>
apiVersion: v1
clusters:
- cluster:
...
</config>
<expiration>2021-03-25T10:01:20Z</expiration>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "config" : "\napiVersion: v1\nclusters:\n- cluster:\n...\n",
  "expiration" : "2021-03-25T10:01:20Z"
}

错误码

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