Language:
Format:

Language:
Format:

第 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

11.1.2.1.1. 描述

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

11.1.2.1.2. 参数

类型	Name	描述	模式
Header	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串

11.1.2.1.3. 响应

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

11.1.2.2.1. 描述

创建集群

11.1.2.2.2. 参数

类型	Name	描述	模式
Header	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
Body	body 必需	描述要创建集群的参数。	Cluster

11.1.2.2.3. 响应

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" : { }
}

11.1.2.3. 查询单个集群

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

11.1.2.3.1. 描述

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

11.1.2.3.2. 参数

类型	Name	描述	模式
Header	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	cluster_name 必需	要查询的集群的名称。	字符串

11.1.2.3.3. 响应

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}

11.1.2.4.1. 描述

删除单个集群

11.1.2.4.2. 参数

类型	Name	描述	模式
Header	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	cluster_name 必需	要删除的集群的名称。	字符串

11.1.2.4.3. 响应

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

Name	模式
apiVersion 必需	字符串
kind 必需	字符串
metadata 必需	对象
spec 必需	spec

spec

Name	模式
hubAcceptsClient 必需	bool
managedClusterClientConfigs 可选	< managedClusterClientConfigs > array
leaseDurationSeconds 可选	integer (int32)

managedClusterClientConfigs

Name	描述	模式
URL 必需		字符串
CABundle 可选	Pattern : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`	字符串（字节）

Language and Page Formatting Options