Menu Close

第 1 章 API

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

用户需要的访问权限: 您只能执行已分配角色的操作。如需更多关于访问要求的信息,请参阅基于角色的访问控制文档。

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

1.1. Clusters API

1.1.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的集群资源相关的 API 信息。集群资源有 4 个可用的请求:create、query、delete 和 update。

1.1.1.1. 版本信息

版本 : 2.1.0

1.1.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.1.1.3. 许可证信息

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

1.1.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.1.1.5. Tags

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

1.1.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.1.2. 路径

1.1.2.1. 查询所有集群

GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. 描述

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

1.1.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

1.1.2.1.3. 响应
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
1.1.2.2.1. 描述

创建集群

1.1.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

Body

正文
必需

描述要创建集群的参数。

Cluster

1.1.2.2.3. 响应
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" : { }
}

1.1.2.3. 查询单个集群

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

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

1.1.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

CLUSTER_NAME
必需

要查询的集群的名称。

字符串

1.1.2.3.3. 响应
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}
1.1.2.4.1. 描述

删除单个集群

1.1.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

CLUSTER_NAME
必需

要删除的集群的名称。

字符串

1.1.2.4.3. 响应
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

Name模式

apiVersion
必需

字符串

类型
必需

字符串

元数据
必需

对象

spec
必需

spec

spec

Name模式

hubAcceptsClient
required

bool

managedClusterClientConfigs
optional

< managedClusterClientConfigs > array

leaseDurationSeconds
optional

integer (int32)

managedClusterClientConfigs

Name描述模式

URL
必需

 

字符串

cabundle
可选

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

字符串(字节)