帮助文档 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
帮助文档 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 弹性容器实例 ECI
  4. 开发参考
  5. API参考
  6. API目录
  7. 集群
  8. ListUserKubeConfigStates - 获取指定用户所有集群的 KubeConfig 状态列表

ListUserKubeConfigStates - 获取指定用户所有集群的 KubeConfig 状态列表

  • 集群
  • 发布于 2025-04-15
  • 0 次阅读
文档编辑
文档编辑

如果您需要查看当前用户各个集群KubeConfig的下发情况,您可以调用ListUserKubeConfigStates接口来获取当前用户所有集群的KubeConfig状态列表。

接口说明

说明 使用该接口需要拥有管理容器服务(CS)的权限(AliyunCSFullAccess)

调试

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

调试

授权信息

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

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

请求语法

GET /users/{Uid}/kubeconfig/states HTTP/1.1

请求参数

名称类型必填描述示例值
Uidstring否

阿里云账号内指定 RAM 用户或 RAM 角色 ID。

2xxxxxxxxxxxxxxxxxx
page_numberinteger否

页码。

  • 取值范围:大于等于 1

  • 默认值:1

2
page_sizeinteger否

页大小。

  • 取值范围:1-100

  • 默认值:50

10

返回参数

名称类型描述示例值
object

返回体参数。

statesarray<object>

用户 KubeConfig 状态详情。

stateobject
cluster_idstring

集群 ID。

c5b5e80b0b64a4bf6939d2d8fbbc5****
cert_expire_timestring

KubeConfig 证书过期时间。格式:RFC3339 格式的 UTC 时间。

2026-11-30T07:41:50Z
cert_statestring

KubeConfig 证书当前状态。 包含以下状态:

  • Expired: 证书已过期

  • Unexpired: 证书未过期

  • Unissued: 证书未颁发

  • Unknown: 未知状态

  • Removed: 已清除(证书存在颁发记录)

Unissued
cluster_statestring

集群运行状态,取值:

  • initial:集群创建中。
  • failed:集群创建失败。
  • running:集群运行中。
  • updating:集群升级中。
  • updating_failed:集群升级失败。
  • scaling:集群扩缩容中。
  • stopped:集群已经停止运行。
  • deleting:集群删除中。
  • deleted:集群已经被删除。
  • delete_failed:集群删除失败。
running
cluster_namestring

集群名称。

命名规则:长度为 1~63 个字符,可包含数字、下划线(_)或中划线(-),需以英文大小写字母、中文或数字开头。

cluster-demo
pageobject

分页参数。

page_numberinteger

页号。

1
page_sizeinteger

页大小。

10
total_countinteger

结果总数。

100

示例

正常返回示例

JSON格式

{
  "states": [
    {
      "cluster_id": "c5b5e80b0b64a4bf6939d2d8fbbc5****\n",
      "cert_expire_time": "2026-11-30T07:41:50Z",
      "cert_state": "Unissued",
      "cluster_state": "running",
      "cluster_name": "cluster-demo"
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 100
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
相关文章

CreateCluster - 创建集群 2025-04-15 17:15

您可以通过OpenAPI创建ACK集群,包含ACK托管集群、ACK Serverless集群,ACK Edge集群以及注册集群。创建集群时,您将完成集群信息、集群组件以及ACK相关云资源的配置。

DeleteCluster - 删除集群 2025-04-15 17:15

如果您的集群无需使用,请删除集群并选择是否删除或保留集群的相关资源。删除集群前,请手动清理工作负载(无状态、有状态、任务和定时任务),否则可能导致集群删除失败。

DescribeClustersV1 - 查询集群列表 2025-04-15 17:15

您可以调用DescribeClustersV1接口查看本账号下符合条件的ACK集群(例如指定集群类型、集群规格)列表信息。

DescribeClustersForRegion - 查询指定地域的集群列表 2025-04-15 17:15

查询指定地域内全部集群列表。

DescribeClusterDetail - 查询指定集群的信息 2025-04-15 17:15

您可以调用DescribeClusterDetail接口,根据集群ID查询指定集群的详细信息。

DescribeClusterResources - 查询指定集群的关联资源 2025-04-15 17:15

您在使用容器服务 Kubernetes 版过程中,会同时使用其他关联的阿里云云产品资源。您可以调用DescribeClusterResources接口查询指定集群的关联资源,例如VPC、SLB等。如果您需要查询节点池或节点资源,您可以调用Descri

目录
Copyright © 2025 your company All Rights Reserved. Powered by 博智数字服务平台.
闽ICP备08105208号-1