搜索

API

download PDF
Red Hat Advanced Cluster Management for Kubernetes 2.5

查看可用于创建和管理应用程序资源、频道、订阅和查询信息的 API 列表。

摘要

查看可用于创建和管理应用程序资源、频道、订阅和查询信息的 API 列表。

第 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.5.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
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

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}
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{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
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Name模式

hubAcceptsClient
必需

bool

managedClusterClientConfigs
可选

managedClusterClientConfigs 数组

leaseDurationSeconds
可选

integer (int32)

managedClusterClientConfigs

Name描述模式

URL
必需

 

字符串

CABundle
可选

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

字符串(字节)

1.2. Clustersets API (v1beta1)

1.2.1. 概述

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

1.2.1.1. 版本信息

版本 : 2.5.0

1.2.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.2.1.3. Tags
  • cluster.open-cluster-management.io:创建和管理 Clustersets

1.2.2. 路径

1.2.2.1. 查询所有集群集(clusterset)
GET /cluster.open-cluster-management.io/v1beta1/managedclustersets
1.2.2.1.1. 描述

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

1.2.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

1.2.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.1.4. 使用
  • clusterset/yaml
1.2.2.1.5. Tags
  • cluster.open-cluster-management.io
1.2.2.2. 创建一个 clusterset
POST /cluster.open-cluster-management.io/v1beta1/managedclustersets
1.2.2.2.1. 描述

创建 Clusterset。

1.2.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

Body

body
必需

描述要创建的 clusterset 的参数。

Clusterset

1.2.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.2.4. 使用
  • clusterset/yaml
1.2.2.2.5. Tags
  • cluster.open-cluster-management.io
1.2.2.2.6. HTTP 请求示例
1.2.2.2.6.1. 请求正文
{
  "apiVersion": "cluster.open-cluster-management.io/v1beta1",
  "kind": "ManagedClusterSet",
  "metadata": {
    "name": "clusterset1"
  },
  "spec": {
    "clusterSelector": {
      "selectorType": "LegacyClusterSetLabel"
    }
  },
  "status": {}
}
1.2.2.3. 查询单个集群集
GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
1.2.2.3.1. 描述

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

1.2.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

clusterset_name
必需

要查询的集群集的名称。

字符串

1.2.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.3.4. Tags
  • cluster.open-cluster-management.io
1.2.2.4. 删除集群集
DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
1.2.2.4.1. 描述

删除单个集群集。

1.2.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

clusterset_name
必需

要删除的集群集的名称。

字符串

1.2.2.4.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.4.4. Tags
  • cluster.open-cluster-management.io

1.2.3. 定义

1.2.3.1. Clusterset
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

1.3. Clustersetbindings API (v1beta1)

1.3.1. 概述

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

1.3.1.1. 版本信息

版本 : 2.5.0

1.3.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.3.1.3. Tags
  • cluster.open-cluster-management.io:创建和管理 clustersetbindings

1.3.2. 路径

1.3.2.1. 查询所有 clustersetbindings
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings
1.3.2.1.1. 描述

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

1.3.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.3.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.3.2.1.4. 使用
  • clustersetbinding/yaml
1.3.2.1.5. Tags
  • cluster.open-cluster-management.io
1.3.2.2. 创建 clustersetbinding
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings
1.3.2.2.1. 描述

创建 clustersetbinding。

1.3.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的 clustersetbinding 的参数。

Clustersetbinding

1.3.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.3.2.2.4. 使用
  • clustersetbinding/yaml
1.3.2.2.5. Tags
  • cluster.open-cluster-management.io
1.3.2.2.6. HTTP 请求示例
1.3.2.2.6.1. 请求正文
{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}
1.3.2.3. 查询单个 clustersetbinding
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.3.2.3.1. 描述

查询单个 clustersetbinding 获取更多详细信息。

1.3.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

路径

clustersetbinding_name
必需

要查询的 clustersetbinding 的名称。

字符串

1.3.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.3.2.3.4. Tags
  • cluster.open-cluster-management.io
1.3.2.4. 删除 clustersetbinding
DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersetbindings/{clustersetbinding_name}
1.3.2.4.1. 描述

删除单个 clustersetbinding。

1.3.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

路径

clustersetbinding_name
必需

要删除的 clustersetbinding 的名称。

字符串

1.3.2.4.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.3.2.4.4. Tags
  • cluster.open-cluster-management.io

1.3.3. 定义

1.3.3.1. Clustersetbinding
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Name模式

clusterSet
必需

字符串

1.4. Clusterview API (v1alpha1)

1.4.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 clusterview 资源相关的 API 信息。clusterview 资源提供了一个 CLI 命令,可让您查看您可以访问的受管集群和受管集群集的列表。三个可能的请求有:list、get 和 watch。

1.4.1.1. 版本信息

版本 : 2.5.0

1.4.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.4.1.3. Tags
  • clusterview.open-cluster-management.io:查看 ID 可访问的受管集群列表。

1.4.2. 路径

1.4.2.1. 获取受管集群
GET /managedclusters.clusterview.open-cluster-management.io
1.4.2.1.1. 描述

查看您可以访问的受管集群列表。

1.4.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

1.4.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.1.4. 使用
  • managedcluster/yaml
1.4.2.1.5. Tags
  • clusterview.open-cluster-management.io
1.4.2.2. 列出受管集群
LIST /managedclusters.clusterview.open-cluster-management.io
1.4.2.2.1. 描述

查看您可以访问的受管集群列表。

1.4.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

Body

body
可选

要列出受管集群的用户 ID 的名称。

字符串

1.4.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.2.4. 使用
  • managedcluster/yaml
1.4.2.2.5. Tags
  • clusterview.open-cluster-management.io
1.4.2.2.6. HTTP 请求示例
1.4.2.2.6.1. 请求正文
{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}
1.4.2.3. 观察受管集群集
WATCH /managedclusters.clusterview.open-cluster-management.io
1.4.2.3.1. 描述

观察您可以访问的受管集群。

1.4.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

clusterview_name
可选

要监视的用户 ID 的名称。

字符串

1.4.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.4. 列出受管集群集。
GET /managedclustersets.clusterview.open-cluster-management.io
1.4.2.4.1. 描述

列出您可以访问的受管集群。

1.4.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

clusterview_name
可选

要监视的用户 ID 的名称。

字符串

1.4.2.4.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.5. 列出受管集群集。
LIST /managedclustersets.clusterview.open-cluster-management.io
1.4.2.5.1. 描述

列出您可以访问的受管集群。

1.4.2.5.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

clusterview_name
可选

要监视的用户 ID 的名称。

字符串

1.4.2.5.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.6. 观察受管集群集。
WATCH /managedclustersets.clusterview.open-cluster-management.io
1.4.2.6.1. 描述

观察您可以访问的受管集群。

1.4.2.6.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

clusterview_name
可选

要监视的用户 ID 的名称。

字符串

1.4.2.6.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5. Channels API

1.5.1. 概述

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

1.5.1.1. 版本信息

版本 : 2.5.0

1.5.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.5.1.3. Tags
  • channels.apps.open-cluster-management.io : 创建和管理可部署性资源(deployables)

1.5.2. 路径

1.5.2.1. 创建频道
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.5.2.1.1. 描述

创建频道

1.5.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的 deployable 的参数。

Channel

1.5.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.1.4. 使用
  • application/yaml
1.5.2.1.5. Tags
  • channels.apps.open-cluster-management.io
1.5.2.1.6. HTTP 请求示例
1.5.2.1.6.1. 请求正文
{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "info-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}
1.5.2.2. 为目标命名空间查询所有频道
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.5.2.2.1. 描述

查询您的频道以获得更详细的信息。

1.5.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.5.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.2.4. 使用
  • application/yaml
1.5.2.2.5. Tags
  • channels.apps.open-cluster-management.io
1.5.2.3. 查询命名空间的单个频道
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.5.2.3.1. 描述

查询单个频道以了解更多详情。

1.5.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

channel_name
必需

您要查询的 deployable 的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.5.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.3.4. Tags
  • channels.apps.open-cluster-management.io
1.5.2.4. 删除频道
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.5.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

channel_name
必需

要删除的频道名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.5.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.4.3. Tags
  • channels.apps.open-cluster-management.io

1.5.3. 定义

1.5.3.1. Channel
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Name描述模式

configMapRef
可选

ObjectReference 包含足够信息供您检查或修改引用的对象。

configMapRef

gates
可选

ChannelGate 定义推广到频道的条件

gates

pathname
必需

 

字符串

secretRef
可选

ObjectReference 包含足够信息供您检查或修改引用的对象。

secretRef

sourceNamespaces
可选

 

enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) array

configMapRef

Name描述模式

apiVersion
可选

引用的 API 版本。

字符串

fieldPath
可选

如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的,且该字段在将来会有所改变。

字符串

kind
可选

引用的 kind更多信息:https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

字符串

name
可选

引用的名称。更多信息: 名称

字符串

namespace
可选

引用的命名空间更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

字符串

resourceVersion
可选

指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

字符串

uid
可选

引用的 UID。更多信息: UID

字符串

gates

Name描述模式

annotations
可选

k8s 的典型注解

annotations

labelSelector
可选

标签选择器,即一组资源的标签查询。matchLabels 和 matchExpressions 的逻辑关系是 AND。空标签选择器匹配所有对象。null 标签选择器不匹配任何对象。

labelSelector

name
可选

 

字符串

annotations

Name模式

key
可选

字符串

value
可选

字符串

labelSelector

Name描述模式

matchExpressions
可选

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions 数组

matchLabels
可选

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

字符串、字符串映射

matchExpressions

Name描述模式

key
必需

key 是选择器应用到的标签键。

字符串

operator
必需

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

字符串

values
可选

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

字符串数组

secretRef

Name描述模式

apiVersion
可选

引用的 API 版本。

字符串

fieldPath
可选

如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的,且该字段在将来会有所改变。

字符串

kind
可选

引用的 kind更多信息:https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

字符串

name
可选

引用的名称。更多信息: 名称

字符串

namespace
可选

引用的命名空间更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

字符串

resourceVersion
可选

指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

字符串

uid
可选

引用的 UID。更多信息: UIID

字符串

1.6. Subscriptions API

1.6.1. 概述

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

1.6.1.1. 版本信息

版本 : 2.5.0

1.6.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.6.1.3. Tags
  • subscription.apps.open-cluster-management.io : 创建和管理订阅

1.6.2. 路径

1.6.2.1. 创建订阅
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.1.1. 描述

创建订阅

1.6.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的订阅的参数。

Subscription

1.6.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.1.4. 使用
  • subscription/yaml
1.6.2.1.5. Tags
  • subscriptions.apps.open-cluster-management.io
1.6.2.1.6. HTTP 请求示例
1.6.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}
1.6.2.2. 查询所有订阅
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.6.2.2.1. 描述

查询您的订阅以获取更多详情。

1.6.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.6.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.2.4. 使用
  • subscription/yaml
1.6.2.2.5. Tags
  • subscriptions.apps.open-cluster-management.io
1.6.2.3. 查询单个订阅
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.3.1. 描述

查询单个订阅以了解更多详情。

1.6.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

路径

subscription_name
必需

要查询的订阅名称。

字符串

1.6.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.3.4. Tags
  • subscriptions.apps.open-cluster-management.io
1.6.2.4. 创建一个订阅:
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.6.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

路径

subscription_name
必需

要删除的订阅的名称。

字符串

1.6.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.4.3. Tags
  • subscriptions.apps.open-cluster-management.io

1.6.3. 定义

1.6.3.1. Subscription
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

metadata

spec
必需

spec

status
可选

status

metadata

Name模式

annotations
可选

对象

labels
可选

对象

name
可选

字符串

namespace
可选

字符串

spec

Name模式

channel
必需

字符串

name
可选

字符串

overrides
可选

overrides 数组

packageFilter
可选

packageFilter

packageOverrides
可选

packageOverrides 数组

placement
可选

placement

timewindow
可选

timewindow

overrides

Name模式

clusterName
必需

字符串

clusterOverrides
必需

对象数组

packageFilter

Name描述模式

annotations
可选

 

字符串、字符串映射

filterRef
可选

 

filterRef

labelSelector
可选

 

labelSelector

version
可选

Pattern : "()((\\.[0-9])(\\.)|(\\.[0-9])?(\\.[xX]))$"

字符串

filterRef

Name模式

name
可选

字符串

labelSelector

Name模式

matchExpressions
可选

matchExpressions 数组

matchLabels
可选

字符串、字符串映射

matchExpressions

Name模式

key
必需

字符串

operator
必需

字符串

values
可选

字符串数组

packageOverrides

Name模式

packageAlias
可选

字符串

packageName
必需

字符串

packageOverrides
可选

对象数组

placement

Name模式

clusterSelector
可选

clusterSelector

clusters
可选

clusters 数组

local
可选

布尔值

placementRef
可选

placementRef

clusterSelector

Name模式

matchExpressions
可选

matchExpressions 数组

matchLabels
可选

字符串、字符串映射

matchExpressions

Name模式

key
必需

字符串

operator
必需

字符串

values
可选

字符串数组

clusters

Name模式

name
必需

字符串

placementRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

timewindow

Name模式

daysofweek
可选

字符串数组

hours
可选

hours 数组

location
可选

字符串

windowtype
可选

enum(active、blocked、Active、Blocked)

hours

Name模式

end
可选

字符串

start
可选

字符串

status

Name模式

lastUpdateTime
可选

字符串(date-time)

message
可选

字符串

phase
可选

字符串

reason
可选

字符串

statuses
可选

对象

1.7. PlacementRules API

1.7.1. 概述

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

1.7.1.1. 版本信息

版本 : 2.5.0

1.7.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.7.1.3. Tags
  • placementrules.apps.open-cluster-management.io:创建和管理放置规则

1.7.2. 路径

1.7.2.1. 创建放置规则
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.1.1. 描述

创建放置规则。

1.7.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的放置规则的参数。

PlacementRule

1.7.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.1.4. 使用
  • application/yaml
1.7.2.1.5. Tags
  • placementrules.apps.open-cluster-management.io
1.7.2.1.6. HTTP 请求示例
1.7.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}
1.7.2.2. 查询所有放置规则
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.2.1. 描述

查询放置规则以获取更多详细信息。

1.7.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.7.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.2.4. 使用
  • application/yaml
1.7.2.2.5. Tags
  • placementrules.apps.open-cluster-management.io
1.7.2.3. 查询单个放置规则
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.3.1. 描述

查询单个放置规则以了解更多详细信息。

1.7.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

路径

placementrule_name
必需

要查询的放置规则的名称。

字符串

1.7.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.3.4. Tags
  • placementrules.apps.open-cluster-management.io
1.7.2.4. 删除放置规则
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

路径

placementrule_name
必需

要删除的放置规则的名称。

字符串

1.7.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.4.3. Tags
  • placementrules.apps.open-cluster-management.io

1.7.3. 定义

1.7.3.1. PlacementRule
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Name模式

clusterConditions
可选

clusterConditions 数组

clusterReplicas
可选

整数

clusterSelector
可选

clusterSelector

clusters
可选

clusters 数组

policies
可选

policies 数组

resourceHint
可选

resourceHint

schedulerName
可选

字符串

clusterConditions

Name模式

status
可选

字符串

type
可选

字符串

clusterSelector

Name模式

matchExpressions
可选

matchExpressions 数组

matchLabels
可选

字符串、字符串映射

matchExpressions

Name模式

key
可选

字符串

operator
可选

字符串

values
可选

字符串数组

clusters

Name模式

name
可选

字符串

policies

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

resourceHint

Name模式

order
可选

字符串

type
可选

字符串

1.8. Applications API

1.8.1. 概述

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

1.8.1.1. 版本信息

版本 : 2.5.0

1.8.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.8.1.3. Tags
  • Applications.app.k8s.io : 创建和管理应用程序

1.8.2. 路径

1.8.2.1. 创建应用程序
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.8.2.1.1. 描述

创建应用程序。

1.8.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的应用程序的参数。

Application

1.8.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.1.4. 使用
  • application/yaml
1.8.2.1.5. Tags
  • applications.app.k8s.io
1.8.2.1.6. HTTP 请求示例
1.8.2.1.6.1. 请求正文
{
  "apiVersion" : "app.k8s.io/v1beta1",
  "kind" : "Application",
  "metadata" : {
    "labels" : {
      "app" : "nginx-app-details"
    },
    "name" : "nginx-app-3",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "componentKinds" : [ {
      "group" : "apps.open-cluster-management.io",
      "kind" : "Subscription"
    } ]
  },
  "selector" : {
    "matchLabels" : {
      "app" : "nginx-app-details"
    }
  },
  "status" : { }
}
1.8.2.2. 查询所有应用程序
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.8.2.2.1. 描述

查询您的应用程序以获取更多详情。

1.8.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.8.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.2.4. 使用
  • application/yaml
1.8.2.2.5. Tags
  • applications.app.k8s.io
1.8.2.3. 查询单个应用程序
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.8.2.3.1. 描述

查询单个应用程序以获取更多详细信息。

1.8.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

application_name
必需

您要查询的应用程序的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.8.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.3.4. Tags
  • applications.app.k8s.io
1.8.2.4. 删除应用程序
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.8.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

application_name
必需

要删除的应用程序的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.8.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.4.3. Tags
  • applications.app.k8s.io

1.8.3. 定义

1.8.3.1. Application
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Name模式

assemblyPhase
可选

字符串

componentKinds
可选

对象数组

descriptor
可选

descriptor

info
可选

info 数组

selector
可选

对象

descriptor

Name模式

description
可选

字符串

icons
可选

icons 数组

keywords
可选

字符串数组

links
可选

links 数组

maintainers
可选

maintainers 数组

notes
可选

字符串

owners
可选

owners 数组

type
可选

字符串

version
可选

字符串

icons

Name模式

size
可选

字符串

src
必需

字符串

type
可选

字符串

Name模式

description
可选

字符串

url
可选

字符串

maintainers

Name模式

email
可选

字符串

name
可选

字符串

url
可选

字符串

owners

Name模式

email
可选

字符串

name
可选

字符串

url
可选

字符串

info

Name模式

name
可选

字符串

type
可选

字符串

value
可选

字符串

valueFrom
可选

valueFrom

valueFrom

Name模式

configMapKeyRef
optional

configMapKeyRef

ingressRef
可选

ingressRef

secretKeyRef
可选

secretKeyRef

serviceRef
可选

serviceRef

type
可选

字符串

configMapKeyRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

key
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

ingressRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

host
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

path
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

secretKeyRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

key
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

serviceRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

path
可选

字符串

port
可选

integer (int32)

resourceVersion
可选

字符串

uid
可选

字符串

1.9. Helm API

1.9.1. 概述

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

1.9.1.1. 版本信息

版本 : 2.5.0

1.9.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.9.1.3. Tags
  • helmreleases.apps.open-cluster-management.io : 创建和管理 helmreleases

1.9.2. 路径

1.9.2.1. 创建 helmrelease
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.1.1. 描述

创建 helmrelease。

1.9.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的 helmrelease 的参数。

HelmRelease

1.9.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.1.4. 使用
  • application/yaml
1.9.2.1.5. Tags
  • helmreleases.apps.open-cluster-management.io
1.9.2.1.6. HTTP 请求示例
1.9.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "HelmRelease",
  "metadata" : {
    "name" : "nginx-ingress",
    "namespace" : "default"
  },
  "repo" : {
    "chartName" : "nginx-ingress",
    "source" : {
      "helmRepo" : {
        "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
      },
      "type" : "helmrepo"
    },
    "version" : "1.26.0"
  },
  "spec" : {
    "defaultBackend" : {
      "replicaCount" : 3
    }
  }
}
1.9.2.2. 查询所有 helmreleases
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.9.2.2.1. 描述

查询您的 helmreleases 获取更多详细信息。

1.9.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.9.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.2.4. 使用
  • application/yaml
1.9.2.2.5. Tags
  • helmreleases.apps.open-cluster-management.io
1.9.2.3. 查询单个 helmrelease
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.3.1. 描述

查询单个 helmrelease 获取更多详细信息。

1.9.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

helmrelease_name
必需

要查询的 helmrelease 的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.9.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.3.4. Tags
  • helmreleases.apps.open-cluster-management.io
1.9.2.4. 删除 helmrelease
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.9.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

helmrelease_name
必需

要删除的 helmrelease 的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.9.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.4.3. Tags
  • helmreleases.apps.open-cluster-management.io

1.9.3. 定义

1.9.3.1. HelmRelease
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

repo
必需

repo

spec
必需

对象

status
必需

status

repo

Name模式

chartName
可选

字符串

configMapRef
可选

configMapRef

secretRef
可选

secretRef

source
可选

source

version
可选

字符串

configMapRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

secretRef

Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

source

Name模式

github
可选

github

helmRepo
可选

helmRepo

type
可选

字符串

github

Name模式

branch
可选

字符串

chartPath
可选

字符串

urls
可选

字符串数组

helmRepo

Name模式

urls
可选

字符串数组

status

Name模式

conditions
必需

conditions 数组

deployedRelease
可选

deployedRelease

conditions

Name模式

lastTransitionTime
可选

字符串(date-time)

message
可选

字符串

reason
可选

字符串

status
必需

字符串

type
必需

字符串

deployedRelease

Name模式

manifest
可选

字符串

name
可选

字符串

1.10. Policy API

1.10.1. 概述

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

1.10.1.1. 版本信息

版本 : 2.5.0

1.10.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.10.1.3. Tags
  • policy.open-cluster-management.io/v1 : 创建和管理策略

1.10.2. 路径

1.10.2.1. 创建策略
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.10.2.1.1. 描述

创建策略

1.10.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建策略的参数。

Application

1.10.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.1.4. 使用
  • application/json
1.10.2.1.5. Tags
  • policy.open-cluster-management.io
1.10.2.1.6. HTTP 请求示例
1.10.2.1.6.1. 请求正文
{
  "apiVersion": "policy.open-cluster-management.io/v1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1",
    "complianceType": "musthave",
    "metadataComplianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "musthave",
        "metadataComplianceType": "musthave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },
1.10.2.2. 查询所有策略
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.2.1. 描述

查询您的策略以获得更详细的信息。

1.10.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要应用策略的命名空间,如 default。

字符串

1.10.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.2.4. 使用
  • application/json
1.10.2.2.5. Tags
  • policy.open-cluster-management.io
1.10.2.3. 查询单个策略
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.3.1. 描述

查询单个策略以获取更多详细信息。

1.10.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

policy_name
必需

要查询的策略的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.10.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.3.4. Tags
  • policy.open-cluster-management.io
1.10.2.4. 删除策略
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
1.10.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

policy_name
必需

要删除的策略名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.10.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.4.3. Tags
  • policy.open-cluster-management.io

1.10.3. 定义

1.10.3.1. policy
Name描述模式

apiVersion
必需

策略的版本化模式(schema)。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Name描述模式

remediationAction
可选

代表资源中定义的处理违反情况的值。

字符串

namespaceSelector
必需

代表策略要应用到的命名空间的值。

字符串

policy-templates

Name描述模式

apiVersion
必需

策略的版本化模式(schema)。

字符串

kind
可选

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

complianceType

用于列出必须被评估或应用到受管集群的角色的预期行为和任何 Kubernetes 对象。

字符串

metadataComplianceType
optional

为用户提供处理对象标签和注解的方式与其他字段不同。参数值默认为 ComplianceType 参数的值相同。

字符串

clusterConditions
可选

定义标签的部分。

字符串

规则
可选

 

字符串

clusterConditions

Name描述模式

matchLabels
可选

策略应用到一个命名空间所需的标签。

对象

cloud
可选

策略应用到一个云供应商所需的标签。

字符串

rules

Name描述模式

apiGroups
必需

适用于该规则的 API 列表。

字符串

resources
必需

资源类型列表。

对象

verbs
必需

动词列表。

字符串

1.11. Observability API

1.11.1. 概述

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

1.11.1.1. 版本信息

版本 : 2.5.0

1.11.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.11.1.3. Tags
  • Observability.open-cluster-management.io : 创建和管理多集群的观察性

1.11.2. 路径

1.11.2.1. 创建 multiclusterobservability 资源
POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.1.1. 描述

创建 MultiClusterObservability 资源。

1.11.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

Body

body
必需

描述要创建的 MultiClusterObservability 资源的参数。

MultiClusterObservability

1.11.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.11.2.1.4. 使用
  • application/yaml
1.11.2.1.5. Tags
  • observability.apps.open-cluster-management.io
1.11.2.1.6. HTTP 请求示例
1.11.2.1.6.1. 请求正文
{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      "writeStorage": {
        - "key": " ",
          "name" : " "
        - "key": " ",
          "name" : " "
         }
       }
   }
}
1.11.2.2. 查询所有 multiclusterobservabilities
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.2.1. 描述

查询 MultiClusterObservability 资源以获取更多详细信息。

1.11.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

1.11.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.11.2.2.4. 使用
  • application/yaml
1.11.2.2.5. Tags
  • observability.apps.open-cluster-management.io
1.11.2.3. 查询单个 multiclusterobservability
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.11.2.3.1. 描述

查询单个 MultiClusterObservability 资源以获取更多详细信息。

1.11.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

multiclusterobservability_name
必需

要查询的 multiclusterobservability 的名称。

字符串

1.11.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.11.2.3.4. Tags
  • observability.apps.open-cluster-management.io
1.11.2.4. 删除一个 multiclusterobservability 资源
DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
1.11.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

multiclusterobservability_name
必需

要删除的 multiclusterobservability 的名称。

字符串

1.11.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.11.2.4.3. Tags
  • observability.apps.open-cluster-management.io

1.11.3. 定义

1.11.3.1. MultiClusterObservability
Name描述模式

apiVersion
必需

版本化的 MultiClusterObservability schema。

字符串

kind
必需

代表 REST 资源、MultiClusterObservability 的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Name描述模式

enableDownsampling
可选

启用或禁用 downsample。默认值为 true。如果没有 downsample 数据,则查询不可用。

布尔值

imagePullPolicy
可选

MultiClusterObservability 镜像的 pull 策略。默认值为 Always

corev1.PullPolicy

imagePullSecret
optional

MultiClusterObservability 镜像的 pull secret。默认值为 multiclusterhub-operator-pull-secret

字符串

nodeSelector
可选

节点选择器规格。

map[string]string

observabilityAddonSpec
required

所有安装了可观察附加组件的受管集群的全局设置。

observabilityAddonSpec

storageConfig
必需

指定可观察性要使用的存储配置。

StorageConfig

tolerations
可选

提供了所有组件可以容忍任何污点的功能。

[]corev1.Toleration

advanced
可选

可观察性的高级配置设置。

advanced

resources
可选

MultiClusterObservability 所需的计算资源。

corev1.ResourceRequirements

replicas
可选

MultiClusterObservability 副本。

integer

storageConfig

Name描述模式

alertmanagerStorageSize
可选

应用到 alertmanager 有状态集的存储量。默认值为 1Gi

字符串

compactStorageSize
可选

应用于 thanos 紧凑有状态集合的存储量。默认值为 100Gi

字符串

metricObjectStorage
必需

用于为指标配置 secret 的对象存储。

metricObjectStorage

receiveStorageSize
可选

应用到 thanos 接收有状态集的存储量。默认值为 100Gi

字符串

ruleStorageSize
optional

应用到 thanos 规则有状态集的存储量。默认值为 1Gi

字符串

storageClass
可选

指定 storageClass 有状态的集合。如果为您的操作系统配置了 metricObjectStorage 来创建存储,则此存储用于对象存储。默认值为 gp2

字符串

storeStorageSize
optional

应用到 thanos 存储有状态集合的存储量。默认值为 10Gi

字符串

writeStorage
optional

端点访问信息列表。

[ ]WriteStorage

writeStorage

Name描述模式

name
必需

带有端点访问信息的 secret 名称。

字符串

key
必需

要从中选择的 secret 的密钥。

字符串

metricObjectStorage

Name描述模式

key
必需

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。请参阅 Thanos 文档

字符串

name
必需

metricObjectStorage 的名称。如需更多信息,请参阅 Kubernetes 名称

字符串

observabilityAddonSpec

Name描述模式

enableMetrics
可选

指示 Observability 附加组件是否将指标发送到 hub 集群。默认值为 true

布尔值

interval
可选

Observability 附加组件将指标发送到 hub 集群的间隔。默认值为 300 秒 (300s)。

integer

resources
可选

指标收集器资源要求的资源。默认 CPU 请求为 100m,内存请求为 100Mi

corev1.ResourceRequirements

advanced

名称描述模式

retentionConfig
可选

指定供可观察性使用的数据保留配置。

RetentionConfig

rbacQueryProxy
可选

指定 rbac-query-proxy 部署的副本和资源。

CommonSpec

grafana
可选

指定 grafana 部署的副本和资源

CommonSpec

alertmanager
可选

指定 alertmanager statefulset 的副本和资源。

CommonSpec

observatoriumAPI
可选

指定 observatorium-api 部署的副本和资源。

CommonSpec

queryFrontend
可选

为 query-frontend 部署指定副本和资源。

CommonSpec

query
可选

指定查询部署的副本和资源。

CommonSpec

receive
可选

指定接收 statefulset 的副本和资源。

CommonSpec

rule
可选

指定规则 statefulset 的副本和资源。

CommonSpec

store
可选

指定存储 statefulset 的副本和资源。

CommonSpec

CompactSpec
optional

指定紧凑 statefulset 的资源。

compact

storeMemcached
可选

指定 store-memcached 的副本、资源等。

storeMemcached

queryFrontendMemcached
可选

指定 query-frontend-memcached 的副本、资源等。

CacheConfig

retentionConfig

Name描述模式

blockDuration
可选

阻塞时间序列数据库(TSDB)块持续时间的时间长度。默认值为 2h

字符串

cleanupInterval
可选

清理部分上传块的频率,以及清理启用了 --wait 的删除标记的块的频率。默认值为 5m

字符串

deleteDelay
可选

从存储桶中删除标记要删除的块前的时间。默认值为 48h

字符串

retentionInLocal
可选

从本地存储保留原始样本的时间长度。默认值为 24h

字符串

retentionResolutionRaw
可选

在存储桶中保留原始分辨率样本的时间。默认值为 30 天(30d

字符串

retentionResolution5m
可选

在存储桶中保留分辨率 1 样本(5 分钟)的时间长度。默认值为 180 天(180d)。

字符串

retentionResolution1h
可选

在存储桶中保留分辨率 2 样本(1 小时)的时间长度。默认值为 0 天(0d)。

字符串

CompactSpec

名称描述模式

resources
可选

thanos 紧凑所需的计算资源。

corev1.ResourceRequirements

serviceAccountAnnotations
optional

annotations 是一个无结构的键值映射,它存储有紧凑的服务帐户。

map[string]string

storeMemcached

名称描述模式

resources
可选

MultiCLusterObservability 所需的计算资源.

corev1.ResourceRequirements

replicas
可选

MultiClusterObservability 副本。

integer

memoryLimitMb
optional

以 MB 为单位的 Memcached 内存限值。

integer

maxItemSize
可选

Memcached 的最大项目大小。默认值为 1m, min:1k, max:1024m

字符串

connectionLimit
optional

Memcached 同时连接数上限。默认值为

integer

status

名称描述模式

status
可选

status 包含 MultiClusterObservability 的不同条件状态。

metav1.Condition

CommonSpec

名称描述模式

resources
可选

组件所需的计算资源。

corev1.ResourceRequirements

replicas
可选

组件的副本。

integer

QuerySpec

名称

描述

模式

CommonSpec
optional

指定查询部署的副本和资源。

CommonSpec

serviceAccountAnnotations
optional

annotations 是一个无结构的键值映射,它会与查询服务帐户存储。

map[string]string

ReceiveSpec

名称

描述

模式

CommonSpec
optional

指定查询部署的副本和资源。

CommonSpec

serviceAccountAnnotations
optional

annotations 是一个无结构的键值映射,它会与查询服务帐户存储。

map[string]string

StoreSpec

名称

描述

模式

CommonSpec
optional

指定查询部署的副本和资源。

CommonSpec

serviceAccountAnnotations
optional

annotations 是一个无结构的键值映射,它会与查询服务帐户存储。

map[string]string

RuleSpec

名称

描述

模式

CommonSpec
optional

指定查询部署的副本和资源。

CommonSpec

evalInterval
optional

指定规则的评估间隔。

字符串

serviceAccountAnnotations
optional

annotations 是一个无结构的键值映射,它会与查询服务帐户存储。

map[string]string

1.12. 搜索自定义 API

1.12.1. 概述

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

1.12.1.1. 版本信息

版本 : 2.5.0

1.12.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.12.1.3. Tags
  • search.open-cluster-management.io/v1:创建和管理持久性卷

1.12.2. 路径

1.12.2.1. 创建 searchCustomization
POST /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.1.1. 描述

创建 searchCustomization。

1.12.2.1.2. 参数
类型名称描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建策略的参数。

 
1.12.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.1.4. 使用
  • searchCustomization/json
1.12.2.1.5. Tags
  • search.open-cluster-management.io
1.12.2.1.6. HTTP 请求示例
1.12.2.1.6.1. 请求正文
{
  "apiVersion": "search.open-cluster-management.io/v1",
  "kind": "SearchCustomization",
  "metadata": {
    "name": "test-search-swagger",
    "description": "Example body for SearchCustomization API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "search.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patch"
              ],
            },
          ],
        },
      },
    },
  },
1.12.2.2. 查询 searchCustomization
GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.2.1. 描述

查询您的 searchCustomization 获取更多详细信息。

1.12.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要应用策略的命名空间,如 default。

字符串

1.12.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.2.4. 使用
  • searchCustomization/json
1.12.2.2.5. Tags
  • search.open-cluster-management.io
1.12.2.3. 查询单个策略
GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.3.1. 描述

查询单个 searchCustomization 获取更多详细信息。

1.12.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

policy_name
必需

要查询的策略的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.12.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.3.4. Tags
  • search.open-cluster-management.io
1.12.2.4. 删除 searchCustomization
DELETE /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.12.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

policy_name
必需

要删除的策略名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.12.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.4.3. Tags
  • search.open-cluster-management.io

1.12.3. 定义

1.12.3.1. SearchCustomization
Name描述模式

apiVersion
必需

SearchCustomization 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Name描述模式

remediationAction
可选

代表资源中定义的处理违反情况的值。

字符串

namespaces
必需

代表应用策略时要包含排除哪些命名空间的值。

字符串

policy-templates

Name描述模式

apiVersion
必需

SearchCustomization 的版本化模式。

字符串

kind
可选

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

complianceType

用于列出必须被评估或应用到受管集群的角色的预期行为和任何 Kubernetes 对象。

字符串

clusterConditions
可选

定义标签的部分。

字符串

规则
可选

 

字符串

clusterConditions

Name描述模式

matchLabels
可选

策略应用到一个命名空间所需的标签。

对象

cloud
可选

策略应用到一个云供应商所需的标签。

字符串

rules

Name描述模式

apiGroups
必需

适用于该规则的 API 列表。

字符串

resources
必需

资源类型列表。

对象

verbs
必需

动词列表。

字符串

1.13. MultiClusterHub API

1.13.1. 概述

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

1.13.1.1. 版本信息

版本 : 2.5.0

1.13.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.13.1.3. Tags
  • multiclusterhubs.operator.open-cluster-management.io : 创建和管理多集群 hub operator

1.13.2. 路径

1.13.2.1. 创建 MultiClusterHub 资源
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch
1.13.2.1.1. 描述

创建一个 MultiClusterHub 资源来定义 multicluster hub 实例的配置。

1.13.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

Body

body
必需

描述要创建的 multicluster hub 的参数。

定义

1.13.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.13.2.1.4. 使用
  • multiclusterhubs/yaml
1.13.2.1.5. Tags
  • multiclusterhubs.operator.open-cluster-management.io
1.13.2.1.6. HTTP 请求示例
1.13.2.1.6.1. 请求正文
{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "name": "multiclusterhubs.operator.open-cluster-management.io"
    },
  "spec": {
    "group": "operator.open-cluster-management.io",
    "names": {
      "kind": "MultiClusterHub",
      "listKind": "MultiClusterHubList",
      "plural": "multiclusterhubs",
      "shortNames": [
          "mch"
	  ],
     "singular": "multiclusterhub"
     },
    "scope": "Namespaced",
    "versions": [
        {
	    "additionalPrinterColumns": [
                {
		   "description": "The overall status of the multicluster hub.",
                   "jsonPath": ".status.phase",
                   "name": "Status",
                   "type": "string"
		   },
               {
	           "jsonPath": ".metadata.creationTimestamp",
                   "name": "Age",
                   "type": "date"
		   }
            ],
            "name": "v1",
            "schema": {
                "openAPIV3Schema": {
                    "description": "MultiClusterHub defines the configuration for an instance of
          the multiCluster hub.",
        "properties": {
            "apiVersion": {
                "description": "APIVersion defines the versioned schema of this representation
              of an object. Servers should convert recognized schemas to the latest
              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
                "type": "string"
            },
            "kind": {
                "description": "Kind is a string value representing the REST resource this
              object represents. Servers may infer this from the endpoint the client
              submits requests to. Cannot be updated. The value is in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                "type": "string"
            },
            "metadata": {
                "type": "object"
            },
            "spec": {
                "description": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
                "properties": {
                    "availabilityConfig": {
                        "description": "Specifies deployment replication for improved availability.
                  Options are: Basic and High (default).",
                        "type": "string"
                },
                "customCAConfigmap": {
                    "description": "Provide the customized OpenShift default ingress CA certificate
                  to {product-title-short}.",
                  }
                    "type": "string"
                },
        "disableHubSelfManagement": {
                    "description": "Disable automatic import of the hub cluster as a managed
                  cluster.",
                    "type": "boolean"
                },
        "disableUpdateClusterImageSets": {
                    "description": "Disable automatic update of ClusterImageSets.",
                    "type": "boolean"
                },
                "hive": {
                    "description": "(Deprecated) Overrides for the default HiveConfig specification.",
                    "properties": {
        "additionalCertificateAuthorities": {
        "description": "(Deprecated) AdditionalCertificateAuthorities is
                      a list of references to secrets in the 'hive' namespace that
                      contain an additional Certificate Authority to use when communicating
                      with target clusters. These certificate authorities are
                      used in addition to any self-signed CA generated by each cluster
                      on installation.",
                           "items": {
                    "description": "LocalObjectReference contains the information
                        to let you locate the referenced object inside the same namespace.",
                    "properties": {
                    "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                     }
		             },
                    "type": "object"
                      },
                           "type": "array"
                    },
                       "backup": {
                    "description": "(Deprecated) Backup specifies configuration for backup
                      integration. If absent, backup integration is disabled.",
                    "properties": {
                    "minBackupPeriodSeconds": {
                    "description": "(Deprecated) MinBackupPeriodSeconds specifies
                          that a minimum of MinBackupPeriodSeconds occurs in between
                          each backup. This is used to rate limit backups. This potentially
                          batches together multiple changes into one backup. No backups
                          are lost for changes that happen during the interval
                          that is queued up, and results in a backup once
                          the interval has been completed.",
                    "type": "integer"
                        },
                    "velero": {
                    "description": "(Deprecated) Velero specifies configuration for the Velero backup integration.",
		    "properties": {
			"enabled": {
			    "description": "(Deprecated) Enabled dictates if the Velero backup integration is enabled. If not specified, the default is disabled.",
			    "type": "boolean"
			}
		   },
		    "type": "object"
				        }
				  },
				        "type": "object"
				     },
		    "externalDNS": {
		    "description": "(Deprecated) ExternalDNS specifies configuration for external-dns if it is to be deployed by Hive. If absent, external-dns is not deployed.",
		    "properties": {
		    "aws": {
		    "description": "(Deprecated) AWS contains AWS-specific settings for external DNS.",
		    "properties": {
		        "credentials": {
			    "description": "(Deprecated) Credentials reference a secret that is used to authenticate with AWS Route53. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have AWS keys named 'aws_access_key_id' and 'aws_secret_access_key'.",
			    "properties": {
				"name": {
																		            "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
																		                             "type": "string"
						    }
					},
			    "type": "object"
			}
		},
		   "type": "object"
					},
		   "gcp": {
		   "description": "(Deprecated) GCP contains Google Cloud Platform specific settings for external DNS.",
		   "properties": {
		       "credentials": {
			   "description": "(Deprecated) Credentials reference a secret that is used to authenticate with GCP DNS. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have a key names 'osServiceAccount.json'. The credentials must specify the project to use.",
			   "properties": {
			       "name": {
		   "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
				   "type": "string"
							}
						},
			   "type": "object"
			}
		},
		"type": "object"
					}
				},
				      "type": "object"
					},
		"failedProvisionConfig": {
		"description": "(Deprecated) FailedProvisionConfig is used to configure settings related to handling provision failures.",
		"properties": {
		"skipGatherLogs": {
		"description": "(Deprecated) SkipGatherLogs disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.",
	        "type": "boolean"
				   }
				},
				  "type": "object"
				  },
		"globalPullSecret": {
		"description": "(Deprecated) GlobalPullSecret is used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of GlobalPullSecret are merged with the specific pull secret for a cluster deployment(if specified), with precedence given to the contents of the pull secret for the cluster deployment.",
		"properties": {
		"name": {
		"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
		"type": "string"
			                }
				},
				  "type": "object"
							},
		"maintenanceMode": {
	        "description": "(Deprecated) MaintenanceMode can be set to true to disable the Hive controllers in situations where you need to ensure nothing is running that adds or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to zero for the 'hive-controllers' deployment to accomplish this.",
				  "type": "boolean"
							}
						},
			  "required": [
				         "failedProvisionConfig"
						     ],
			  "type": "object"
						 },
		"imagePullSecret": {
		    "description": "Override pull secret for accessing MultiClusterHub operand and endpoint images.",
		    "type": "string"
					},
		"ingress": {
		    "description": "Configuration options for ingress management.",
		    "properties": {
			"sslCiphers": {
	"description": "List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.",
			    "items": {
		    "type": "string"
					},
			    "type": "array"
						}
					},
			       "type": "object"
						},
			   "nodeSelector": {
		   "additionalProperties": {
				   "type": "string"
						},
			       "description": "Set the node selectors..",
			       "type": "object"
			},
			   "overrides": {
			       "description": "Developer overrides.",
			       "properties": {
		   "imagePullPolicy": {
		   "description": "Pull policy of the multicluster hub images.",
			               "type": "string"
							}
						},
			      "type": "object"
									},
		   "separateCertificateManagement": {
				     "description": "(Deprecated) Install cert-manager into its own namespace.",
				     "type": "boolean"
						    }
					   },
			   "type": "object"
		       },
		       "status": {
			 "description": "MulticlusterHubStatus defines the observed state of MultiClusterHub.",
			 "properties": {
			     "components": {
		      "additionalProperties": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating\ndetails about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
						},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
					},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				  "description": "Components []ComponentCondition `json:\"manifests,omitempty\"`",
				  "type": "object"
							},
			      "conditions": {
				  "description": "Conditions contain the different condition statuses for the MultiClusterHub.",
				  "items": {
		      "description": "StatusCondition contains condition information.",
				      "properties": {
		      "lastTransitionTime": {
		      "description": "LastTransitionTime is the last time the condition changed from one status to another.",
		      "format": "date-time",
		      "type": "string"
					},
		      "lastUpdateTime": {
		      "description": "The last time this condition was updated.",
		      "format": "date-time",
		      "type": "string"
					},
		      "message": {
		      "description": "Message is a human-readable message indicating details about the last status change.",
		      "type": "string"
						},
				          "reason": {
		      "description": "Reason is a (brief) reason for the last status change of the condition.",
		      "type": "string"
					},
					  "status": {
		      "description": "Status is the status of the condition. One of True, False, Unknown.",
		      "type": "string"
						},
					  "type": {
		      "description": "Type is the type of the cluster condition.",
		      "type": "string"
					}
				},
				     "type": "object"
						      },
				 "type": "array"
					},
			     "currentVersion": {
				 "description": "CurrentVersion indicates the current version..",
				 "type": "string"
						},
			     "desiredVersion": {
				 "description": "DesiredVersion indicates the desired version.",
				 "type": "string"
						 },
			     "phase": {
				 "description": "Represents the running phase of the MultiClusterHub",
				 "type": "string"
							}
						},
	                 "type": "object"
					   }
				   },
                "type": "object"
			        }
		         },
        "served": true,
        "storage": true,
        "subresources": {
	    "status": {}
	    }
	}
    ]
  }
}
1.13.2.2. 查询所有 MultiClusterHubs
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator
1.13.2.2.1. 描述

