Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

第 1 章 API

您可以使用 API 来创建和管理应用程序资源、频道、订阅和查询信息。

用户需要的访问权限： 您只能执行已分配角色的操作。了解 基于角色的访问控制文档中的访问要求。

您还可以从集成控制台访问所有 API。在 local-cluster 视图中，进入到 Home > API Explorer 以探索 API 组。

如需更多信息，请参阅以下每个资源的 API 文档：

1.1. Clusters API
复制链接

1.1.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的集群资源相关的 API 信息。集群资源有 4 个可用的请求：create、query、delete 和 update。ManagedCluster 代表受管集群的所需状态和当前状态。ManagedCluster 是一个集群范围的资源。

1.1.1.1. 版本信息
复制链接

版本 : 2.11.0

1.1.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.1.1.3. Tags
复制链接

  • cluster.open-cluster-management.io：创建和管理集群

1.1.2. 路径
复制链接

1.1.2.1. 查询所有集群
复制链接

GET /cluster.open-cluster-management.io/v1/managedclusters
Copy to Clipboard Toggle word wrap
1.1.2.1.1. 描述
复制链接

查询集群以获取更多详细信息。

1.1.2.1.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

1.1.2.1.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.1.4. 使用
复制链接
  • cluster/yaml
1.1.2.1.5. Tags
复制链接
  • cluster.open-cluster-management.io

1.1.2.2. 创建集群
复制链接

POST /cluster.open-cluster-management.io/v1/managedclusters
Copy to Clipboard Toggle word wrap
1.1.2.2.1. 描述
复制链接

创建集群

1.1.2.2.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

body
必需

描述要创建集群的参数。

Cluster

1.1.2.2.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.2.4. 使用
复制链接
  • cluster/yaml
1.1.2.2.5. Tags
复制链接
  • cluster.open-cluster-management.io
1.1.2.2.6. HTTP 请求示例
复制链接
1.1.2.2.6.1. 请求正文
复制链接
{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}
Copy to Clipboard Toggle word wrap

1.1.2.3. 查询单个集群
复制链接

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
Copy to Clipboard Toggle word wrap
1.1.2.3.1. 描述
复制链接

查询单个集群以获取更多详细信息。

1.1.2.3.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

cluster_name
必需

要查询的集群的名称。

字符串

1.1.2.3.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.3.4. Tags
复制链接
  • cluster.open-cluster-management.io

1.1.2.4. 删除集群
复制链接

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
Copy to Clipboard Toggle word wrap 
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
Copy to Clipboard Toggle word wrap
1.1.2.4.1. 描述
复制链接

删除单个集群

1.1.2.4.2. 参数
复制链接
Expand
类型Name描述模式

标头

COOKIE
必需

身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

cluster_name
必需

要删除的集群的名称。

字符串

1.1.2.4.3. 响应
复制链接
Expand
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.4.4. Tags
复制链接
  • cluster.open-cluster-management.io

1.1.3. 定义
复制链接

1.1.3.1. Cluster
复制链接

Expand
Name描述模式

apiVersion
必需

ManagedCluster 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

ManagedCluster 的元数据。

对象

spec
必需

ManagedCluster 的规格。

spec

spec

Expand
Name描述模式

hubAcceptsClient
必需

指定 hub 是否可以与受管集群中的 klusterlet 代理建立连接。默认值为 false，且只能在 hub 集群中配置了 RBAC 规则时更改为 true，供您对 managedclusters/accept 的虚拟子资源进行更新。

bool

managedClusterClientConfigs
可选

列出受管集群的 apiserver 地址。

managedClusterClientConfigs 数组

leaseDurationSeconds
可选

指定受管集群中 klusterlet 代理的租期更新时间间隔。默认情况下，Klusterlet 代理每 60 秒更新其租期。

integer (int32)

taint
可选

防止在调度过程中将受管集群分配给一个或多个受管集群集。

污点 数组

managedClusterClientConfigs

Expand
Name描述模式

URL
必需

 

字符串

CABundle
可选

Pattern : 

"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
Copy to Clipboard Toggle word wrap

字符串（字节）

taint

Expand
Name描述模式

key
必需

应用到集群的污点键。

字符串

value
可选

与污点键对应的污点值。

字符串

effect
可选

污点对于不容许污点的放置的影响。有效值为 NoSelect、PreferNoSelect 和 NoSelectIfNew。

字符串

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat