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.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.1.1.3. 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}=)?$"`	字符串（字节）

taint

Expand

Name	描述	模式
key 必需	应用到集群的污点键。	字符串
value 可选	与污点键对应的污点值。	字符串
effect 可选	污点对于不容许污点的放置的影响。有效值为 `NoSelect`、`PreferNoSelect` 和 `NoSelectIfNew`。	string

Name	描述	模式
apiVersion 必需	`ClusterInstance` 的版本化模式。	string
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	`ClusterInstance` 的元数据。	object
spec 必需	`ClusterInstance` 的规格。	spec
status 必需	`ClusterInstance` 的状态。	Status 对象

Name	描述	模式
additionalNTPSources optional	指定需要添加到所有集群主机的 NTP 源。它们被添加到任何通过其他方法配置的 NTP 源中。	数组
baseDomain 必需	指定用于部署集群的基域。	string
caBundleRef optional	引用包含主机可信证书捆绑包的 `ConfigMap` 对象。`ConfigMap` 对象中的 `tls-ca-bundle.pem` 条目被写入 `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem`。	string
clusterImageSetNameRef required	指定指示要部署的 OpenShift Container Platform 版本的 `ClusterImageSet` 对象的名称。	string
clusterName 必需	指定集群的名称。	string
clusterNetwork 可选	指定 pod 的 IP 地址池列表。	数组
clusterType 可选	指定集群类型。支持以下值： `SNO` single-node OpenShift `HighlyAvailable` Multi-node OpenShift	string
cpuPartitioningMode optional	决定在安装时为 CPU 工作负载分区设置的集群。通过将 `cpuPartitioningMode` 的值设置为 `AllNodes` 来配置工作负载分区。要完成配置，请在 `PerformanceProfile` CR 中指定 `isolated` 和 `reserved` CPU。默认值为 `None`。	string
diskEncryption 可选	为集群启用或禁用磁盘加密。	object
extraAnnotations 可选	使用以下格式指定要应用到呈现的模板的额外集群级别注解： `extraAnnotations: ClusterDeployment: myClusterAnnotation: success`	object
extraLabels 可选	使用以下格式指定要应用到呈现的模板的额外集群级别标签： `extraLabels: ManagedCluster: common: "true" label-a : "value-a"`	object
extraManifestsRefs optional	指定包含要应用到集群的额外清单的 `ConfigMap` 对象引用列表。	数组
holdInstallation optional	设置为 `true` 以防止在使用 Assisted Installer 时进行安装。您可以完成检查和验证步骤，但在 `RequirementsMet` 条件变为 `true` 后，安装不会开始，直到 `holdInstallation` 字段被设置为 `false` 为止。	bool
ignitionConfigOverride optional	指定用户覆盖初始 Ignition 配置。	string
installConfigOverrides optional	定义安装配置参数。	string
machineNetwork 可选	指定机器的 IP 地址池列表。	数组
networkType 可选	指定要安装的 Container Network Interface (CNI)插件。IPv4 或单节点 OpenShift 集群的默认值为 `OpenShiftSDN`。	string
platformType 可选	定义您要安装的特定平台的名称。支持以下值： `裸机` `vSphere` `Nutanix` `外部` `""` `None`	string
代理可选	定义用于集群安装配置的代理设置。	对象
pruneManifests 可选	通过指定 `apiVersion` 和 `Kind` 值，定义要删除的集群级别清单列表。	数组
pullSecretRef required	配置 `pull-secret` 文件以拉取镜像。在创建 `pull-secret` 文件时，请使用与置备主机的 `ClusterInstance` CR 相同的命名空间。	对象
serviceNetwork optional	指定服务的 IP 地址池列表。	数组
sshPublicKey optional	指定提供实例访问权限的公共 Secure Shell (SSH)密钥。此密钥添加到主机以允许 SSH 访问。	字符串
需要节点	指定每个节点的配置参数。	nodes 数组
templateRefs 必需	指定对集群级别模板的引用列表。集群级模板由一个 `ConfigMap` 对象组成，其中 data 字段的键代表安装清单类型。集群级模板会在 `ClusterInstance` CR 中每个集群实例化一次。	数组

Name	描述	模式
automatedCleaningMode optional	将值设为 `metadata` 以仅启用删除磁盘的分区表，而无需完全擦除磁盘。默认值为 `Disabled`。	字符串
bmcAddress required	用于访问主机的 BMC 地址。适用于所有集群类型。有关 BMC 寻址的更多信息，请参阅附加资源中的 BMC 地址。注：在边缘 Telco 用例中，只有虚拟介质才支持与 GitOps ZTP 搭配使用。	字符串
bmcCredentialsName required	配置使用主机 BMC 凭证单独创建的 `bmh-secret` CR。在创建 `bmh-secret` CR 时，请使用与置备主机的 `ClusterInstance` CR 相同的命名空间。	字符串
bootMACAddress required	指定 PXE 引导的 MAC 地址。`libvirt` 虚拟机是由虚拟 BMC 驱动的 libvirt 虚拟机。	字符串
bootMode optional	将主机的引导模式设置为 `UEFI`。默认值为 `UEFI`。使用 `UEFISecureBoot` 在主机上启用安全引导。支持以下值： `UEFI` `UEFISecureBoot` `传统`	字符串
extraAnnotations optional	使用以下格式指定要应用到呈现的模板的额外节点级别注解： `extraAnnotations: BareMetalHost: myNodeAnnotation: success`	对象
extraLabels optional	指定要应用到渲染的模板的额外节点级别标签。 `extraLabels: ManagedCluster: common: "true" label-a : "value-a"`	对象
hostName required	定义主机名。	字符串
installerArgs 可选	指定主机的 :op-system-first: 安装程序参数的用户覆盖。	字符串
ignitionConfigOverride optional	指定用户覆盖初始 Ignition 配置。使用此字段为持久性存储分配分区。将磁盘 ID 和大小调整为特定的硬件。	字符串
ironicInspect optional	指定在注册裸机主机时是否运行自动内省。	字符串
nodeLabels optional	在受管集群中为节点指定自定义节点标签。这些是用户不由任何 Red Hat Advanced Cluster Management 组件使用的额外标签。添加自定义节点标签时，可以关联到自定义机器配置池，该池引用该标签的特定配置。在安装过程中添加自定义节点标签使部署过程更高效，并防止在安装完成后进行额外的重启。注：在 `BareMetalHost` 模板中使用时，自定义标签会附加到带有 `bmac.agent-install.openshift.io` 前缀的 `BareMetalHost` 注解中。	对象
nodeNetwork optional	为具有静态网络的节点配置网络设置。	对象
pruneManifests 可选	通过指定 `apiVersion` 和 `Kind` 值，定义要删除的节点级别清单列表。	数组
角色可选	配置节点的角色，如 `master` 或 `worker`。	字符串
rootDeviceHints optional	指定用于部署的设备。建议在重启后保持标识符稳定。例如，`wwn: <disk_wwn>` 或 `deviceName: /dev/disk/by-path/<device_path>`.首选 `<by-path>` 值。有关 stable 标识符的详细列表，请参阅"About root device hints"。您还可以指定该设备的名称、型号、大小或厂商。	对象
templateRefs 必需	指定对节点级别模板的引用列表。节点级别模板由一个 `ConfigMap` 对象组成，其中 data 字段的键代表安装清单类型。为 `ClusterInstance` CR 中的每个节点实例化节点级别的模板一次。	数组

Name	描述	模式
conditions 可选	列出与 `ClusterInstance` 资源上执行的操作相关的条件。	conditions 数组
deploymentConditions optional	列出与 `ClusterDeployment` 资源关联的 hive 状态条件。	deploymentConditions 数组
manifestsRendered optional	列出已呈现的清单及其状态。	数组
observedGeneration 可选	跟踪观察到的 `ClusterInstance` 对象的生成。	整数

类型	描述
ClusterInstanceValidated	表示 SiteConfig operator 验证 `ClusterInstance` `spec` 字段，并验证是否存在所需的工件，如 secret 和额外的清单 `ConfigMap` 对象。
RenderedTemplates	表示 SiteConfig operator 成功验证引用的 Golang 集群模板。
RenderedTemplatesValidated	表示 SiteConfig 操作器呈现安装清单，并且空运行成功。
RenderedTemplatesApplied	表示 SiteConfig operator 创建安装清单，并且底层 Operator 使用它们。
已置备	表示底层 Operator 正在置备集群。

类型	描述
ClusterInstallRequirementsMet	表示安装可以启动。
ClusterInstallCompleted	表示集群安装成功。
ClusterInstallFailed	表示集群安装失败。
ClusterInstallStopped	表示集群安装已停止。

1.3. ClusterSets API (v1beta2)
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ClusterSet 资源相关的 API 信息。ClusterSet 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterSet 定义了一组 ManagedClusters。您可以通过在引用 ManagedClusterSet 的 ManagedCluster 上添加名为 cluster.open-cluster-management.io/clusterset 的标签，将 ManagedCluster 分配给特定的 ManagedClusterSet。当您有一个 RBAC 规则时，您只能在 ManagedCluster 上添加或删除此标签，允许对 managedclustersets/join 的虚拟子资源创建权限。您必须在源和目标 ManagedClusterSets 上具有此权限才能更新此标签。

1.3.1.1. 版本信息
复制链接

版本 : 2.12.0

1.3.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.3.1.3. Tags
复制链接

cluster.open-cluster-management.io：创建和管理 Clustersets

1.3.2. 路径
复制链接

1.3.2.1. 查询所有集群集（clusterset）
复制链接

GET /cluster.open-cluster-management.io/v1beta2/managedclustersets

1.3.2.1.1. 描述
复制链接

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

1.3.2.1.2. 参数
复制链接

Expand

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

1.3.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.3.2.1.4. 使用
复制链接

clusterset/yaml

1.3.2.1.5. Tags
复制链接

cluster.open-cluster-management.io

1.3.2.2. 创建一个 clusterset
复制链接

POST /cluster.open-cluster-management.io/v1beta2/managedclustersets

1.3.2.2.1. 描述
复制链接

创建 Clusterset。

1.3.2.2.2. 参数
复制链接

Expand

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

1.3.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.3.2.2.4. 使用
复制链接

clusterset/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/v1beta2",
  "kind": "ManagedClusterSet",
  "metadata": {
    "name": "clusterset1"
  },
  "spec": {
    "clusterSelector": {
      "selectorType": "ExclusiveClusterSetLabel"
    }
  },
  "status": {}
}

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

GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}

1.3.2.3.1. 描述
复制链接

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

1.3.2.3.2. 参数
复制链接

Expand

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

1.3.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.3.2.3.4. Tags
复制链接

cluster.open-cluster-management.io

1.3.2.4. 删除集群集
复制链接

DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}

1.3.2.4.1. 描述
复制链接

删除单个集群集。

1.3.2.4.2. 参数
复制链接

Expand

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

1.3.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.3.2.4.4. Tags
复制链接

cluster.open-cluster-management.io

1.3.3. 定义
复制链接

1.3.3.1. Clusterset
复制链接

Expand

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

1.4. Clustersetbindings API (v1beta2)
复制链接

1.4.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ClusterSetBinding 资源相关的 API 信息。ClusterSetBinding 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterSetBinding 将 ManagedClusterSet 项目到一个特定命名空间中。在一个命名空间中创建一个 ManagedClusterSetBinding，如果您有一个 RBAC 规则，允许您在 managedclustersets/bind 的虚拟子资源上创建它。

1.4.1.1. 版本信息
复制链接

版本 : 2.12.0

1.4.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.4.1.3. Tags
复制链接

cluster.open-cluster-management.io：创建和管理 clustersetbindings

1.4.2. 路径
复制链接

1.4.2.1. 查询所有 clustersetbindings
复制链接

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings

1.4.2.1.1. 描述
复制链接

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

1.4.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.4.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.4.2.1.4. 使用
复制链接

clustersetbinding/yaml

1.4.2.1.5. Tags
复制链接

cluster.open-cluster-management.io

1.4.2.2. 创建 clustersetbinding
复制链接

POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings

1.4.2.2.1. 描述
复制链接

创建 clustersetbinding。

1.4.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 `default`。	字符串
Body	body 必需	描述要创建的 clustersetbinding 的参数。	Clustersetbinding

1.4.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.4.2.2.4. 使用
复制链接

clustersetbinding/yaml

1.4.2.2.5. Tags
复制链接

cluster.open-cluster-management.io

1.4.2.2.6. HTTP 请求示例
复制链接

1.4.2.2.6.1. 请求正文
复制链接

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta2",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.4.2.3. 查询单个 clustersetbinding
复制链接

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}

1.4.2.3.1. 描述
复制链接

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

1.4.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 `default`。	字符串
路径	clustersetbinding_name 必需	要查询的 clustersetbinding 的名称。	字符串

1.4.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.4.2.3.4. Tags
复制链接

cluster.open-cluster-management.io

1.4.2.4. 删除 clustersetbinding
复制链接

DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}

1.4.2.4.1. 描述
复制链接

删除单个 clustersetbinding。

1.4.2.4.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 `default`。	字符串
路径	clustersetbinding_name 必需	要删除的 clustersetbinding 的名称。	字符串

1.4.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.4.2.4.4. Tags
复制链接

cluster.open-cluster-management.io

1.4.3. 定义
复制链接

1.4.3.1. Clustersetbinding
复制链接

Expand

Name	描述	模式
apiVersion 必需	`ManagedClusterSetBinding` 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	`ManagedClusterSetBinding` 的元数据。	对象
spec 必需	`ManagedClusterSetBinding` 的规格。	spec

spec

Expand

Name	描述	模式
clusterSet 必需	要绑定的 `ManagedClusterSet` 的名称。它必须与 `ManagedClusterSetBinding` 的实例名称匹配，并在创建后无法更改。	字符串

1.5. Clusterview API (v1alpha1)
复制链接

1.5.1. 概述
复制链接

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

1.5.1.1. 版本信息
复制链接

版本 : 2.12.0

1.5.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.5.1.3. Tags
复制链接

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

1.5.2. 路径
复制链接

1.5.2.1. 获取受管集群
复制链接

GET /managedclusters.clusterview.open-cluster-management.io

1.5.2.1.1. 描述
复制链接

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

1.5.2.1.2. 参数
复制链接

Expand

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

1.5.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.5.2.1.4. 使用
复制链接

managedcluster/yaml

1.5.2.1.5. Tags
复制链接

clusterview.open-cluster-management.io

1.5.2.2. 列出受管集群
复制链接

LIST /managedclusters.clusterview.open-cluster-management.io

1.5.2.2.1. 描述
复制链接

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

1.5.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
Body	body 可选	要列出受管集群的用户 ID 的名称。	字符串

1.5.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.5.2.2.4. 使用
复制链接

managedcluster/yaml

1.5.2.2.5. Tags
复制链接

clusterview.open-cluster-management.io

1.5.2.2.6. HTTP 请求示例
复制链接

1.5.2.2.6.1. 请求正文
复制链接

{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

1.5.2.3. 观察受管集群集
复制链接

WATCH /managedclusters.clusterview.open-cluster-management.io

1.5.2.3.1. 描述
复制链接

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

1.5.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	clusterview_name 可选	要监视的用户 ID 的名称。	字符串

1.5.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.5.2.4. 列出受管集群集。
复制链接

GET /managedclustersets.clusterview.open-cluster-management.io

1.5.2.4.1. 描述
复制链接

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

1.5.2.4.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	string
路径	clusterview_name 可选	要监视的用户 ID 的名称。	string

1.5.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.5.2.5. 列出受管集群集。
复制链接

LIST /managedclustersets.clusterview.open-cluster-management.io

1.5.2.5.1. 描述
复制链接

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

1.5.2.5.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	clusterview_name 可选	要监视的用户 ID 的名称。	字符串

1.5.2.5.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.5.2.6. 观察受管集群集。
复制链接

WATCH /managedclustersets.clusterview.open-cluster-management.io

1.5.2.6.1. 描述
复制链接

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

1.5.2.6.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	clusterview_name 可选	要监视的用户 ID 的名称。	字符串

1.5.2.6.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6. Channels API
复制链接

1.6.1. 概述
复制链接

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

1.6.1.1. 版本信息
复制链接

版本 : 2.12.0

1.6.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.6.1.3. Tags
复制链接

channels.apps.open-cluster-management.io : 创建和管理可部署性资源（deployables）

1.6.2. 路径
复制链接

1.6.2.1. 创建频道
复制链接

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

1.6.2.1.1. 描述
复制链接

创建频道

1.6.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 deployable 的参数。	Channel

1.6.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.1.4. 使用
复制链接

application/yaml

1.6.2.1.5. Tags
复制链接

channels.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": "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.6.2.2. 为目标命名空间查询所有频道
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels

1.6.2.2.1. 描述
复制链接

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

1.6.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.6.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.2.4. 使用
复制链接

application/yaml

1.6.2.2.5. Tags
复制链接

channels.apps.open-cluster-management.io

1.6.2.3. 查询命名空间的单个频道
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

1.6.2.3.1. 描述
复制链接

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

1.6.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	channel_name 必需	您要查询的 deployable 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.6.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.3.4. Tags
复制链接

channels.apps.open-cluster-management.io

1.6.2.4. 删除频道
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}

1.6.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	channel_name 必需	要删除的频道名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.6.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.6.2.4.3. Tags
复制链接

channels.apps.open-cluster-management.io

1.6.3. 定义
复制链接

1.6.3.1. Channel
复制链接

Expand

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

spec

Expand

Name	描述	模式
configMapRef 可选	ObjectReference 包含足够信息供您检查或修改引用的对象。	configMapRef
gates 可选	ChannelGate 定义推广到频道的条件	gates
pathname 必需		字符串
secretRef 可选	ObjectReference 包含足够信息供您检查或修改引用的对象。	secretRef
sourceNamespaces 可选		enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) array

configMapRef

Expand

Name	描述	模式
apiVersion 可选	引用的 API 版本。	字符串
fieldPath 可选	如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的，且该字段在将来会有所改变。	字符串
kind 可选	引用的类型。更多信息：https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/	name 可选
引用的名称。更多信息：名称	字符串	namespace 可选
引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/	字符串	resourceVersion 可选
指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency	字符串	uid 可选

gates

Expand

Name	描述	模式
annotations 可选	k8s 的典型注解	annotations
labelSelector 可选	标签选择器，即一组资源的标签查询。matchLabels 和 matchExpressions 的逻辑关系是 AND。空标签选择器匹配所有对象。null 标签选择器不匹配任何对象。	labelSelector
name 可选		字符串

annotations

Expand

Name	模式
key 可选	字符串
value 可选	字符串

labelSelector

Expand

Name	描述	模式
matchExpressions 可选	matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。	matchExpressions 数组
matchLabels 可选	matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。	字符串、字符串映射

matchExpressions

Expand

Name	描述	模式
key 必需	key 是选择器应用到的标签键。	字符串
operator 必需	运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。	字符串
values 可选	值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。	字符串数组

secretRef

Expand

Name	描述	模式
apiVersion 可选	引用的 API 版本。	字符串
fieldPath 可选	如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的，且该字段在将来会有所改变。	字符串
kind 可选	引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/api-conventions.md#concurrency-control-and-consistency	字符串
uid 可选	引用的 UID。更多信息： UIID	字符串

1.7. Subscriptions API
复制链接

1.7.1. 概述
复制链接

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

1.7.1.1. 版本信息
复制链接

版本 : 2.12.0

1.7.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.7.1.3. Tags
复制链接

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

1.7.2. 路径
复制链接

1.7.2.1. 创建订阅
复制链接

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

1.7.2.1.1. 描述
复制链接

创建订阅

1.7.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的订阅的参数。	Subscription

1.7.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.7.2.1.4. 使用
复制链接

subscription/yaml

1.7.2.1.5. Tags
复制链接

subscriptions.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" : "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.7.2.2. 查询所有订阅
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

1.7.2.2.1. 描述
复制链接

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

1.7.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.7.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.7.2.2.4. 使用
复制链接

subscription/yaml

1.7.2.2.5. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.7.2.3. 查询单个订阅
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

1.7.2.3.1. 描述
复制链接

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

1.7.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
路径	subscription_name 必需	要查询的订阅名称。	字符串

1.7.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.7.2.3.4. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.7.2.4. 创建一个订阅：
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

1.7.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
路径	subscription_name 必需	要删除的订阅的名称。	字符串

1.7.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.7.2.4.3. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.7.3. 定义
复制链接

1.7.3.1. Subscription
复制链接

Expand

Name	模式
apiVersion 必需	字符串
kind 必需	字符串
metadata 必需	metadata
spec 必需	spec
status 可选	status

metadata

Expand

Name	模式
annotations 可选	object
labels 可选	object
name 可选	字符串
namespace 可选	字符串

spec

Expand

Name	模式
channel 必需	字符串
name 可选	字符串
overrides 可选	overrides 数组
packageFilter 可选	packageFilter
packageOverrides 可选	packageOverrides 数组
placement 可选	placement
timewindow 可选	timewindow

overrides

Expand

Name	模式
clusterName 必需	字符串
clusterOverrides 必需	对象数组

packageFilter

Expand

Name	描述	模式
annotations 可选		字符串、字符串映射
filterRef 可选		filterRef
labelSelector 可选		labelSelector
version 可选	Pattern : `"()((\\.[0-9])(\\.)\|(\\.[0-9])?(\\.[xX]))$"`	字符串

filterRef

Expand

Name	模式
name 可选	字符串

labelSelector

Expand

Name	模式
matchExpressions 可选	matchExpressions 数组
matchLabels 可选	字符串、字符串映射

matchExpressions

Expand

Name	模式
key 必需	字符串
operator 必需	字符串
values 可选	字符串数组

packageOverrides

Expand

Name	模式
packageAlias 可选	字符串
packageName 必需	字符串
packageOverrides 可选	对象数组

placement

Expand

Name	模式
clusterSelector 可选	clusterSelector
clusters 可选	clusters 数组
local 可选	布尔值
placementRef 可选	placementRef

clusterSelector

Expand

Name	模式
matchExpressions 可选	matchExpressions 数组
matchLabels 可选	字符串、字符串映射

matchExpressions

Expand

Name	模式
key 必需	字符串
operator 必需	字符串
values 可选	字符串数组

clusters

Expand

Name	模式
name 必需	字符串

placementRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

timewindow

Expand

Name	模式
daysofweek 可选	字符串数组
hours 可选	hours 数组
location 可选	字符串
windowtype 可选	enum（active、blocked、Active、Blocked）

hours

Expand

Name	模式
end 可选	字符串
start 可选	字符串

status

Expand

Name	模式
lastUpdateTime 可选	字符串（date-time）
message 可选	字符串
phase 可选	字符串
reason 可选	字符串
statuses 可选	object

1.8. PlacementRules API (已弃用)
复制链接

1.8.1. 概述
复制链接

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

1.8.1.1. 版本信息
复制链接

版本 : 2.12.0

1.8.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.8.1.3. Tags
复制链接

placementrules.apps.open-cluster-management.io：创建和管理放置规则

1.8.2. 路径
复制链接

1.8.2.1. 创建放置规则
复制链接

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

1.8.2.1.1. 描述
复制链接

创建放置规则。

1.8.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的放置规则的参数。	PlacementRule

1.8.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.8.2.1.4. 使用
复制链接

application/yaml

1.8.2.1.5. Tags
复制链接

placementrules.apps.open-cluster-management.io

1.8.2.1.6. HTTP 请求示例
复制链接

1.8.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.8.2.2. 查询所有放置规则
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules

1.8.2.2.1. 描述
复制链接

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

1.8.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.8.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.8.2.2.4. 使用
复制链接

application/yaml

1.8.2.2.5. Tags
复制链接

placementrules.apps.open-cluster-management.io

1.8.2.3. 查询单个放置规则
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

1.8.2.3.1. 描述
复制链接

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

1.8.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
路径	placementrule_name 必需	要查询的放置规则的名称。	字符串

1.8.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.8.2.3.4. Tags
复制链接

placementrules.apps.open-cluster-management.io

1.8.2.4. 删除放置规则
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}

1.8.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
路径	placementrule_name 必需	要删除的放置规则的名称。	字符串

1.8.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.8.2.4.3. Tags
复制链接

placementrules.apps.open-cluster-management.io

1.8.3. 定义
复制链接

1.8.3.1. PlacementRule
复制链接

Expand

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

spec

Expand

Name	模式
clusterConditions 可选	clusterConditions 数组
clusterReplicas 可选	整数
clusterSelector 可选	clusterSelector
clusters 可选	clusters 数组
policies 可选	policies 数组
resourceHint 可选	resourceHint
schedulerName 可选	字符串

clusterConditions

Expand

Name	模式
status 可选	字符串
type 可选	字符串

clusterSelector

Expand

Name	模式
matchExpressions 可选	matchExpressions 数组
matchLabels 可选	字符串、字符串映射

matchExpressions

Expand

Name	模式
key 可选	字符串
operator 可选	字符串
values 可选	字符串数组

clusters

Expand

Name	模式
name 可选	字符串

policies

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

resourceHint

Expand

Name	模式
order 可选	字符串
type 可选	字符串

1.9. Applications API
复制链接

1.9.1. 概述
复制链接

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

1.9.1.1. 版本信息
复制链接

版本 : 2.12.0

1.9.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.9.1.3. Tags
复制链接

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

1.9.2. 路径
复制链接

1.9.2.1. 创建应用程序
复制链接

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications

1.9.2.1.1. 描述
复制链接

创建应用程序。

1.9.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的应用程序的参数。	Application

1.9.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.1.4. 使用
复制链接

application/yaml

1.9.2.1.5. Tags
复制链接

applications.app.k8s.io

1.9.2.1.6. HTTP 请求示例
复制链接

1.9.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.9.2.2. 查询所有应用程序
复制链接

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications

1.9.2.2.1. 描述
复制链接

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

1.9.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.9.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.2.4. 使用
复制链接

application/yaml

1.9.2.2.5. Tags
复制链接

applications.app.k8s.io

1.9.2.3. 查询单个应用程序
复制链接

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

1.9.2.3.1. 描述
复制链接

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

1.9.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	application_name 必需	您要查询的应用程序的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.9.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.3.4. Tags
复制链接

applications.app.k8s.io

1.9.2.4. 删除应用程序
复制链接

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

1.9.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	application_name 必需	要删除的应用程序的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.9.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.4.3. Tags
复制链接

applications.app.k8s.io

1.9.3. 定义
复制链接

1.9.3.1. Application
复制链接

Expand

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

spec

Expand

Name	模式
assemblyPhase 可选	字符串
componentKinds 可选	对象数组
descriptor 可选	descriptor
info 可选	info 数组
selector 可选	对象

descriptor

Expand

Name	模式
description 可选	字符串
icons 可选	icons 数组
keywords 可选	字符串数组
links 可选	links 数组
maintainers 可选	maintainers 数组
notes 可选	字符串
owners 可选	owners 数组
type 可选	字符串
version 可选	字符串

icons

Expand

Name	模式
size 可选	字符串
src 必需	字符串
type 可选	字符串

links

Expand

Name	模式
description 可选	字符串
url 可选	字符串

maintainers

Expand

Name	模式
email 可选	字符串
name 可选	字符串
url 可选	字符串

owners

Expand

Name	模式
email 可选	字符串
name 可选	字符串
url 可选	字符串

info

Expand

Name	模式
name 可选	字符串
type 可选	字符串
value 可选	字符串
valueFrom 可选	valueFrom

valueFrom

Expand

Name	模式
configMapKeyRef optional	configMapKeyRef
ingressRef 可选	ingressRef
secretKeyRef 可选	secretKeyRef
serviceRef 可选	serviceRef
type 可选	字符串

configMapKeyRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
key 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

ingressRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
host 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
path 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

secretKeyRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
key 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

serviceRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
path 可选	字符串
port 可选	integer (int32)
resourceVersion 可选	字符串
uid 可选	字符串

1.10. Helm API
复制链接

1.10.1. 概述
复制链接

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

1.10.1.1. 版本信息
复制链接

版本 : 2.12.0

1.10.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.10.1.3. Tags
复制链接

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

1.10.2. 路径
复制链接

1.10.2.1. 创建 helmrelease
复制链接

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

1.10.2.1.1. 描述
复制链接

创建 helmrelease。

1.10.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 helmrelease 的参数。	HelmRelease

1.10.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.1.4. 使用
复制链接

application/yaml

1.10.2.1.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.2.1.6. HTTP 请求示例
复制链接

1.10.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.10.2.2. 查询所有 helmreleases
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

1.10.2.2.1. 描述
复制链接

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

1.10.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.10.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.2.4. 使用
复制链接

application/yaml

1.10.2.2.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.2.3. 查询单个 helmrelease
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

1.10.2.3.1. 描述
复制链接

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

1.10.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	helmrelease_name 必需	要查询的 helmrelease 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.10.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.3.4. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.2.4. 删除 helmrelease
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

1.10.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	helmrelease_name 必需	要删除的 helmrelease 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.10.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.4.3. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.3. 定义
复制链接

1.10.3.1. HelmRelease
复制链接

Expand

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

repo

Expand

Name	模式
chartName 可选	字符串
configMapRef 可选	configMapRef
secretRef 可选	secretRef
source 可选	source
version 可选	字符串

configMapRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

secretRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

source

Expand

Name	模式
github 可选	github
helmRepo 可选	helmRepo
type 可选	字符串

github

Expand

Name	模式
branch 可选	字符串
chartPath 可选	字符串
urls 可选	字符串数组

helmRepo

Expand

Name	模式
urls 可选	字符串数组

status

Expand

Name	模式
conditions 必需	conditions 数组
deployedRelease 可选	deployedRelease

conditions

Expand

Name	模式
lastTransitionTime 可选	字符串（date-time）
message 可选	字符串
reason 可选	字符串
status 必需	字符串
type 必需	字符串

deployedRelease

Expand

Name	模式
manifest 可选	字符串
name 可选	字符串

1.11. Policy API
复制链接

1.11.1. 概述
复制链接

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

1.11.1.1. 版本信息
复制链接

版本 : 2.12.0

1.11.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.11.1.3. Tags
复制链接

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

1.11.2. 路径
复制链接

1.11.2.1. 创建策略
复制链接

POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}

1.11.2.1.1. 描述
复制链接

创建策略

1.11.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建策略的参数。	policy

1.11.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.11.2.1.4. 使用
复制链接

application/json

1.11.2.1.5. Tags
复制链接

policy.open-cluster-management.io

1.11.2.1.6. HTTP 请求示例
复制链接

1.11.2.1.6.1. 请求正文
复制链接

{
  "apiVersion": "policy.open-cluster-management.io/v1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1",
    "metadata": {
      "name": "test-role"
    },
    "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.11.2.2. 查询所有策略
复制链接

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

1.11.2.2.1. 描述
复制链接

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

1.11.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要应用策略的命名空间，如 default。	字符串

1.11.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.11.2.2.4. 使用
复制链接

application/json

1.11.2.2.5. Tags
复制链接

policy.open-cluster-management.io

1.11.2.3. 查询单个策略
复制链接

GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

1.11.2.3.1. 描述
复制链接

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

1.11.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	policy_name 必需	要查询的策略的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.11.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.11.2.3.4. Tags
复制链接

policy.open-cluster-management.io

1.11.2.4. 删除策略
复制链接

DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}

1.11.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	policy_name 必需	要删除的策略名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.11.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.11.2.4.3. Tags
复制链接

policy.open-cluster-management.io

1.11.3. 定义
复制链接

1.11.3.1. policy
复制链接

Expand

Name	描述	模式
apiVersion 必需	策略的版本化模式（schema）。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	描述定义策略的规则。	对象

spec

Expand

Name	描述	模式
remediationAction 可选	代表资源中定义的处理违反情况的值。	字符串

policy-templates

Expand

Name	描述	模式
apiVersion 必需	策略的版本化模式（schema）。	字符串
kind 可选	代表 REST 资源的字符串值。	字符串
metadata 必需	描述定义策略的规则。	对象
rules 可选		字符串

rules

Expand

Name	描述	模式
apiGroups 必需	适用于该规则的 API 列表。	字符串
resources 必需	资源类型列表。	对象
verbs 必需	动词列表。	字符串

1.12. Observability API
复制链接

1.12.1. 概述
复制链接

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

1.12.1.1. 版本信息
复制链接

版本 : 2.12.0

1.12.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.12.1.3. Tags
复制链接

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

1.12.2. 路径
复制链接

1.12.2.1. 创建 multiclusterobservability 资源
复制链接

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

1.12.2.1.1. 描述
复制链接

创建 MultiClusterObservability 资源。

1.12.2.1.2. 参数
复制链接

Expand

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

1.12.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.12.2.1.4. 使用
复制链接

application/yaml

1.12.2.1.5. Tags
复制链接

observability.apps.open-cluster-management.io

1.12.2.1.6. HTTP 请求示例
复制链接

1.12.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.12.2.2. 查询所有 multiclusterobservabilities
复制链接

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

1.12.2.2.1. 描述
复制链接

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

1.12.2.2.2. 参数
复制链接

Expand

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

1.12.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.12.2.2.4. 使用
复制链接

application/yaml

1.12.2.2.5. Tags
复制链接

observability.apps.open-cluster-management.io

1.12.2.3. 查询单个 multiclusterobservability
复制链接

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

1.12.2.3.1. 描述
复制链接

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

1.12.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	string
路径	multiclusterobservability_name 必需	要查询的 multiclusterobservability 的名称。	string

1.12.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.12.2.3.4. Tags
复制链接

observability.apps.open-cluster-management.io

1.12.2.4. 删除一个 multiclusterobservability 资源
复制链接

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

1.12.2.4.1. 参数
复制链接

Expand

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

1.12.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.12.2.4.3. Tags
复制链接

observability.apps.open-cluster-management.io

1.12.3. 定义
复制链接

1.12.3.1. MultiClusterObservability
复制链接

Expand

Name	描述	模式
apiVersion 必需	版本化的 MultiClusterObservability schema。	字符串
kind 必需	代表 REST 资源、MultiClusterObservability 的字符串值。	字符串
metadata 必需	描述定义策略的规则。	对象

spec

Expand

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 副本。	整数

storageConfig

Expand

Name	描述	模式
alertmanagerStorageSize 可选	应用到 alertmanager 有状态集的存储量。默认值为 `1Gi`。	字符串
compactStorageSize 可选	应用于 thanos 紧凑有状态集合的存储量。默认值为 `100Gi`。	字符串
metricObjectStorage 必需	用于为指标配置 secret 的对象存储。	metricObjectStorage
receiveStorageSize 可选	应用到 thanos 接收有状态集的存储量。默认值为 `100Gi`。	字符串
ruleStorageSize 可选	应用到 thanos 规则有状态集的存储量。默认值为 `1Gi`。	字符串
storageClass 可选	指定 `storageClass` 有状态的集合。如果为您的操作系统配置了 `metricObjectStorage` 来创建存储，则此存储用于对象存储。默认值为 `gp2`。	字符串
storeStorageSize 可选	应用到 thanos 存储有状态集合的存储量。默认值为 `10Gi`。	字符串
writeStorage 可选	端点访问信息列表。	[ ]WriteStorage

writeStorage

Expand

Name	描述	模式
name 必需	带有端点访问信息的 secret 名称。	字符串
key 必需	要从中选择的 secret 的密钥。	字符串

metricObjectStorage

Expand

Name	描述	模式
key 必需	要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。请参阅 Thanos 文档。	字符串
name 必需	`metricObjectStorage` 的名称。如需更多信息，请参阅 Kubernetes 名称。	字符串

observabilityAddonSpec

Expand

Name	描述	模式
enableMetrics 可选	指示 Observability 附加组件是否将指标发送到 hub 集群。默认值为 `true`。	布尔值
interval 可选	Observability 附加组件将指标发送到 hub 集群的间隔。默认值为 300 秒 (`300s`)。	整数
resources 可选	指标收集器资源要求的资源。默认 CPU 请求为 `100m`，内存请求为 `100Mi`。	corev1.ResourceRequirements

advanced

Expand

Name	描述	模式
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 可选	指定紧凑 statefulset 的资源。	compact
storeMemcached 可选	指定 store-memcached 的副本、资源等。	storeMemcached
queryFrontendMemcached 可选	指定 query-frontend-memcached 的副本、资源等。	CacheConfig

retentionConfig

Expand

Name	描述	模式
blockDuration 可选	阻塞时间序列数据库（TSDB）块持续时间的时间长度。默认值为 `2h`。	字符串
deleteDelay 可选	从存储桶中删除标记要删除的块前的时间。默认值为 `48h`。	字符串
retentionInLocal 可选	从本地存储保留原始样本的时间长度。默认值为 `24h`。	字符串
retentionResolutionRaw 可选	在存储桶中保留原始分辨率样本的时间。默认值为 365 天(`365d`)	字符串
retentionResolution5m 可选	在存储桶中保留分辨率 1 样本（5 分钟）的时间长度。默认值为 365 天(`365d`)。	字符串
retentionResolution1h 可选	在存储桶中保留分辨率 2 样本（1 小时）的时间长度。默认值为 365 天(`365d`)。	字符串

CompactSpec

Expand

Name	描述	模式
resources 可选	thanos 紧凑所需的计算资源。	corev1.ResourceRequirements
serviceAccountAnnotations 可选	annotations 是一个无结构的键值映射，它存储有紧凑的服务帐户。	map[string]string

storeMemcached

Expand

Name	描述	模式
resources 可选	MultiCLusterObservability 所需的计算资源.	corev1.ResourceRequirements
replicas 可选	MultiClusterObservability 副本。	整数
memoryLimitMb optional	以 MB 为单位的 Memcached 内存限值。	整数
maxItemSize 可选	Memcached 的最大项目大小。默认值为 `1m, min:1k, max:1024m`。	字符串
connectionLimit optional	Memcached 同时连接数上限。默认值为	整数

status

Expand

Name	描述	模式
status 可选	status 包含 MultiClusterObservability 的不同条件状态。	metav1.Condition

CommonSpec

Expand

Name	描述	模式
resources 可选	组件所需的计算资源。	corev1.ResourceRequirements
replicas 可选	组件的副本。	整数

QuerySpec

Expand

Name	描述	模式
CommonSpec 可选	指定查询部署的副本和资源。	CommonSpec
serviceAccountAnnotations 可选	annotations 是一个无结构的键值映射，它会与查询服务帐户存储。	map[string]string

ReceiveSpec

Expand

Name	描述	模式
CommonSpec 可选	指定查询部署的副本和资源。	CommonSpec
serviceAccountAnnotations 可选	annotations 是一个无结构的键值映射，它会与查询服务帐户存储。	map[string]string

StoreSpec

Expand

Name	描述	模式
CommonSpec 可选	指定查询部署的副本和资源。	CommonSpec
serviceAccountAnnotations 可选	annotations 是一个无结构的键值映射，它会与查询服务帐户存储。	map[string]string

RuleSpec

Expand

Name	描述	模式
CommonSpec 可选	指定查询部署的副本和资源。	CommonSpec
evalInterval 可选	指定规则的评估间隔。	字符串
serviceAccountAnnotations 可选	annotations 是一个无结构的键值映射，它会与查询服务帐户存储。	map[string]string

1.13. 搜索查询 API
复制链接

搜索查询 API 不是 Kubernetes API，因此不会通过 Red Hat OpenShift Container Platform API Explorer 显示。继续阅读以了解搜索查询 API 功能。

1.13.1. 概述
复制链接

您可以使用路由公开搜索查询 API，并使用 API 解析搜索查询。API 是一个 GraphQL 端点。您可以使用任何客户端，如 curl 或 Postman。

1.13.1.1. 版本信息
复制链接

版本 : 2.10.0

1.13.1.2. URI scheme
复制链接

BasePath : /searchapi/graphql
Schemes : HTTPS

1.13.1.3. 配置 API 访问
复制链接

使用以下命令，创建一个路由，从集群外部访问搜索 API：

oc create route passthrough search-api --service=search-search-api -n open-cluster-management

重要： 您必须配置路由来保护您的环境。如需了解更多详细信息，请参阅 OpenShift Container Platform 文档中的路由配置。https://docs.redhat.com/documentation/en-us/openshift_container_platform/4.15/html-single/networking/index#route-configuration

1.13.2. 架构设计
复制链接

input SearchFilter {
  property: String!
  values: [String]!
}
input SearchInput {
  keywords: [String]
  filters: [SearchFilter]
  limit: Int
  relatedKinds: [String]
}
type SearchResult {
count: Int
items: [Map]
related: [SearchRelatedResult]
}
type SearchRelatedResult {
kind: String!
count: Int
items: [Map]
}

参数带有 ! 表示需要该字段。

1.13.2.1. 查询输入的描述表
复制链接

Expand

类型	描述	属性
SearchFilter	定义用于过滤结果的键和值。当您为属性提供多个值时，API 会将值解析为 "OR" 操作。当您提供多个过滤器时，结果会匹配所有过滤器，API 则解析为"AND"操作。	string
SearchInput	输入关键字以接收资源列表。当您提供多个关键字时，API 会将其解释为"AND"操作。	字符串
limit	确定输入查询后返回的最大结果数。默认值为 `10,000`。值 `-1` 表示这个限制已被删除。	整数

1.13.2.2. 模式示例
复制链接

{
  "query": "type SearchResult {count: Intitems: [Map]related: [SearchRelatedResult]} type SearchRelatedResult {kind: String!count: Intitems: [Map]}",
  "variables": {
    "input": [
      {
        "keywords": [],
        "filters": [
          {
            "property": "kind",
            "values": [
              "Deployment"
            ]
          }
        ],
        "limit": 10
      }
    ]
  }
}

1.13.3. 通用模式
复制链接

type Query {
  search(input: [SearchInput]): [SearchResult]
  searchComplete(property: String!, query: SearchInput, limit: Int): [String]
  searchSchema: Map
  messages: [Message]
}

1.13.4. 支持的查询
复制链接

继续读取以查看 JSON 格式支持的查询类型。

1.13.4.1. 搜索部署
复制链接

query：

query mySearch($input: [SearchInput]) {
    search(input: $input) {
    		items
        }
}

变量：

{"input":[
    {
        "keywords":[],
        "filters":[
            {"property":"kind","values":["Deployment"]}],
        "limit":10
    }
]}

1.13.4.2. 搜索 pod
复制链接

query：

query mySearch($input: [SearchInput]) {
    search(input: $input) {
    		items
        }
}

变量：

{"input":[
    {
        "keywords":[],
        "filters":[
            {"property":"kind","values":["Pod"]}],
        "limit":10
    }
]}

1.14. MultiClusterHub API
复制链接

1.14.1. 概述
复制链接

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

1.14.1.1. 版本信息
复制链接

版本 : 2.12.0

1.14.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.14.1.3. Tags
复制链接

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

1.14.2. 路径
复制链接

1.14.2.1. 创建 MultiClusterHub 资源
复制链接

POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch

1.14.2.1.1. 描述
复制链接

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

1.14.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 multicluster hub 的参数。	定义

1.14.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.14.2.1.4. 使用
复制链接

multiclusterhubs/yaml

1.14.2.1.5. Tags
复制链接

multiclusterhubs.operator.open-cluster-management.io

1.14.2.1.6. HTTP 请求示例
复制链接

1.14.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, a central point for managing multiple Kubernetes-based
          clusters. The deployment of multicluster hub components is determined based
          on the configuration that is defined in this resource.",
        "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 Red Hat Advanced Cluster Management.",
                  }
                    "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.14.2.2. 查询所有 MultiClusterHubs
复制链接

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator

1.14.2.2.1. 描述
复制链接

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

1.14.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.14.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.14.2.2.4. 使用
复制链接

operator/yaml

1.14.2.2.5. Tags
复制链接

multiclusterhubs.operator.open-cluster-management.io

1.14.2.3. 查询 MultiClusterHub operator
复制链接

GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

1.14.2.3.1. 描述
复制链接

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

1.14.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	application_name 必需	要查询的应用程序的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.14.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.14.2.3.4. Tags
复制链接

multiclusterhubs.operator.open-cluster-management.io

1.14.2.4. 删除 MultiClusterHub operator
复制链接

DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}

1.14.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	application_name 必需	要删除的 multicluster hub Operator 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.14.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.14.2.4.3. Tags
复制链接

multiclusterhubs.operator.open-cluster-management.io

1.14.3. 定义
复制链接

1.14.3.1. multicluster hub operator
复制链接

Expand

Name	描述	模式
apiVersion 必需	MultiClusterHub 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	描述定义资源的规则。	对象
spec 必需	资源规格。	spec

spec

Expand

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

Expand

additionalCertificateAuthorities 可选	（已弃用）到 `hive` 命名空间中的 secret 的引用列表，它包含了在与目标集群通信时要使用的额外证书颁发机构（CA）。除了安装时每个集群生成的任何自签名 CA 外，这些证书颁发机构也被使用。	对象
backup 可选	（已弃用）指定备份集成的配置。如果没有，则禁用备份集成。	backup
externalDNS 可选	（已弃用）如果要由 Hive 部署，指定 `external-dns` 的配置。如果不存在，则不会部署 `external-dns`。	对象
failedProvisionConfig required	（已弃用）用于配置与处理调配失败相关的设置。	failedProvisionConfig
globalPullSecret optional	（已弃用）用于指定供所有集群部署全局使用的 pull secret。对于每个集群部署，`globalPullSecret` 的内容都会与集群部署的特定 pull secret 合并（如果指定），优先于集群部署的 pull secret 的内容。	对象
maintenanceMode 可选	（已弃用）在您需要确保没有运行任何会在 Hive 类型的 finalizer 上进行添加或操作时，可以使用它来禁用 hive 控制器。这应该很少需要。将 `hive-controllers` 部署的 replicas 设置为 `0` 来完成此操作。	布尔值

ingress

Expand

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

backup

Expand

minBackupPeriodSeconds 可选	（已弃用）指定在每个备份之间的最小 `MinBackupPeriodSeconds` 。这用于对备份进行比率限制。这可能会将多个更改组合到一个备份中。因为在这一时间段内发生的更改会被放入排队，在备份间隔时间后这些队列中的更改会被备份，因此不会丢失备份数据。	整数
velero 可选	（已弃用）Velero 指定 Velero 备份集成的配置。	对象

failedProvisionConfig

Expand

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

status

Expand

components 可选	状态配置的组件。	对象
conditions 可选	包含 multicluster hub 的不同条件。	conditions
desiredVersion 可选	表示所需的版本。	字符串
phase 可选	代表 MultiClusterHub 资源的活跃阶段。用于此参数的值包括： `Pending`、`Running`、`Installing`、`Updating` `、Uninstalling`	字符串

conditions

Expand

lastTransitionTime 可选	条件从一个状态变为另一个状态的最后一次的时间。	字符串
lastUpdateTime 可选	最后一次更新此条件的时间。	字符串
message 必需	Message 是人类可读的消息，表示关于上次状态更改的详细信息。	字符串
reason 必需	条件发生状态更改的原因。	字符串
status 必需	条件的状态。	字符串
type 必需	集群条件的类型。	字符串

StatusConditions

Expand

kind 必需	代表此状态的资源 `kind`。	字符串
available 必需	指明此组件是否在正确运行。	布尔值
lastTransitionTime 可选	条件从一个状态变为另一个状态的最后一次的时间。	metav1.time
lastUpdateTime 可选	最后一次更新此条件的时间。	metav1.time
message 必需	Message 是人类可读的消息，表示关于上次状态更改的详细信息。	字符串
reason 可选	条件发生状态更改的原因。	字符串
status 可选	条件的状态。	字符串
type 可选	集群条件的类型。	字符串

1.15. 放置 API (v1beta1)
复制链接

1.15.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的放置（Placement）资源相关的 API 信息。放置资源有 4 个可用的请求：create、query、delete 和 update。Placement 定义了一个规则，从绑定到放置命名空间的 ManagedClusterSets 中选择一组 ManagedClusters。会创建一个带有标签 cluster.open-cluster-management.io/placement={placement name} 的 PlacementDecisions 片段，以表示由这个放置选择的 ManagedClusters。

1.15.1.1. 版本信息
复制链接

版本 : 2.12.0

1.15.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.15.1.3. Tags
复制链接

cluster.open-cluster-management.io：创建和管理放置

1.15.2. 路径
复制链接

1.15.2.1. 查询所有放置
复制链接

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement

1.15.2.1.1. 描述
复制链接

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

1.15.2.1.2. 参数
复制链接

Expand

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

1.15.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.15.2.1.4. 使用
复制链接

placement/yaml

1.15.2.1.5. Tags
复制链接

cluster.open-cluster-management.io

1.15.2.2. 创建一个放置
复制链接

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements

1.15.2.2.1. 描述
复制链接

创建一个放置。

1.15.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
Body	body 必需	描述要创建的放置绑定的参数。	Placement

1.15.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.15.2.2.4. 使用
复制链接

placement/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" : "Placement",
  "metadata" : {
    "name" : "placement1",
    "namespace": "ns1"
  },
  "spec": {
    "predicates": [
      {
        "requiredClusterSelector": {
          "labelSelector": {
            "matchLabels": {
              "vendor": "OpenShift"
            }
          }
        }
      }
    ]
  },
  "status" : { }
}

1.15.2.3. 查询单个放置
复制链接

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}

1.15.2.3.1. 描述
复制链接

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

1.15.2.3.2. 参数
复制链接

Expand

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

1.15.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.15.2.3.4. Tags
复制链接

cluster.open-cluster-management.io

1.15.2.4. 删除一个放置
复制链接

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}

1.15.2.4.1. 描述
复制链接

删除一个放置。

1.15.2.4.2. 参数
复制链接

Expand

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

1.15.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.15.2.4.4. Tags
复制链接

cluster.open-cluster-management.io

1.15.3. 定义
复制链接

1.15.3.1. Placement
复制链接

Expand

Name	描述	模式
apiVersion 必需	放置的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	放置的元数据。	对象
spec 必需	放置的规格。	spec

spec

Expand

Name	描述	模式
clusterSets 可选	从中选择 `ManagedClusters` 的 `ManagedClusterSets` 子集。如果 `ManagedClusterSet` 为空，则从绑定到 Placement 命名空间的 `ManagedClusterSets` 中选择 `ManagedClusters`。如果 `ManagedClusterSet` 包含 `ManagedClusters`，`ManagedClusters` 会从这个子集的交集中选择。所选 `ManagedClusterSets` 绑定到放置命名空间。	字符串数组
numberOfClusters 可选	要选择的 `ManagedClusters` 数量。	integer (int32)
predicates 可选	选择 `ManagedClusters` 的集群 predicates 的子集。条件逻辑为 OR。	clusterPredicate 数组
prioritizerPolicy 可选	优先级器的策略。	prioritizerPolicy
tolerations 可选	允许但不是必需的值，通过放置具有匹配容限的放置来选择具有特定污点的受管集群。	容限数组

clusterPredicate

Expand

Name	描述	模式
requiredClusterSelector 可选	选择带有标签和集群声明的 `ManagedClusters` 的集群选择器。	clusterSelector

clusterSelector

Expand

Name	描述	模式
labelSelector 可选	按标签的 `ManagedClusters` 选择器。	对象
claimSelector 可选	按声明的 `ManagedClusters` 选择器。	clusterClaimSelector

clusterClaimSelector

Expand

Name	描述	模式
matchExpressions 可选	集群声明选择器要求的子集。条件逻辑是 AND。	< object > 数组

prioritizerPolicy

Expand

Name	描述	模式
mode 可选	`Exact`、`Additive`、或 ""。"" 的默认值为 `Additive`。	字符串
configurations 可选	配置优先级。	prioritizerConfig 数组

prioritizerConfig

Expand

Name	描述	模式
scoreCoordinate 必需	配置优先级和分数源。	scoreCoordinate
weight 可选	优先级分数的权重。该值的范围： [-10,10]。	int32

scoreCoordinate

Expand

Name	描述	模式
type 必需	优先级分数的类型。有效值为 "BuiltIn" 或 "AddOn"。	字符串
builtIn 可选	来自以下选项的 `BuiltIn` prioritizer 的名称：1）Balance（平衡）：平衡集群之间的决策。2）Steady（稳定）：确保现有决策稳定。3) ResourceAllocatableCPU 和 ResourceAllocatableMemory: 根据可分配资源排序集群。4）Spread（分发）：将工作负载平均到拓扑。	字符串
addOn 可选	当类型为 `AddOn` 时，`AddOn` 定义资源名称和分数名称。	对象

容限 (tolerations)

Expand

Name	描述	模式
key 可选	容限应用到的污点键。空表示与所有污点键匹配。	字符串
operator 可选	键与值的关系。有效的运算符为 `Exists` 和 `Equal`。默认值为 `Equal`。	字符串
value 可选	匹配容限的污点值。	字符串
effect 可选	要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值是 `NoSelect`、`PreferNoSelect` 和 `NoSelectIfNew`。	字符串
tolerationSeconds 可选	容许污点的时间长度，之后污点不会被容许。默认值为 nil，这表示污点的容许时间没有时间限制。	int64

1.16. PlacementDecisions API (v1beta1)
复制链接

1.16.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 PlacementDecision 资源相关的 API 信息。PlacementDecision 资源有 4 个可用的请求：create、query、delete 和 update。PlacementDecision 表示来自放置的决定。PlacementDecision 使用标签 cluster.open-cluster-management.io/placement={placement name} 来引用特定的放置。

1.16.1.1. 版本信息
复制链接

版本 : 2.12.0

1.16.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.16.1.3. Tags
复制链接

cluster.open-cluster-management.io：创建和管理放置Decisions。

1.16.2. 路径
复制链接

1.16.2.1. 查询所有 PlacementDecisions
复制链接

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions

1.16.2.1.1. 描述
复制链接

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

1.16.2.1.2. 参数
复制链接

Expand

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

1.16.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.16.2.1.4. 使用
复制链接

placementdecision/yaml

1.16.2.1.5. Tags
复制链接

cluster.open-cluster-management.io

1.16.2.2. 创建 PlacementDecision
复制链接

POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions

1.16.2.2.1. 描述
复制链接

创建 PlacementDecision。

1.16.2.2.2. 参数
复制链接

Expand

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

1.16.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.16.2.2.4. 使用
复制链接

placementdecision/yaml

1.16.2.2.5. Tags
复制链接

cluster.open-cluster-management.io

1.16.2.2.6. HTTP 请求示例
复制链接

1.16.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.16.2.3. 查询单个 PlacementDecision
复制链接

GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

1.16.2.3.1. 描述
复制链接

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

1.16.2.3.2. 参数
复制链接

Expand

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

1.16.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.16.2.3.4. Tags
复制链接

cluster.open-cluster-management.io

1.16.2.4. 删除 PlacementDecision
复制链接

DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}

1.16.2.4.1. 描述
复制链接

删除单个 PlacementDecision。

1.16.2.4.2. 参数
复制链接

Expand

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

1.16.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.16.2.4.4. Tags
复制链接

cluster.open-cluster-management.io

1.16.3. 定义
复制链接

1.16.3.1. PlacementDecision
复制链接

Expand

Name	描述	模式
apiVersion 必需	`PlacementDecision` 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	`PlacementDecision` 的元数据。	对象
status 可选	`PlacementDecision` 的当前状态。	PlacementStatus

PlacementStatus

Expand

Name	描述	模式
Decisions 必需	根据放置的决策分片。	ClusterDecision 数组

ClusterDecision

Expand

Name	描述	模式
clusterName 必需	`ManagedCluster` 的名称。	字符串
reason 必需	选择 `ManagedCluster` 的原因。	字符串

1.17. DiscoveryConfig API
复制链接

1.17.1. 概述
复制链接

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

1.17.1.1. 版本信息
复制链接

版本 : 2.12.0

1.17.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.17.1.3. Tags
复制链接

discoveryconfigs.discovery.open-cluster-management.io : 创建和管理 DiscoveryConfigs

1.17.2. 路径
复制链接

1.17.2.1. 创建 DiscoveryConfig
复制链接

POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs

1.17.2.1.1. 描述
复制链接

创建 DiscoveryConfig。

1.17.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 DiscoveryConfig 的参数。	DiscoveryConfig

1.17.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.17.2.1.4. 使用
复制链接

discoveryconfigs/yaml

1.17.2.1.5. Tags
复制链接

discoveryconfigs.discovery.open-cluster-management.io