查询您的 multicluster hub operator 以获取更多详细信息。

1.13.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.13.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.13.2.2.4. 使用
  • operator/yaml
1.13.2.2.5. Tags
  • multiclusterhubs.operator.open-cluster-management.io
1.13.2.3. 查询 MultiClusterHub operator
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.13.2.3.1. 描述

查询单个 multicluster hub operator 以获取更多详细信息。

1.13.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

application_name
必需

您要查询的应用程序的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.13.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.13.2.3.4. Tags
  • multiclusterhubs.operator.open-cluster-management.io
1.13.2.4. 删除 MultiClusterHub operator
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
1.13.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

application_name
必需

要删除的 multicluster hub Operator 的名称。

字符串

路径

namespace
必需

要使用的命名空间,如 default。

字符串

1.13.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.13.2.4.3. Tags
  • multiclusterhubs.operator.open-cluster-management.io

1.13.3. 定义

1.13.3.1. multicluster hub operator
Name描述模式

apiVersion
必需

MultiClusterHub 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义资源的规则。

object

spec
必需

资源规格。

spec

spec

availabilityConfig
可选
指定部署复制以提高可用性。默认值为 High字符串

customCAConfigmap
可选

为 Red Hat Advanced Cluster Management 提供自定义的 OpenShift 默认入口 CA 证书。

字符串

disableHubSelfManagement
可选

禁用自动导入 hub 集群作为受管集群。

布尔值

disableUpdateClusterImageSets
optional

禁用 ClusterImageSets 的自动更新。

布尔值

hive
可选

(已弃用)用于覆盖默认 HiveConfig 规格的对象。

hive

imagePullSecret
optional

覆盖用于访问 MultiClusterHub 操作对象和端点镜像的 pull secret。

字符串

ingress
可选

入口管理的配置选项。

Ingress

nodeSelector
可选

设置节点选择器。

字符串

separateCertificateManagement
可选

(已弃用)将 cert-manager 安装到其自己的命名空间中。

布尔值

hive

additionalCertificateAuthorities
可选
(已弃用)到 hive 命名空间中的 secret 的引用列表,它包含了在与目标集群通信时要使用的额外证书颁发机构(CA)。除了安装时每个集群生成的任何自签名 CA 外,这些证书颁发机构也被使用。object

backup
可选

(已弃用)指定备份集成的配置。如果没有,则禁用备份集成。

backup

externalDNS
可选

(已弃用)如果要由 Hive 部署,指定 external-dns 的配置。如果不存在,则不会部署 external-dns

object

failedProvisionConfig
required

(已弃用)用于配置与处理调配失败相关的设置。

failedProvisionConfig

globalPullSecret
optional

(已弃用)用于指定供所有集群部署全局使用的 pull secret。对于每个集群部署,globalPullSecret 的内容都会与集群部署的特定 pull secret 合并(如果指定),优先于集群部署的 pull secret 的内容。

object

maintenanceMode
可选

(已弃用)在您需要确保没有运行任何会在 Hive 类型的 finalizer 上进行添加或操作时,可以使用它来禁用 hive 控制器。这应该很少需要。将 hive-controllers 部署的 replicas 设置为 0 来完成此操作。

布尔值

Ingress

sslCiphers
可选
为管理入口启用的 SSL 密码列表。默认为所支持密码的完整列表。字符串

backup

minBackupPeriodSeconds
可选
(已弃用)指定在每个备份之间的最小 MinBackupPeriodSeconds 。这用于对备份进行比率限制。这可能会将多个更改组合到一个备份中。因为在这一时间段内发生的更改会被放入排队,在备份间隔时间后这些队列中的更改会被备份,因此不会丢失备份数据。integer

velero
可选

(已弃用)Velero 指定 Velero 备份集成的配置。

object

failedProvisionConfig

skipGatherLogs
可选
(已弃用)当安装因为任何原因失败时,禁用尝试从集群收集完整日志的功能。日志会存储在持久卷中,并最多存储七天。布尔值

status

components
可选
状态配置的组件。object

conditions
可选

包含 multicluster hub 的不同条件。

conditions

desiredVersion
可选

表示所需的版本。

字符串

phase
可选

代表 MultiClusterHub 资源的活跃阶段。用于此参数的值包括: PendingRunningInstallingUpdating 、Uninstalling

字符串

conditions

lastTransitionTime
可选
条件从一个状态变为另一个状态的最后一次的时间。字符串

lastUpdateTime
可选

最后一次更新此条件的时间。

字符串

message
必需

Message 是人类可读的消息,表示关于上次状态更改的详细信息。

字符串

reason
必需

条件发生状态更改的原因。

字符串

status
必需

条件的状态。

字符串

type
必需

集群条件的类型。

字符串

StatusConditions

kind
必需
代表此状态的资源 kind字符串

available
必需

指明此组件是否在正确运行。

布尔值

lastTransitionTime
可选

条件从一个状态变为另一个状态的最后一次的时间。

metav1.time

lastUpdateTime
可选

最后一次更新此条件的时间。

metav1.time

message
必需

Message 是人类可读的消息,表示关于上次状态更改的详细信息。

字符串

reason
可选

条件发生状态更改的原因。

字符串

status
可选

条件的状态。

字符串

type
可选

集群条件的类型。

字符串

1.14. Placements API (v1beta1)

1.14.1. 概述

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

1.14.1.1. 版本信息

版本 : 2.5.0

1.14.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.14.1.3. Tags
  • cluster.open-cluster-management.io:创建和管理放置

1.14.2. 路径

1.14.2.1. 查询所有放置
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.14.2.1.1. 描述

查询您的放置以获取更多详细信息。

1.14.2.1.2. 参数
类型名称描述模式

Header

COOKIE
必需

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

字符串

1.14.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.14.2.1.4. 使用
  • placement/yaml
1.14.2.1.5. Tags
  • cluster.open-cluster-management.io
1.14.2.2. 创建一个放置
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.14.2.2.1. 描述

创建一个放置。

1.14.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

Body

body
必需

描述要创建的放置的参数。

Placement

1.14.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.14.2.2.4. 使用
  • placement/yaml
1.14.2.2.5. Tags
  • cluster.open-cluster-management.io
1.14.2.2.6. HTTP 请求示例
1.14.2.2.6.1. 请求正文
{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}
1.14.2.3. 查询单个放置
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.14.2.3.1. 描述

查询单个放置以获取更多详细信息。

1.14.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

placement_name
必需

要查询的放置名称。

字符串

1.14.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.14.2.3.4. Tags
  • cluster.open-cluster-management.io
1.14.2.4. 删除一个放置
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
1.14.2.4.1. 描述

删除一个放置。

1.14.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

placement_name
必需

要删除的放置名称。

字符串

1.14.2.4.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.14.2.4.4. Tags
  • cluster.open-cluster-management.io

1.14.3. 定义

1.14.3.1. Placement
Name描述模式

apiVersion
必需

放置的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

放置的元数据。

object

spec
必需

放置的规格。

spec

spec

Name描述模式

ClusterSets
可选

从中选择 ManagedClusterSet 的 ManagedClusterSet 子集。如果为空,则从绑定到 Placement 命名空间的 ManagedClusterSets 中选择 ManagedClusters。否则,ManagedClusters 会从这个子集的交集中选择,ManagedClusterSets 会绑定到 placement 命名空间。

字符串数组

numberOfClusters
可选

要选择的 ManagedClusters 数量。

integer (int32)

predicates
可选

选择 ManagedClusters 的集群 predicates 子集。条件逻辑为 OR

clusterPredicate 数组

clusterPredicate

Name描述模式

requiredClusterSelector
可选

选择带有标签和集群声明的 ManagedClusters 的集群选择器。

clusterSelector

clusterSelector

Name描述模式

labelSelector
可选

按标签的 ManagedClusters 选择器。

object

claimSelector
可选

按声明的 ManagedClusters 选择器。

clusterClaimSelector

clusterClaimSelector

Name描述模式

matchExpressions
可选

集群声明选择器要求的子集。条件逻辑是 AND

< object > 数组

1.15. PlacementDecisions API (v1beta1)

1.15.1. 概述

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

1.15.1.1. 版本信息

版本 : 2.5.0

1.15.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.15.1.3. Tags
  • cluster.open-cluster-management.io:创建和管理放置Decisions。

1.15.2. 路径

1.15.2.1. 查询所有 PlacementDecisions
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
1.15.2.1.1. 描述

查询您的 PlacementDecisions 获取更多详细信息。

1.15.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

1.15.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.15.2.1.4. 使用
  • placementdecision/yaml
1.15.2.1.5. Tags
  • cluster.open-cluster-management.io
1.15.2.2. 创建 PlacementDecision
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
1.15.2.2.1. 描述

创建 PlacementDecision。

1.15.2.2.2. 参数
类型名称描述模式

Header

COOKIE
必需

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

字符串

Body

body
必需

描述要创建的 PlacementDecision 的参数。

PlacementDecision

1.15.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.15.2.2.4. 使用
  • placementdecision/yaml
1.15.2.2.5. Tags
  • cluster.open-cluster-management.io
1.15.2.2.6. HTTP 请求示例
1.15.2.2.6.1. 请求正文
{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta1",
  "kind" : "PlacementDecision",
  "metadata" : {
    "labels" : {
      "cluster.open-cluster-management.io/placement" : "placement1"
    },
    "name" : "placement1-decision1",
    "namespace": "ns1"
  },
  "status" : { }
}
1.15.2.3. 查询单个 PlacementDecision
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
1.15.2.3.1. 描述

查询单个 PlacementDecision 获取更多详细信息。

1.15.2.3.2. 参数
类型名称描述模式

Header

COOKIE
必需

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

字符串

路径

placementdecision_name
必需

要查询的 PlacementDecision 的名称。

字符串

1.15.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.15.2.3.4. Tags
  • cluster.open-cluster-management.io
1.15.2.4. 删除 PlacementDecision
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
1.15.2.4.1. 描述

删除单个 PlacementDecision。

1.15.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

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

字符串

路径

placementdecision_name
必需

要删除的 PlacementDecision 的名称。

字符串

1.15.2.4.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误