使用阿里云账号调用DescribeSubaccountK8sClusterUserConfig，获取包含账号内指定RAM用户或RAM角色身份信息的Kubernetes集群的KubeConfig凭证。

说明 该接口只允许被阿里云账号调用。

调试

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

请求语法

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

请求参数

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

集群ID。
Uid String 是 26562443851650****

阿里云账号内指定的RAM用户或RAM角色ID。
表 2. 请求Query参数
参数名称 类型 是否必选 示例 说明
PrivateIpAddress Boolean 否 true

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

  • true：仅获取内网连接的KubeConfig凭证。
  • false：仅获取公网连接的KubeConfig凭证。

默认值：false。
TemporaryDurationMinutes Long 否 15

临时KubeConfig有效期，单位：分钟。

取值范围：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时间。

示例

请求示例

GET /k8s/c5b5e80b0b64a4bf6939d2d8f****/users/26562443851650****/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

<DescribeSubaccountK8sClusterUserConfigResponse>
    <config>apiVersion: v1****</config>
    <expiration>2024-03-10T09:56:17Z</expiration>
</DescribeSubaccountK8sClusterUserConfigResponse>

JSON格式

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

{
  "config" : "apiVersion: v1****",
  "expiration" : "2024-03-10T09:56:17Z"
}

错误码

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

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK，帮助您快速通过API集成阿里云的产品和服务，推荐您使用SDK调用API，已免除您手动签名验证。

  • OpenAPI Explorer

    快速检索，可视化调试API，在线命令行工具，同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具，可通过命令方式同时管理多个阿里云产品和服务，简单快捷，是您上云好帮手。