1.17.2.1.5.1. 请求正文
复制链接

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",
    },
    "creationTimestamp": null,
    "name": "discoveryconfigs.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveryConfig",
      "listKind": "DiscoveryConfigList",
      "plural": "discoveryconfigs",
      "singular": "discoveryconfig"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveryConfig is the Schema for the discoveryconfigs API",
            "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. 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": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig",
                "properties": {
                  "credential": {
                    "description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user",
                    "type": "string"
                  },
                  "filters": {
                    "description": "Sets restrictions on what kind of clusters to discover",
                    "properties": {
                      "lastActive": {
                        "description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp",
                        "type": "integer"
                      },
                      "openShiftVersions": {
                        "description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"",
                        "items": {
                          "description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.15\"",
                          "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "credential"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.17.2.2. 查询所有 DiscoveryConfigs
复制链接

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator

1.17.2.2.1. 描述
复制链接

查询发现配置 operator 以获取更多详细信息。

1.17.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.17.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.17.2.2.4. 使用
复制链接

operator/yaml

1.17.2.2.5. Tags
复制链接

discoveryconfigs.discovery.open-cluster-management.io

1.17.2.3. 删除 DiscoveryConfig Operator
复制链接

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}

1.17.2.3.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	application_name 必需	要删除的 Discovery Config operator 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.17.2.3.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.17.2.3.3. Tags
复制链接

discoveryconfigs.operator.open-cluster-management.io

1.17.3. 定义
复制链接

1.17.3.1. DiscoveryConfig
复制链接

Expand

Name	描述	模式
apiVersion 必需	discoveryconfig 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	描述定义资源的规则。	对象
spec 必需	定义 DiscoveryConfig 所需的状态。	请参阅 specs 列表

1.17.3.2. specs 列表
复制链接

Expand

Name	描述	模式
credential 必需	凭据是包含代表用户连接到 OCM API 的凭证的 secret。	字符串
filters 可选	对要发现的集群类型设置限制。	请参阅过滤器列表

1.17.3.3. 过滤器列表
复制链接

Expand

Name	描述	模式
lastActive 必需	lastActive 是集群中要发现的最新活跃天数的集群，由活动时间戳决定。	整数
openShiftVersions 可选	OpenShiftVersions 是 OpenShift 的发行版本列表，格式为 "<Major>.<Minor>"	对象

1.18. DiscoveredCluster API
复制链接

1.18.1. 概述
复制链接

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

1.18.1.1. 版本信息
复制链接

版本 : 2.12.0

1.18.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.18.1.3. Tags
复制链接

DiscoveredClusters.discovery.open-cluster-management.io : 创建和管理 DiscoveredClusters

1.18.2. 路径
复制链接

1.18.2.1. 创建一个 DiscoveredCluster
复制链接

POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters

1.18.2.1.1. 描述
复制链接

创建一个 DiscoveredCluster。

1.18.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 DiscoveredCluster 的参数。	DiscoveredCluster

1.18.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.18.2.1.4. 使用
复制链接

discoveredclusters/yaml

1.18.2.1.5. Tags
复制链接

discoveredclusters.discovery.open-cluster-management.io

1.18.2.1.5.1. 请求正文
复制链接

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.4.1",\
    },
    "creationTimestamp": null,
    "name": "discoveredclusters.discovery.open-cluster-management.io",
  },
  "spec": {
    "group": "discovery.open-cluster-management.io",
    "names": {
      "kind": "DiscoveredCluster",
      "listKind": "DiscoveredClusterList",
      "plural": "discoveredclusters",
      "singular": "discoveredcluster"
    },
    "scope": "Namespaced",
    "versions": [
      {
        "name": "v1",
        "schema": {
          "openAPIV3Schema": {
            "description": "DiscoveredCluster is the Schema for the discoveredclusters API",
            "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. 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": "DiscoveredClusterSpec defines the desired state of DiscoveredCluster",
                "properties": {
                  "activityTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "apiUrl": {
                    "type": "string"
                  },
                  "cloudProvider": {
                    "type": "string"
                  },
                  "console": {
                    "type": "string"
                  },
                  "creationTimestamp": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "credential": {
                    "description": "ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.  1. Ignored fields.  It includes many fields which are not generally honored.  For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.  2. Invalid usage help.  It is impossible to add specific help for individual usage.  In most embedded usages, there are particular     restrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\".     Those cannot be well described when embedded.  3. Inconsistent validation.  Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.  4. The fields are both imprecise and overly precise.  Kind is not a precise mapping to a URL. This can produce ambiguity     during interpretation and require a REST mapping.  In most cases, the dependency is on the group,resource tuple     and the version of the actual struct is irrelevant.  5. We cannot easily change it.  Because this type is embedded in many locations, updates to this type     will affect numerous schemas.  Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "displayName": {
                    "type": "string"
                  },
                  "isManagedCluster": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "openshiftVersion": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "apiUrl",
                  "displayName",
                  "isManagedCluster",
                  "name",
                  "type"
                ],
                "type": "object"
              },
              "status": {
                "description": "DiscoveredClusterStatus defines the observed state of DiscoveredCluster",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.18.2.2. 查询所有 DiscoveredClusters
复制链接

GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator

1.18.2.2.1. 描述
复制链接

查询发现的集群 operator 以获取更多详细信息。

1.18.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.18.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.18.2.2.4. 使用
复制链接

operator/yaml

1.18.2.2.5. Tags
复制链接

discoveredclusters.discovery.open-cluster-management.io

1.18.2.3. 删除 DiscoveredCluster Operator
复制链接

DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}

1.18.2.3.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	application_name 必需	要删除的发现的 Cluster Operator 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.18.2.3.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.18.2.3.3. Tags
复制链接

discoveredclusters.operator.open-cluster-management.io

1.18.3. 定义
复制链接

1.18.3.1. DiscoveredCluster
复制链接

Expand

Name	描述	模式
apiVersion 必需	发现集群的版本化 schema。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	描述定义资源的规则。	对象
spec 必需	DiscoveredClusterSpec 定义所需的 DiscoveredCluster 状态。	请参阅 specs 列表

1.18.3.2. specs 列表
复制链接

Expand

Name	描述	模式
activityTimestamp 可选	DiscoveredClusters 最后可用活动时间戳。	metav1.time
apiUrl 必需	DiscoveredClusters API URL 端点。	字符串
cloudProvider 可选	发现集群的云供应商。	字符串
console 可选	DiscoveredClusters 控制台 URL 端点。	字符串
creationTimestamp 可选	DiscoveredCluster 创建时间戳。	metav1.time
credential 可选	对从中发现集群的凭证的引用。	corev1.ObjectReference
displayName 必需	发现集群的显示名称。	字符串
isManagedCluster 必需	如果为 true，集群由 ACM 管理。	布尔值
name 必需	discoveredcluster 的名称。	字符串
openshiftVersion 可选	发现集群的 OpenShift 版本。	字符串
status 可选	发现集群的状态。	字符串
type 必需	OpenShift 类别（例如，OCP、ROSA 等）。	字符串

1.19. AddOnDeploymentConfig API (v1alpha1)
复制链接

1.19.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 AddOnDeploymentConfig 资源相关的 API 信息。AddOnDeploymentConfig 资源有 4 个可用的请求：create、query、delete 和 update。AddOnDeploymentConfig 代表附加组件的部署配置。

1.19.1.1. 版本信息
复制链接

版本 : 2.12.0

1.19.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.19.1.3. Tags
复制链接

addon.open-cluster-management.io：创建和管理 AddOnDeploymentConfig

1.19.2. 路径
复制链接

1.19.2.1. 查询所有 AddOnDeploymentConfig
复制链接

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs

1.19.2.1.1. 描述
复制链接

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

1.19.2.1.2. 参数
复制链接

Expand

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

1.19.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.19.2.1.4. 使用
复制链接

addondeploymentconfig/yaml

1.19.2.1.5. Tags
复制链接

addon.open-cluster-management.io

1.19.2.2. 创建 AddOnDeploymentConfig
复制链接

POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs

1.19.2.2.1. 描述
复制链接

创建 AddOnDeploymentConfig。

1.19.2.2.2. 参数
复制链接

Expand

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

1.19.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.19.2.2.4. 使用
复制链接

addondeploymentconfig/yaml

1.19.2.2.5. Tags
复制链接

addon.open-cluster-management.io

1.19.2.2.6. HTTP 请求示例
复制链接

1.19.2.2.6.1. 请求正文
复制链接

{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "AddOnDeploymentConfig",
  "metadata": {
    "name": "deploy-config",
    "namespace": "open-cluster-management-hub"
  },
  "spec": {
    "nodePlacement": {
      "nodeSelector": {
        "node-dedicated": "acm-addon"
      },
      "tolerations": [
        {
          "effect": "NoSchedule",
          "key": "node-dedicated",
          "operator": "Equal",
          "value": "acm-addon"
        }
      ]
    }
  }
}

1.19.2.3. 查询单个 AddOnDeploymentConfig
复制链接

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}

1.19.2.3.1. 描述
复制链接

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

1.19.2.3.2. 参数
复制链接

Expand

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

1.19.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.19.2.3.4. Tags
复制链接

addon.open-cluster-management.io

1.19.2.4. 删除 AddOnDeploymentConfig
复制链接

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}

1.19.2.4.1. 描述
复制链接

删除单个 AddOnDeploymentConfig。

1.19.2.4.2. 参数
复制链接

Expand

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

1.19.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.19.2.4.4. Tags
复制链接

addon.open-cluster-management.io

1.19.3. 定义
复制链接

1.19.3.1. AddOnDeploymentConfig
复制链接

Expand

Name	描述	模式
apiVersion 必需	AddOnDeploymentConfig 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	AddOnDeploymentConfig 的元数据。	object
spec 必需	AddOnDeploymentConfig 的规格。	spec

spec

Expand

Name	描述	模式
customizedVariables 可选	当前附加组件部署的 name-value 变量列表。附加组件实施可以使用这些变量呈现其附加组件部署。	customizedVariable 数组
nodePlacement 必需	启用对受管集群中附加组件代理调度的显式控制。	nodePlacement

customizedVariable

Expand

Name	描述	模式
name 必需	此变量的名称。	字符串
value 可选	此变量的值。	字符串

nodePlacement

Expand

Name	描述	模式
nodeSelector 可选	定义 pod 调度到运行的节点。当 `nodeSelector` 为空时，`nodeSelector` 会选择所有节点。	map[string]string
tolerations 可选	应用到 pod，并使用匹配的运算符(`<operator>`)将 pod 调度到与 `<key,value,effect>` 容限匹配的污点。	[]corev1.Toleration

1.20. ClusterManagementAddOn API (v1alpha1)
复制链接

1.20.1. 概述
复制链接

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

ClusterManagementAddOn 代表集群管理器的附加组件注册。此资源允许用户发现哪些附加组件可用于集群管理器，并提供有关附加组件的元数据信息。此资源还提供对 ManagedClusterAddOn 的引用，即用于命名空间范围的 ManagedClusterAddOn 资源的 ClusterManagementAddOn 资源的名称。ClusterManagementAddOn 是一个集群范围的资源。

1.20.1.1. 版本信息
复制链接

版本 : 2.12.0

1.20.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.20.1.3. Tags
复制链接

addon.open-cluster-management.io：创建和管理 ClusterManagementAddOns

1.20.2. 路径
复制链接

1.20.2.1. 查询所有 ClusterManagementAddOns
复制链接

GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons

1.20.2.1.1. 描述
复制链接

查询 ClusterManagementAddOns 获取更多详细信息。

1.20.2.1.2. 参数
复制链接

Expand

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

1.20.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.20.2.1.4. 使用
复制链接

clustermanagementaddon/yaml

1.20.2.1.5. Tags
复制链接

addon.open-cluster-management.io

1.20.2.2. 创建 ClusterManagementAddOn
复制链接

POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons

1.20.2.2.1. 描述
复制链接

创建 ClusterManagementAddOn。

1.20.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
Body	body 必需	描述要创建的 ClusterManagementAddon 绑定的参数。	ClusterManagementAddOn

1.20.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.20.2.2.4. 使用
复制链接

clustermanagementaddon/yaml

1.20.2.2.5. Tags
复制链接

addon.open-cluster-management.io

1.20.2.2.6. HTTP 请求示例
复制链接

1.20.2.2.6.1. 请求正文
复制链接

{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "ClusterManagementAddOn",
  "metadata": {
    "name": "helloworld"
  },
  "spec": {
    "supportedConfigs": [
      {
        "defaultConfig": {
          "name": "deploy-config",
          "namespace": "open-cluster-management-hub"
        },
        "group": "addon.open-cluster-management.io",
        "resource": "addondeploymentconfigs"
      }
    ]
  },
  "status" : { }
}

1.20.2.3. 查询单个 ClusterManagementAddOn
复制链接

GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}

1.20.2.3.1. 描述
复制链接

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

1.20.2.3.2. 参数
复制链接

Expand

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

1.20.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.20.2.3.4. Tags
复制链接

addon.open-cluster-management.io

1.20.2.4. 删除 ClusterManagementAddOn
复制链接

DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}

1.20.2.4.1. 描述
复制链接

删除单个 ClusterManagementAddOn。

1.20.2.4.2. 参数
复制链接

Expand

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

1.20.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.20.2.4.4. Tags
复制链接

addon.open-cluster-management.io

1.20.3. 定义
复制链接

1.20.3.1. ClusterManagementAddOn
复制链接

Expand

Name	描述	模式
apiVersion 必需	ClusterManagementAddOn 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	ClusterManagementAddOn 的元数据。	object
spec 必需	ClusterManagementAddOn 的规格。	spec

spec

Expand

Name	描述	模式
addOnMeta optional	AddOnMeta 是对附加组件的元数据信息的引用。	addOnMeta
supportedConfigs 可选	SupportedConfigs 是附加组件支持的配置类型列表。	configMeta 数组

addOnMeta

Expand

Name	描述	模式
displayName 可选	表示显示的附加组件名称。	字符串
description 可选	代表附加组件的详细描述。	字符串

configMeta

Expand

Name	描述	模式
group 可选	附加组件配置的组。	字符串
resource 必需	附加组件配置的资源。	字符串
defaultConfig 必需	代表默认附加组件配置的命名空间和名称。这是所有附加组件都有相同的配置的位置。	configReferent

configReferent

Expand

Name	描述	模式
namespace 可选	附加组件配置的命名空间。如果没有设置此字段，则配置是 cluster-scope。	字符串
name 必需	附加组件配置的名称。	字符串

1.21. ManagedClusterAddOn API (v1alpha1)
复制链接

1.21.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ManagedClusterAddOn 资源相关的 API 信息。ManagedClusterAddOn 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterAddOn 是包含附加组件当前状态的自定义资源对象。此资源应该在 ManagedCluster 命名空间中创建。

1.21.1.1. 版本信息
复制链接

版本 : 2.12.0

1.21.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.21.1.3. Tags
复制链接

addon.open-cluster-management.io：创建和管理 ManagedClusterAddOns

1.21.2. 路径
复制链接

1.21.2.1. 查询所有 ManagedClusterAddOns
复制链接

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons

1.21.2.1.1. 描述
复制链接

查询 ManagedClusterAddOns 获取更多详细信息。

1.21.2.1.2. 参数
复制链接

Expand

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

1.21.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.21.2.1.4. 使用
复制链接

managedclusteraddon/yaml

1.21.2.1.5. Tags
复制链接

addon.open-cluster-management.io

1.21.2.2. 创建 ManagedClusterAddOn
复制链接

POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons

1.21.2.2.1. 描述
复制链接

创建 ManagedClusterAddOn。

1.21.2.2.2. 参数
复制链接

Expand

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

1.21.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.21.2.2.4. 使用
复制链接

managedclusteraddon/yaml

1.21.2.2.5. Tags
复制链接

addon.open-cluster-management.io

1.21.2.2.6. HTTP 请求示例
复制链接

1.21.2.2.6.1. 请求正文
复制链接

{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "ManagedClusterAddOn",
  "metadata": {
    "name": "helloworld",
    "namespace": "cluster1"
  },
  "spec": {
    "configs": [
      {
        "group": "addon.open-cluster-management.io",
        "name": "cluster-deploy-config",
        "namespace": "open-cluster-management-hub",
        "resource": "addondeploymentconfigs"
      }
    ],
    "installNamespace": "default"
  },
 "status" : { }
}

1.21.2.3. 查询单个 ManagedClusterAddOn
复制链接

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}

1.21.2.3.1. 描述
复制链接

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

1.21.2.3.2. 参数
复制链接

Expand

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

1.21.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.21.2.3.4. Tags
复制链接

addon.open-cluster-management.io

1.21.2.4. 删除 ManagedClusterAddOn
复制链接

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}

1.21.2.4.1. 描述
复制链接

删除单个 ManagedClusterAddOn。

1.21.2.4.2. 参数
复制链接

Expand

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

1.21.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.21.2.4.4. Tags
复制链接

addon.open-cluster-management.io

1.21.3. 定义
复制链接

1.21.3.1. ManagedClusterAddOn
复制链接

Expand

Name	描述	模式
apiVersion 必需	ManagedClusterAddOn 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	ManagedClusterAddOn 的元数据。	object
spec 必需	ManagedClusterAddOn 的规格。	spec

spec

Expand

Name	描述	模式
installNamespace 可选	受管集群上的命名空间，用于安装附加组件代理。如果没有设置，则使用 open-cluster-management-agent-addon 命名空间来安装附加组件代理。	字符串
configs 可选	当前附加组件有其自身配置的附加组件配置列表。	addOnConfig 数组

addOnConfig

Expand

Name	描述	模式
group 可选	附加组件配置的组。	字符串
resource 必需	附加组件配置的资源。	字符串
namespace 可选	附加组件配置的命名空间。如果没有设置此字段，则配置是 cluster-scope。	字符串
name 必需	附加组件配置的名称。	字符串

1.22. ManagedClusterSet API (v1beta2)
复制链接

1.22.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ManagedClusterSet 资源相关的 API 信息。ManagedClusterSet 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterSet 将两个或多个受管集群分组到可一起工作的集合。属于集合的受管集群可以有类似的属性，如共享使用目的或同一部署区域。

1.22.1.1. 版本信息
复制链接

版本 : 2.12.0

1.22.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.22.1.3. Tags
复制链接

cluster.open-cluster-management.io : 创建和管理 ManagedClusterSets

1.22.2. 路径
复制链接

1.22.2.1. 查询所有 managedclustersets
复制链接

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets

1.22.2.1.1. 描述
复制链接

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

1.22.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.22.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.22.2.1.4. 使用
复制链接

managedclusterset/yaml

1.22.2.1.5. Tags
复制链接

cluster.open-cluster-management.io

1.22.2.2. 创建 managedclusterset
复制链接

POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets

1.22.2.2.1. 描述
复制链接

创建 managedclusterset.

1.22.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 `default`。	字符串
Body	body 必需	描述要创建的 managedclusterset 的参数。	ManagedClusterSet

1.22.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.22.2.2.4. 使用
复制链接

managedclusterset/yaml

1.22.2.2.5. Tags
复制链接

cluster.open-cluster-management.io

1.22.2.2.6. HTTP 请求示例
复制链接

1.22.2.2.6.1. 请求正文
复制链接

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta2",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "example-clusterset",
  },
 "spec": {
  },
  "status" : { }
}

1.22.2.3. 查询单个 managedclusterset
复制链接

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets/{managedclusterset_name}

1.22.2.3.1. 描述
复制链接

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

1.22.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 `default`。	字符串
路径	managedclusterset_name 必需	要查询的 managedclusterset 的名称。	字符串

1.22.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.22.2.3.4. Tags
复制链接

cluster.open-cluster-management.io

1.22.2.4. 创建 managedclusterset.
复制链接

DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{managedclusterset_name}

1.22.2.4.1. 描述
复制链接

删除单个 managedclusterset

1.22.2.4.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 `default`。	字符串
路径	managedclusterset_name 必需	要删除的 managedclusterset 的名称。	字符串

1.22.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.22.2.4.4. Tags
复制链接

cluster.open-cluster-management.io

1.22.3. 定义
复制链接

1.22.3.1. ManagedClusterSet
复制链接

Expand

Name	描述	模式
apiVersion 必需	`ManagedClusterSet` 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	`ManagedClusterSet` 的元数据。	object
spec必需	`ManagedClusterSet` 的规格。	spec

1.23. KlusterletConfig API (v1alpha1)
复制链接

1.23.1. 概述
复制链接

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 KlusterletConfig 资源相关的 API 信息。KlusterletConfig 资源有 4 个可用的请求：create、query、delete 和 update。KlusterletConfig 包含有关 klusterlet 的配置信息，如 nodeSelector、tolerations 和 pullSecret。KlusterletConfig 是一个集群范围的资源，仅适用于 open-cluster-managemnet-agent 命名空间中的 klusterlet pod。KlusterletConfig 不会影响附加部署配置。

1.23.1.1. 版本信息
复制链接

版本 : 2.12.0

1.23.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.23.1.3. Tags
复制链接

config.open-cluster-management.io : 创建和管理 KlusterletConfig

1.23.2. 路径
复制链接

1.23.2.1. 查询所有 KlusterletConfig
复制链接

GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs

1.23.2.1.1. 描述
复制链接

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

1.23.2.1.2. 参数
复制链接

Expand

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

1.23.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.23.2.1.4. 使用
复制链接

klusterletconfig/yaml

1.23.2.1.5. Tags
复制链接

config.open-cluster-management.io

1.23.2.2. 创建 KlusterletConfig
复制链接

POST /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs

1.23.2.2.1. 描述
复制链接

创建 KlusterletConfig。

1.23.2.2.2. 参数
复制链接

Expand

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

1.23.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.23.2.2.4. 使用
复制链接

klusterletconfig/yaml

1.23.2.2.5. Tags
复制链接

config.open-cluster-management.io

1.23.2.2.6. HTTP 请求示例
复制链接

1.23.2.2.6.1. 请求正文
复制链接

{
  "apiVersion": "apiextensions.k8s.io/v1",
  "kind": "CustomResourceDefinition",
  "metadata": {
    "annotations": {
      "controller-gen.kubebuilder.io/version": "v0.7.0"
    },
    "creationTimestamp": null,
    "name": "klusterletconfigs.config.open-cluster-management.io"
  },
  "spec": {
    "group": "config.open-cluster-management.io",
    "names": {
      "kind": "KlusterletConfig",
      "listKind": "KlusterletConfigList",
      "plural": "klusterletconfigs",
      "singular": "klusterletconfig"
    },
    "preserveUnknownFields": false,
    "scope": "Cluster",
    "versions": [
      {
        "name": "v1alpha1",
        "schema": {
          "openAPIV3Schema": {
            "description": "KlusterletConfig contains the configuration of a klusterlet including the upgrade strategy, config overrides, proxy configurations etc.",
            "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. 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": "Spec defines the desired state of KlusterletConfig",
                "properties": {
                  "hubKubeAPIServerProxyConfig": {
                    "description": "HubKubeAPIServerProxyConfig holds proxy settings for connections between klusterlet/add-on agents on the managed cluster and the kube-apiserver on the hub cluster. Empty means no proxy settings is available.",
                    "properties": {
                      "caBundle": {
                        "description": "CABundle is a CA certificate bundle to verify the proxy server. It will be ignored if only HTTPProxy is set; And it is required when HTTPSProxy is set and self signed CA certificate is used by the proxy server.",
                        "format": "byte",
                        "type": "string"
                      },
                      "httpProxy": {
                        "description": "HTTPProxy is the URL of the proxy for HTTP requests",
                        "type": "string"
                      },
                      "httpsProxy": {
                        "description": "HTTPSProxy is the URL of the proxy for HTTPS requests HTTPSProxy will be chosen if both HTTPProxy and HTTPSProxy are set.",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "nodePlacement": {
                    "description": "NodePlacement enables explicit control over the scheduling of the agent components. If the placement is nil, the placement is not specified, it will be omitted. If the placement is an empty object, the placement will match all nodes and tolerate nothing.",
                    "properties": {
                      "nodeSelector": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "description": "NodeSelector defines which Nodes the Pods are scheduled on. The default is an empty list.",
                        "type": "object"
                      },
                      "tolerations": {
                        "description": "Tolerations is attached by pods to tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>. The default is an empty list.",
                        "items": {
                          "description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
                          "properties": {
                            "effect": {
                              "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
                              "type": "string"
                            },
                            "key": {
                              "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
                              "type": "string"
                            },
                            "operator": {
                              "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
                              "type": "string"
                            },
                            "tolerationSeconds": {
                              "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
                              "format": "int64",
                              "type": "integer"
                            },
                            "value": {
                              "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
                              "type": "string"
                            }
                          },
                          "type": "object"
                        },
                        "type": "array"
                      }
                    },
                    "type": "object"
                  },
                  "pullSecret": {
                    "description": "PullSecret is the name of image pull secret.",
                    "properties": {
                      "apiVersion": {
                        "description": "API version of the referent.",
                        "type": "string"
                      },
                      "fieldPath": {
                        "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
                        "type": "string"
                      },
                      "kind": {
                        "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
                        "type": "string"
                      },
                      "name": {
                        "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
                        "type": "string"
                      },
                      "namespace": {
                        "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
                        "type": "string"
                      },
                      "resourceVersion": {
                        "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
                        "type": "string"
                      },
                      "uid": {
                        "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "registries": {
                    "description": "Registries includes the mirror and source registries. The source registry will be replaced by the Mirror.",
                    "items": {
                      "properties": {
                        "mirror": {
                          "description": "Mirror is the mirrored registry of the Source. Will be ignored if Mirror is empty.",
                          "type": "string"
                        },
                        "source": {
                          "description": "Source is the source registry. All image registries will be replaced by Mirror if Source is empty.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "mirror"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              },
              "status": {
                "description": "Status defines the observed state of KlusterletConfig",
                "type": "object"
              }
            },
            "type": "object"
          }
        },
        "served": true,
        "storage": true,
        "subresources": {
          "status": {}
        }
      }
    ]
  },
  "status": {
    "acceptedNames": {
      "kind": "",
      "plural": ""
    },
    "conditions": [],
    "storedVersions": []
  }
}

1.23.2.3. 查询单个 KlusterletConfig
复制链接

GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}

1.23.2.3.1. 描述
复制链接

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

1.23.2.3.2. 参数
复制链接

Expand

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

1.23.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.23.2.3.4. Tags
复制链接

config.open-cluster-management.io

1.23.2.4. 删除 KlusterletConfig
复制链接

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}

1.23.2.4.1. 描述
复制链接

删除单个 klusterletconfig。

1.23.2.4.2. 参数
复制链接

Expand

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

1.23.2.4.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.23.2.4.4. Tags
复制链接

config.open-cluster-management.io

1.23.3. 定义
复制链接

1.23.3.1. KlusterletConfig
复制链接

Expand

Name	描述	模式
apiVersion 必需	KlusterletConfig 的版本化模式。	字符串
kind 必需	代表 REST 资源的字符串值。	字符串
metadata 必需	KlusterletConfig 的元数据。	object
spec 必需	KlusterletConfig 的规格。	spec

spec

Expand

Name	描述	模式
registry 可选	包括镜像和源 registry。源 registry 被镜像替代。	registry
pullSecret 可选	镜像 pull secret 的名称。	object
nodePlacement 必需	在受管集群中启用附加代理的调度控制。	nodePlacement
hubKubeAPIServerProxyConfig required	包含受管集群中 klusterlet 或附加代理和 hub 集群上的 kube-apiserver 之间的连接的代理设置。空表示没有可用的代理设置。	kubeAPIServerProxyConfig

nodePlacement

Expand

Name	描述	模式
nodeSelector 可选	定义 pod 调度到运行的节点。当 `nodeSelector` 为空时，`nodeSelector` 会选择所有节点。	map[string]string
tolerations 可选	应用到 pod，并使用匹配的运算符(`<operator>`)将 pod 调度到与 `<key,value,effect>` 容限匹配的污点。	[]corev1.Toleration

kubeAPIServerProxyConfig

Expand

Name	描述	模式
cabundle 可选	用于验证代理服务器的 CA 证书捆绑包。如果只设置了 HTTPProxy，则捆绑包将被忽略。当设置 HTTPSProxy 且代理服务器使用自签名 CA 证书时，需要捆绑包。	map[string]string
httpProxy 可选	HTTP 请求的代理的 URL	map[string]string
httpsProxy 可选	HTTPS 请求的代理的 URL。如果设置了 HTTPProxy 和 HTTPSProxy，则会选择 httpsProxy。	map[string]string

1.24. 策略合规历史记录（技术预览）（已弃用）
复制链接

1.24.1. 概述
复制链接

如果您希望长期存储 Red Hat Advanced Cluster Management for Kubernetes 策略合规事件，策略合规历史记录 API 是一个可选的技术预览功能。您可以使用 API 获取额外详情，如 spec 字段来审核和排除您的策略，并在策略被禁用或从集群中删除时获取合规性事件。策略合规历史记录 API 也可以生成以逗号分隔的值(CSV)电子策略合规事件表，以帮助您进行审核和故障排除。

1.24.1.1. 版本信息
复制链接

版本 : 2.12.0

1.24.2. API 端点
复制链接

1.24.2.1. 列出策略合规事件
复制链接

/api/v1/compliance-events

这会列出您默认有权访问的所有策略合规事件。响应格式如下，默认根据 event.timestamp 进行排序：

{
  "data": [
    {
      "id": 2,
      "cluster": {
        "name": "cluster1",
        "cluster_id": "215ce184-8dee-4cab-b99b-1f8f29dff611"
      },
      "parent_policy": {
        "id": 3,
        "name": "configure-custom-app",
        "namespace": "policies",
        "catageories": ["CM Configuration Management"],
        "controls": ["CM-2 Baseline Configuration"],
        "standards": ["NIST SP 800-53"]
      },
      "policy": {
        "apiGroup": "policy.open-cluster-management.io",
        "id": 2,
        "kind": "ConfigurationPolicy",
        "name": "configure-custom-app",
        "namespace": "",
        // Only shown with `?include_spec`
        "spec": {}
      },
      "event": {
        "compliance": "NonCompliant",
        "message": "configmaps [app-data] not found in namespace default",
        "timestamp": "2023-07-19T18:25:43.511Z",
        "metadata": {}
      }
    },
    {
      "id": 1,
      "cluster": {
        "name": "cluster2",
        "cluster_id": "415ce234-8dee-4cab-b99b-1f8f29dff461"
      },
      "parent_policy": {
        "id": 3,
        "name": "configure-custom-app",
        "namespace": "policies",
        "catageories": ["CM Configuration Management"],
        "controls": ["CM-2 Baseline Configuration"],
        "standards": ["NIST SP 800-53"]
      },
      "policy": {
        "apiGroup": "policy.open-cluster-management.io",
        "id": 4,
        "kind": "ConfigurationPolicy",
        "name": "configure-custom-app",
        "namespace": "",
        // Only shown with `?include_spec`
        "spec": {}
      },
      "event": {
        "compliance": "Compliant",
        "message": "configmaps [app-data] found as specified in namespace default",
        "timestamp": "2023-07-19T18:25:41.523Z",
        "metadata": {}
      }
    }
  ],
  "metadata": {
    "page": 1,
    "pages": 7,
    "per_page": 20,
    "total": 123
  }
}

以下可选查询参数被接受。请注意，如果没有描述的那些只在它引用的字段上过滤。参数值 null 代表没有值。另外，可以使用逗号指定多个值。例如，?cluster.name=cluster1,cluster2 用于 "or" 过滤。如果需要，可以使用 \ 转义逗号。

Expand

表 1.1. 查询参数表
查询参数	描述
cluster.cluster_id
cluster.name
direction	排序方向。默认值为 `desc`，这代表降序排列。支持的值有 `asc` 和 `desc`。
event.compliance
event.message_includes	用于包含输入字符串的合规性消息的过滤器。仅支持单个值。
event.message_like	用于合规性消息的 SQL `LIKE` 过滤器。百分比符号(`%`)表示零个或更多字符的通配符。underscore 符号(`_`)表示单个字符的通配符。例如，`%configmaps [%my-configmap%]%` 与引用配置映射 `my-configmap` 的任何配置策略合规性消息匹配。
event.reported_by
event.timestamp
event.timestamp_after	RFC 3339 时间戳，用于仅在此时间后才会显示合规事件。例如： `2024-02-28T16:32:57Z`。
event.timestamp_before	RFC 3339 时间戳，用于仅显示此时间前的合规性事件。例如： `2024-02-28T16:32:57Z`。
id
include_spec	在返回值中包含策略的 `spec` 字段的标记。默认不设置。
page	查询中的页面号。默认值为 `1`。
parent_policy.categories
parent_policy.controls
parent_policy.id
parent_policy.name
parent_policy.namespace
parent_policy.standards
per_page	每个页面返回的合规事件数量。默认值为 `20`，且不能超过 `100`。
policy.apiGroup
policy.id
policy.kind
policy.name
policy.namespace
policy.severity
排序	要排序的字段。默认为 `event.timestamp`。除 `policy.spec` 和 `event.metadata` 外的所有字段都可以使用点表示法排序。要指定多个排序选项，请使用 `?sort=policy.name,policy.namespace` 等逗号。

1.24.2.2. 选择单个策略合规事件
复制链接

/api/v1/compliance-events/<id>

您可以通过指定数据库 ID 来选择单个策略合规事件。例如，/api/v1/compliance-events/1 选择 ID 为 1 的合规性事件。返回值的格式如下：

{
  "id": 1,
  "cluster": {
    "name": "cluster2",
    "cluster_id": "415ce234-8dee-4cab-b99b-1f8f29dff461"
  },
  "parent_policy": {
    "id": 2,
    "name": "etcd-encryption",
    "namespace": "policies",
    "catageories": ["CM Configuration Management"],
    "controls": ["CM-2 Baseline Configuration"],
    "standards": ["NIST SP 800-53"]
  },
  "policy": {
    "apiGroup": "policy.open-cluster-management.io",
    "id": 4,
    "kind": "ConfigurationPolicy",
    "name": "etcd-encryption",
    "namespace": "",
    "spec": {}
  },
  "event": {
    "compliance": "Compliant",
    "message": "configmaps [app-data] found as specified in namespace default",
    "timestamp": "2023-07-19T18:25:41.523Z",
    "metadata": {}
  }
}

1.24.2.3. 生成电子表格
复制链接

/api/v1/reports/compliance-events

您可以生成以逗号分隔的值(CSV)电子表格，用于审核和故障排除。它输出相同的查询参数，并接受与 /api/v1/compliance-events API 端点相同的查询参数。默认情况下，没有设置 per_page 限制，没有设置 per_page 查询参数的最大值。所有 CSV 标头与 /api/v1/compliance-events API 端点相同，并下划线分隔 JSON 对象。例如，事件时间戳带有 event_timestamp 标头。

1.24.3. 认证和授权
复制链接

策略合规历史记录 API 使用 Red Hat Advanced Cluster Management hub 集群使用的 OpenShift 实例来身份验证和授权。您必须在 HTTPS 请求的 Authorization 标头中提供您的 OpenShift 令牌。

要查找您的令牌，请运行以下命令：

oc whoami --show-token

1.24.3.1. 查看合规性事件
复制链接

要查看受管集群的合规性事件，您需要访问在 Red Hat Advanced Cluster Management hub 集群中完成 ManagedCluster 对象的 get 动词。例如，要查看 local-cluster 集群的合规性事件，您可以使用 open-cluster-management:view:local-cluster ClusterRole 或创建自己的资源，如下例所示：

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
 name: local-cluster-view
rules:
- apiGroups:
 - cluster.open-cluster-management.io
 resources:
 - managedclusters
 resourceNames:
 - local-cluster
 verbs:
 - get

要验证您对特定受管集群的访问，请使用 oc auth can-i 命令。例如，要检查您是否可以访问 local-cluster 受管集群，请运行以下命令：

oc auth can-i get managedclusters.cluster.open-cluster-management.io/local-cluster

1.24.3.2. 记录合规性事件
复制链接

在相应受管集群命名空间中的 policies.policy.open-cluster-management.io/status 资源中具有 patch 动词 访问权限的用户或服务帐户可以访问记录策略合规事件。受管集群中的 governance-policy-framework pod 使用 Red Hat Advanced Cluster Management hub 集群上对应的受管集群命名空间中的 open-cluster-management-compliance-history-api-recorder 服务帐户来记录合规事件。每个服务帐户都有 open-cluster-management:compliance-history-api-recorder ClusterRole 绑定到受管集群命名空间。限制 user 和 service account patch 动词对 策略状态 的访问，以确保存储在策略合规历史记录 API 中的数据的可信度。

查看 Red Hat Advanced Cluster Management 的 API 列表。

第 1 章 API复制链接链接已复制到粘贴板!

1.1. Clusters API复制链接链接已复制到粘贴板!

1.1.1. 概述复制链接链接已复制到粘贴板!

1.1.1.1. 版本信息复制链接链接已复制到粘贴板!

1.1.1.2. URI scheme复制链接链接已复制到粘贴板!

1.1.1.3. Tags复制链接链接已复制到粘贴板!

1.1.2. 路径复制链接链接已复制到粘贴板!

1.1.2.1. 查询所有集群复制链接链接已复制到粘贴板!

1.1.2.1.1. 描述复制链接链接已复制到粘贴板!

1.1.2.1.2. 参数复制链接链接已复制到粘贴板!

1.1.2.1.3. 响应复制链接链接已复制到粘贴板!

1.1.2.1.4. 使用复制链接链接已复制到粘贴板!

1.1.2.1.5. Tags复制链接链接已复制到粘贴板!

1.1.2.2. 创建集群复制链接链接已复制到粘贴板!

1.1.2.2.1. 描述复制链接链接已复制到粘贴板!

1.1.2.2.2. 参数复制链接链接已复制到粘贴板!

1.1.2.2.3. 响应复制链接链接已复制到粘贴板!

1.1.2.2.4. 使用复制链接链接已复制到粘贴板!

1.1.2.2.5. Tags复制链接链接已复制到粘贴板!

1.1.2.2.6. HTTP 请求示例复制链接链接已复制到粘贴板!

1.1.2.2.6.1. 请求正文复制链接链接已复制到粘贴板!

1.1.2.3. 查询单个集群复制链接链接已复制到粘贴板!

1.1.2.3.1. 描述复制链接链接已复制到粘贴板!

1.1.2.3.2. 参数复制链接链接已复制到粘贴板!

1.1.2.3.3. 响应复制链接链接已复制到粘贴板!

1.1.2.3.4. Tags复制链接链接已复制到粘贴板!

1.1.2.4. 删除集群复制链接链接已复制到粘贴板!

1.1.2.4.1. 描述复制链接链接已复制到粘贴板!

1.1.2.4.2. 参数复制链接链接已复制到粘贴板!

1.1.2.4.3. 响应复制链接链接已复制到粘贴板!

1.1.2.4.4. Tags复制链接链接已复制到粘贴板!

1.1.3. 定义复制链接链接已复制到粘贴板!

1.1.3.1. Cluster复制链接链接已复制到粘贴板!

1.2. ClusterInstance API复制链接链接已复制到粘贴板!

1.2.1. 概述复制链接链接已复制到粘贴板!

1.2.1.1. 版本信息复制链接链接已复制到粘贴板!

1.2.1.2. URI scheme复制链接链接已复制到粘贴板!

1.2.1.3. Tags复制链接链接已复制到粘贴板!

1.2.2. 路径复制链接链接已复制到粘贴板!

1.2.2.1. 查询所有集群复制链接链接已复制到粘贴板!

1.2.2.1.1. 描述复制链接链接已复制到粘贴板!

1.2.2.1.2. 参数复制链接链接已复制到粘贴板!

1.2.2.1.3. 响应复制链接链接已复制到粘贴板!

1.2.2.1.4. 使用复制链接链接已复制到粘贴板!

1.2.2.1.5. Tags复制链接链接已复制到粘贴板!

1.2.2.2. 创建安装清单复制链接链接已复制到粘贴板!

1.2.2.2.1. 描述复制链接链接已复制到粘贴板!

1.2.2.2.2. 参数复制链接链接已复制到粘贴板!

1.2.2.2.3. 响应复制链接链接已复制到粘贴板!

1.2.2.2.4. 使用复制链接链接已复制到粘贴板!

1.2.2.2.5. Tags复制链接链接已复制到粘贴板!

1.2.2.2.6. HTTP 请求示例复制链接链接已复制到粘贴板!

1.2.2.2.6.1. 请求正文复制链接链接已复制到粘贴板!

1.2.2.3. 查询单个集群复制链接链接已复制到粘贴板!

1.2.2.3.1. 描述复制链接链接已复制到粘贴板!

1.2.2.3.2. 参数复制链接链接已复制到粘贴板!

1.2.2.3.3. 响应复制链接链接已复制到粘贴板!

1.2.2.3.4. Tags复制链接链接已复制到粘贴板!

1.2.3. 定义复制链接链接已复制到粘贴板!

1.2.3.1. ClusterInstance复制链接链接已复制到粘贴板!

1.3. ClusterSets API (v1beta2)复制链接链接已复制到粘贴板!

1.3.1. 概述复制链接链接已复制到粘贴板!

1.3.1.1. 版本信息复制链接链接已复制到粘贴板!

1.3.1.2. URI scheme复制链接链接已复制到粘贴板!

1.3.1.3. Tags复制链接链接已复制到粘贴板!

1.3.2. 路径复制链接链接已复制到粘贴板!

1.3.2.1. 查询所有集群集（clusterset）复制链接链接已复制到粘贴板!

1.3.2.1.1. 描述复制链接链接已复制到粘贴板!

1.3.2.1.2. 参数复制链接链接已复制到粘贴板!

1.3.2.1.3. 响应复制链接链接已复制到粘贴板!

1.3.2.1.4. 使用复制链接链接已复制到粘贴板!

1.3.2.1.5. Tags复制链接链接已复制到粘贴板!

1.3.2.2. 创建一个 clusterset复制链接链接已复制到粘贴板!

1.3.2.2.1. 描述复制链接链接已复制到粘贴板!

1.3.2.2.2. 参数复制链接链接已复制到粘贴板!

1.3.2.2.3. 响应复制链接链接已复制到粘贴板!

1.3.2.2.4. 使用复制链接链接已复制到粘贴板!

1.3.2.2.5. Tags复制链接链接已复制到粘贴板!

第 1 章 API
复制链接

1.1. Clusters API
复制链接

1.1.1. 概述
复制链接

1.1.1.1. 版本信息
复制链接

1.1.1.2. URI scheme
复制链接

1.1.1.3. Tags
复制链接

1.1.2. 路径
复制链接

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

1.1.2.1.1. 描述
复制链接

1.1.2.1.2. 参数
复制链接

1.1.2.1.3. 响应
复制链接

1.1.2.1.4. 使用
复制链接

1.1.2.1.5. Tags
复制链接

1.1.2.2. 创建集群
复制链接

1.1.2.2.1. 描述
复制链接

1.1.2.2.2. 参数
复制链接

1.1.2.2.3. 响应
复制链接

1.1.2.2.4. 使用
复制链接

1.1.2.2.5. Tags
复制链接

1.1.2.2.6. HTTP 请求示例
复制链接

1.1.2.2.6.1. 请求正文
复制链接

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

1.1.2.3.1. 描述
复制链接

1.1.2.3.2. 参数
复制链接

1.1.2.3.3. 响应
复制链接

1.1.2.3.4. Tags
复制链接

1.1.2.4. 删除集群
复制链接

1.1.2.4.1. 描述
复制链接

1.1.2.4.2. 参数
复制链接

1.1.2.4.3. 响应
复制链接

1.1.2.4.4. Tags
复制链接

1.1.3. 定义
复制链接

1.1.3.1. Cluster
复制链接

1.2. ClusterInstance API
复制链接

1.2.1. 概述
复制链接

1.2.1.1. 版本信息
复制链接

1.2.1.2. URI scheme
复制链接

1.2.1.3. Tags
复制链接

1.2.2. 路径
复制链接

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

1.2.2.1.1. 描述
复制链接

1.2.2.1.2. 参数
复制链接

1.2.2.1.3. 响应
复制链接

1.2.2.1.4. 使用
复制链接

1.2.2.1.5. Tags
复制链接

1.2.2.2. 创建安装清单
复制链接

1.2.2.2.1. 描述
复制链接

1.2.2.2.2. 参数
复制链接

1.2.2.2.3. 响应
复制链接

1.2.2.2.4. 使用
复制链接

1.2.2.2.5. Tags
复制链接

1.2.2.2.6. HTTP 请求示例
复制链接

1.2.2.2.6.1. 请求正文
复制链接

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

1.2.2.3.1. 描述
复制链接

1.2.2.3.2. 参数
复制链接

1.2.2.3.3. 响应
复制链接

1.2.2.3.4. Tags
复制链接

1.2.3. 定义
复制链接

1.2.3.1. ClusterInstance
复制链接

1.3. ClusterSets API (v1beta2)
复制链接

1.3.1. 概述
复制链接

1.3.1.1. 版本信息
复制链接

1.3.1.2. URI scheme
复制链接

1.3.1.3. Tags
复制链接

1.3.2. 路径
复制链接

1.3.2.1. 查询所有集群集（clusterset）
复制链接

1.3.2.1.1. 描述
复制链接

1.3.2.1.2. 参数
复制链接

1.3.2.1.3. 响应
复制链接

1.3.2.1.4. 使用
复制链接

1.3.2.1.5. Tags
复制链接

1.3.2.2. 创建一个 clusterset
复制链接

1.3.2.2.1. 描述
复制链接

1.3.2.2.2. 参数
复制链接

1.3.2.2.3. 响应
复制链接

1.3.2.2.4. 使用
复制链接

1.3.2.2.5. Tags
复制链接

1.3.2.2.6. HTTP 请求示例
复制链接

1.3.2.2.6.1. 请求正文
复制链接