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

第 11 章 API

您可以使用 Kubernetes operator 的多集群引擎来访问集群生命周期管理的 API。用户需要的访问权限： 您只能执行已分配角色的操作。如需更多信息，请参阅以下每个资源的 API 文档：

11.1. Clusters API
复制链接

11.1.1. 概述
复制链接

本文档介绍了与 Kubernetes 的多集群引擎的集群资源相关的 API 信息。集群资源有 4 个可用的请求：create、query、delete 和 update。

11.1.1.1. 联系信息
复制链接

Contact Email : apiteam@swagger.io

11.1.1.2. 许可证信息
复制链接

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/

11.1.1.3. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

11.1.1.4. Tags
复制链接

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

11.1.1.5. 外部文档
复制链接

描述 : 查找更多有关 Swagger 的信息。
URL : http://swagger.io

11.1.2. 路径
复制链接

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

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

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

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

Header

COOKIE
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

11.1.2.2. 创建集群
复制链接

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

创建集群

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

Header

COOKIE
必需

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

字符串

Body

body
必需

描述要创建集群的参数。

Cluster

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

11.1.2.2.4. 使用
复制链接
  • cluster/yaml
11.1.2.2.5. Tags
复制链接
  • cluster.open-cluster-management.io
11.1.2.2.6. HTTP 请求示例
复制链接
11.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

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

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

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

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

Header

COOKIE
必需

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

字符串

路径

cluster_name
必需

要查询的集群的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

11.1.2.4. 删除集群
复制链接

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

删除单个集群

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

Header

COOKIE
必需

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

字符串

路径

cluster_name
必需

要删除的集群的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

11.1.3. 定义
复制链接

11.1.3.1. Cluster
复制链接

Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Expand
Name模式

hubAcceptsClient
必需

bool

managedClusterClientConfigs
可选

< managedClusterClientConfigs > array

leaseDurationSeconds
可选

integer (int32)

managedClusterClientConfigs

Expand
Name描述模式

URL
必需

 

字符串

CABundle
可选

Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

字符串（字节）

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat