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

API

Red Hat Advanced Cluster Management for Kubernetes 2.2

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

摘要

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

第 1 章 API
复制链接

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

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

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

1.1. Clusters API
复制链接

1.1.1. 概述
复制链接

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

1.1.1.1. 版本信息
复制链接

版本 ：2.2.0

1.1.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.1.1.3. 许可证信息
复制链接

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

1.1.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.1.1.5. Tags
复制链接
  • cluster.open-cluster-management.io :创建和管理集群
1.1.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.1.2. 路径
复制链接

1.1.2.1. 查询所有集群
复制链接
GET /cluster.open-cluster-management.io/v1/managedclusters
Copy to Clipboard Toggle word wrap
1.1.2.1.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.1.4. 使用
复制链接
  • cluster/yaml
1.1.2.1.5. Tags
复制链接
  • cluster.open-cluster-management.io
1.1.2.2. 创建集群
复制链接
POST /cluster.open-cluster-management.io/v1/managedclusters
Copy to Clipboard Toggle word wrap
1.1.2.2.1. 描述
复制链接

创建集群

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

body
必需

描述要创建集群的参数。

Cluster

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.2.4. 使用
复制链接
  • cluster/yaml
1.1.2.2.5. Tags
复制链接
  • cluster.open-cluster-management.io
1.1.2.2.6. HTTP 请求示例
复制链接
1.1.2.2.6.1. 请求正文
复制链接
{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}
Copy to Clipboard Toggle word wrap
1.1.2.3. 查询单个集群
复制链接
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
Copy to Clipboard Toggle word wrap
1.1.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

cluster_name
必需

要查询的集群的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.1.2.3.4. Tags
复制链接
  • cluster.open-cluster-management.io
1.1.2.4. 删除集群
复制链接
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
Copy to Clipboard Toggle word wrap
1.1.2.4.1. 描述
复制链接

删除单个集群

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

cluster_name
必需

要删除的集群的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

1.1.3. 定义
复制链接

1.1.3.1. Cluster
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Expand
Name模式

hubAcceptsClient
必需

bool

managedClusterClientConfigs
可选

< managedClusterClientConfigs > array

leaseDurationSeconds
可选

integer (int32)

managedClusterClientConfigs

Expand
Name描述模式

URL
必需

 

字符串

CABundle
可选

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

字符串（字节）

1.2. Clustersets API（v1alpha1）
复制链接

1.2.1. 概述
复制链接

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

1.2.1.1. 版本信息
复制链接

版本 ：2.2.0

1.2.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.2.1.3. 许可证信息
复制链接

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

1.2.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.2.1.5. Tags
复制链接
  • cluster.open-cluster-management.io :创建和管理 Clusterset
1.2.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.2.2. 路径
复制链接

1.2.2.1. 查询所有集群集（clusterset）
复制链接
GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets
Copy to Clipboard Toggle word wrap
1.2.2.1.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.1.4. 使用
复制链接
  • clusterset/yaml
1.2.2.1.5. Tags
复制链接
  • cluster.open-cluster-management.io
1.2.2.2. 创建一个 clusterset
复制链接
POST /cluster.open-cluster-management.io/v1alpha1/managedclustersets
Copy to Clipboard Toggle word wrap
1.2.2.2.1. 描述
复制链接

创建 Clusterset。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

body
必需

描述要创建的 clusterset 的参数。

Clusterset

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.2.4. 使用
复制链接
  • clusterset/yaml
1.2.2.2.5. Tags
复制链接
  • cluster.open-cluster-management.io
1.2.2.2.6. HTTP 请求示例
复制链接
1.2.2.2.6.1. 请求正文
复制链接
{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}
Copy to Clipboard Toggle word wrap
1.2.2.3. 查询单个集群集
复制链接
GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
Copy to Clipboard Toggle word wrap
1.2.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

clusterset_name
必需

要查询的集群集的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.2.2.3.4. Tags
复制链接
  • cluster.open-cluster-management.io
1.2.2.4. 删除集群集
复制链接
DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
Copy to Clipboard Toggle word wrap
1.2.2.4.1. 描述
复制链接

删除单个集群集。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

clusterset_name
必需

要删除的集群集的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

1.2.3. 定义
复制链接

1.2.3.1. Clusterset
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

1.3. Clustersetbindings API (v1alpha1)
复制链接

1.3.1. 概述
复制链接

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

1.3.1.1. 版本信息
复制链接

版本 ：2.2.0

1.3.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.3.1.3. 许可证信息
复制链接

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

1.3.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.3.1.5. Tags
复制链接
  • cluster.open-cluster-management.io :创建和管理 clustersetbindings
1.3.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.3.2. 路径
复制链接

1.3.2.1. 查询所有 clustersetbindings
复制链接
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
Copy to Clipboard Toggle word wrap
1.3.2.1.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.3.2.1.4. 使用
复制链接
  • clustersetbinding/yaml
1.3.2.1.5. Tags
复制链接
  • cluster.open-cluster-management.io
1.3.2.2. 创建 clustersetbinding
复制链接
POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
Copy to Clipboard Toggle word wrap
1.3.2.2.1. 描述
复制链接

创建 clustersetbinding。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

描述要创建的 clustersetbinding 的参数。

Clustersetbinding

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

路径

clustersetbinding_name
必需

要查询的 clustersetbinding 的名称。

字符串

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. 删除 clustersetbinding
复制链接
DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersetbindings/{clustersetbinding_name}
Copy to Clipboard Toggle word wrap
1.3.2.4.1. 描述
复制链接

删除单个 clustersetbinding。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

路径

clustersetbinding_name
必需

要删除的 clustersetbinding 的名称。

字符串

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. Clustersetbinding
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Expand
Name模式

clusterSet
必需

字符串

1.4. Channels API
复制链接

1.4.1. 概述
复制链接

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

1.4.1.1. 版本信息
复制链接

版本 ：2.2.0

1.4.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.4.1.3. 许可证信息
复制链接

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

1.4.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.4.1.5. Tags
复制链接
  • channels.apps.open-cluster-management.io :创建和管理可部署资源
1.4.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.4.2. 路径
复制链接

1.4.2.1. 创建频道
复制链接
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
Copy to Clipboard Toggle word wrap
1.4.2.1.1. 描述
复制链接

创建频道

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

描述要创建的 deployable 的参数。

Channel

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.1.4. 使用
复制链接
  • application/yaml
1.4.2.1.5. Tags
复制链接
  • channels.apps.open-cluster-management.io
1.4.2.1.6. HTTP 请求示例
复制链接
1.4.2.1.6.1. 请求正文
复制链接
{
  "apiVersion": "apps.open-cluster-management.io/v1",
  "kind": "Channel",
  "metadata": {
    "name": "sample-channel",
    "namespace": "default"
  },
  "spec": {
    "configMapRef": {
      "kind": "configmap",
      "name": "bookinfo-resource-filter-configmap"
    },
    "pathname": "https://charts.helm.sh/stable",
    "type": "HelmRepo"
  }
}
Copy to Clipboard Toggle word wrap
1.4.2.2. 为目标命名空间查询所有频道
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
Copy to Clipboard Toggle word wrap
1.4.2.2.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.2.4. 使用
复制链接
  • application/yaml
1.4.2.2.5. Tags
复制链接
  • channels.apps.open-cluster-management.io
1.4.2.3. 查询命名空间的单个频道
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
Copy to Clipboard Toggle word wrap
1.4.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

channel_name
必需

您要查询的 deployable 的名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.3.4. Tags
复制链接
  • channels.apps.open-cluster-management.io
1.4.2.4. 删除频道
复制链接
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
Copy to Clipboard Toggle word wrap
1.4.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

channel_name
必需

要删除的频道名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.4.3. Tags
复制链接
  • channels.apps.open-cluster-management.io

1.4.3. 定义
复制链接

1.4.3.1. Channel
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Expand
Name描述模式

configMapRef
optional

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

configMapRef

gates
可选

ChannelGate 定义推广到频道的条件

gates

pathname
必需

 

字符串

secretRef
optional

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

secretRef

sourceNamespaces
可选

 

< enum（Namespace、HelmRepo、ObjectBucket、Git、namespace、helmrepo、objectbucket、github）> 数组

configMapRef

Expand
Name描述模式

apiVersion
可选

引用的 API 版本。

字符串

fieldPath
可选

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

字符串

kind
可选

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

字符串

name
可选

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

字符串

namespace
可选

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

字符串

resourceVersion
可选

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

字符串

uid
可选

引用的 UID。更多信息：UID

字符串

gates

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。

< string, string > map

matchExpressions

Expand
Name描述模式

key
必需

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

字符串

operator
必需

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

字符串

values
可选

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

< string > 数字

secretRef

Expand
Name描述模式

apiVersion
可选

引用的 API 版本。

字符串

fieldPath
可选

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

字符串

kind
可选

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

字符串

name
可选

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

字符串

namespace
可选

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

字符串

resourceVersion
可选

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

字符串

uid
可选

引用的 UID。更多信息：UIID

字符串

1.5. Subscriptions API
复制链接

1.5.1. 概述
复制链接

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

1.5.1.1. 版本信息
复制链接

版本 ：2.2.0

1.5.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.5.1.3. 许可证信息
复制链接

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

1.5.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.5.1.5. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io :创建和管理订阅
1.5.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.5.2. 路径
复制链接

1.5.2.1. 创建订阅
复制链接
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
Copy to Clipboard Toggle word wrap
1.5.2.1.1. 描述
复制链接

创建订阅

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

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

Subscription

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.1.4. 使用
复制链接
  • subscription/yaml
1.5.2.1.5. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io
1.5.2.1.6. HTTP 请求示例
复制链接
1.5.2.1.6.1. 请求正文
复制链接
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "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"
      }
    }
  }
}
Copy to Clipboard Toggle word wrap
1.5.2.2. 查询所有订阅
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
Copy to Clipboard Toggle word wrap
1.5.2.2.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.2.4. 使用
复制链接
  • subscription/yaml
1.5.2.2.5. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io
1.5.2.3. 查询单个订阅
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
Copy to Clipboard Toggle word wrap
1.5.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

路径

subscription_name
required

要查询的订阅名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.3.4. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io
1.5.2.4. 创建一个订阅：
复制链接
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
Copy to Clipboard Toggle word wrap
1.5.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

路径

subscription_name
required

要删除的订阅的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.4.3. Tags
复制链接
  • subscriptions.apps.open-cluster-management.io

1.5.3. 定义
复制链接

1.5.3.1. Subscription
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

metadata

spec
必需

spec

status
可选

status

metadata

Expand
Name模式

annotations
可选

对象

labels
可选

对象

name
可选

字符串

namespace
可选

字符串

spec

Expand
Name模式

channel
必需

字符串

name
可选

字符串

overrides
可选

<overrides > 数组

packageFilter
可选

packageFilter

packageOverrides
可选

<packageOverrides > 数组

placement
可选

placement

timewindow
可选

timewindow

overrides

Expand
Name模式

clusterName
必需

字符串

clusterOverrides
必需

< object > 数组

packageFilter

Expand
Name描述模式

annotations
可选

 

< string, string > map

filterRef
optional

 

filterRef

labelSelector
可选

 

labelSelector

version
可选

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

字符串

filterRef

Expand
Name模式

name
可选

字符串

labelSelector

Expand
Name模式

matchExpressions
可选

< matchExpressions > 数组

matchLabels
可选

< string, string > map

matchExpressions

Expand
Name模式

key
必需

字符串

operator
必需

字符串

values
可选

< string > 数字

packageOverrides

Expand
Name模式

packageAlias
可选

字符串

packageName
必需

字符串

packageOverrides
可选

< object > 数组

placement

Expand
Name模式

clusterSelector
可选

clusterSelector

clusters
可选

<cluster > 数组

local
可选

布尔值

placementRef
optional

placementRef

clusterSelector

Expand
Name模式

matchExpressions
可选

< matchExpressions > 数组

matchLabels
可选

< string, string > map

matchExpressions

Expand
Name模式

key
必需

字符串

operator
必需

字符串

values
可选

< string > 数字

clusters

Expand
Name模式

name
必需

字符串

placementRef

Expand
Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

timewindow

Expand
Name模式

dayofweek
可选

< string > 数字

hours
可选

<hours > 数组

location
可选

字符串

windowtype
可选

enum（active、blocked、Active、Blocked）

hours

Expand
Name模式

end
可选

字符串

start
可选

字符串

status

Expand
Name模式

lastUpdateTime
可选

字符串（date-time）

message
可选

字符串

phase
可选

字符串

reason
可选

字符串

statuses
可选

对象

1.6. PlacementRules API
复制链接

1.6.1. 概述
复制链接

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

1.6.1.1. 版本信息
复制链接

版本 ：2.2.0

1.6.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.6.1.3. 许可证信息
复制链接

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

1.6.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.6.1.5. Tags
复制链接
  • placementrules.apps.open-cluster-management.io :创建和管理放置规则
1.6.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.6.2. 路径
复制链接

1.6.2.1. 创建放置规则
复制链接
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
Copy to Clipboard Toggle word wrap
1.6.2.1.1. 描述
复制链接

创建放置规则。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

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

PlacementRule

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
复制链接
  • placementrules.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" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}
Copy to Clipboard Toggle word wrap
1.6.2.2. 查询所有放置规则
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
Copy to Clipboard Toggle word wrap
1.6.2.2.1. 描述
复制链接

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

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

Header

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
复制链接
  • placementrules.apps.open-cluster-management.io
1.6.2.3. 查询单个放置规则
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
Copy to Clipboard Toggle word wrap
1.6.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

路径

placementrule_name
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.3.4. Tags
复制链接
  • placementrules.apps.open-cluster-management.io
1.6.2.4. 删除放置规则
复制链接
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
Copy to Clipboard Toggle word wrap
1.6.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

路径

placementrule_name
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.4.3. Tags
复制链接
  • placementrules.apps.open-cluster-management.io

1.6.3. 定义
复制链接

1.6.3.1. PlacementRule
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Expand
Name模式

clusterConditions
可选

<clusterConditions > 数组

clusterReplicas
optional

整数

clusterSelector
可选

clusterSelector

clusters
可选

<cluster > 数组

policies
可选

< policies > 数组

resourceHint
可选

resourceHint

schedulerName
可选

字符串

clusterConditions

Expand
Name模式

status
可选

字符串

type
可选

字符串

clusterSelector

Expand
Name模式

matchExpressions
可选

< matchExpressions > 数组

matchLabels
可选

< string, string > map

matchExpressions

Expand
Name模式

key
可选

字符串

operator
可选

字符串

values
可选

< string > 数字

clusters

Expand
Name模式

name
可选

字符串

policies

Expand
Name模式

apiVersion
可选

字符串

fieldPath
可选

字符串

kind
可选

字符串

name
可选

字符串

namespace
可选

字符串

resourceVersion
可选

字符串

uid
可选

字符串

resourceHint

Expand
Name模式

order
可选

字符串

type
可选

字符串

1.7. Applications API
复制链接

1.7.1. 概述
复制链接

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

1.7.1.1. 版本信息
复制链接

版本 ：2.2.0

1.7.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.7.1.3. 许可证信息
复制链接

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

1.7.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.7.1.5. Tags
复制链接
  • applications.app.k8s.io :创建和管理应用程序
1.7.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.7.2. 路径
复制链接

1.7.2.1. 创建应用程序
复制链接
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
Copy to Clipboard Toggle word wrap
1.7.2.1.1. 描述
复制链接

创建应用程序。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

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

Application

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.1.4. 使用
复制链接
  • application/yaml
1.7.2.1.5. Tags
复制链接
  • applications.app.k8s.io
1.7.2.1.6. HTTP 请求示例
复制链接
1.7.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" : { }
}
Copy to Clipboard Toggle word wrap
1.7.2.2. 查询所有应用程序
复制链接
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
Copy to Clipboard Toggle word wrap
1.7.2.2.1. 描述
复制链接

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

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

Header

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. 使用
复制链接
  • application/yaml
1.7.2.2.5. Tags
复制链接
  • applications.app.k8s.io
1.7.2.3. 查询单个应用程序
复制链接
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
Copy to Clipboard Toggle word wrap
1.7.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

application_name
required

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

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.3.4. Tags
复制链接
  • applications.app.k8s.io
1.7.2.4. 删除应用程序
复制链接
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
Copy to Clipboard Toggle word wrap
1.7.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

application_name
required

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

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.4.3. Tags
复制链接
  • applications.app.k8s.io

1.7.3. 定义
复制链接

1.7.3.1. Application
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

spec
必需

spec

spec

Expand
Name模式

assemblyPhase
可选

字符串

componentKinds
optional

< object > 数组

descriptor
可选

descriptor

info
可选

<info > 数组

selector
可选

对象

descriptor

Expand
Name模式

description
可选

字符串

icons
可选

< icons > 数组

keywords
可选

< string > 数字

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
optional

ingressRef

secretKeyRef
optional

secretKeyRef

serviceRef
optional

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.8. Helm API
复制链接

1.8.1. 概述
复制链接

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

1.8.1.1. 版本信息
复制链接

版本 ：2.2.0

1.8.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.8.1.3. 许可证信息
复制链接

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

1.8.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.8.1.5. Tags
复制链接
  • helmreleases.apps.open-cluster-management.io :创建和管理 helmreleases
1.8.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.8.2. 路径
复制链接

1.8.2.1. 创建 helmrelease
复制链接
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
Copy to Clipboard Toggle word wrap
1.8.2.1.1. 描述
复制链接

创建 helmrelease。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

描述要创建的 helmrelease 的参数。

HelmRelease

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
复制链接
  • helmreleases.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" : "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
    }
  }
}
Copy to Clipboard Toggle word wrap
1.8.2.2. 查询所有 helmreleases
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
Copy to Clipboard Toggle word wrap
1.8.2.2.1. 描述
复制链接

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

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

Header

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
复制链接
  • helmreleases.apps.open-cluster-management.io
1.8.2.3. 查询单个 helmrelease
复制链接
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
Copy to Clipboard Toggle word wrap
1.8.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

helmrelease_name
必需

要查询的 helmrelease 的名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.3.4. Tags
复制链接
  • helmreleases.apps.open-cluster-management.io
1.8.2.4. 删除 helmrelease
复制链接
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
Copy to Clipboard Toggle word wrap
1.8.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

helmrelease_name
必需

要删除的 helmrelease 的名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.4.3. Tags
复制链接
  • helmreleases.apps.open-cluster-management.io

1.8.3. 定义
复制链接

1.8.3.1. HelmRelease
复制链接
Expand
Name模式

apiVersion
必需

字符串

kind
必需

字符串

metadata
必需

对象

repo
必需

repo

spec
必需

对象

status
必需

status

repo

Expand
Name模式

chartName
可选

字符串

configMapRef
optional

configMapRef

secretRef
optional

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
可选

< string > 数字

helmRepo

Expand
Name模式

urls
可选

< string > 数字

status

Expand
Name模式

conditions
必需

< conditions > 数组

deployedRelease
可选

deployedRelease

conditions

Expand
Name模式

lastTransitionTime
可选

字符串（date-time）

message
可选

字符串

reason
可选

字符串

status
必需

字符串

type
必需

字符串

deployedRelease

Expand
Name模式

manifest
可选

字符串

name
可选

字符串

1.9. Policy API
复制链接

1.9.1. 概述
复制链接

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

1.9.1.1. 版本信息
复制链接

版本 ：2.2.0

1.9.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.9.1.3. 许可证信息
复制链接

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

1.9.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.9.1.5. Tags
复制链接
  • policy.open-cluster-management.io/v1 :创建和管理策略
1.9.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.9.2. 路径
复制链接

1.9.2.1. 创建策略
复制链接
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.9.2.1.1. 描述
复制链接

创建策略

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

Header

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/json
1.9.2.1.5. Tags
复制链接
  • policy.open-cluster-management.io
1.9.2.1.6. HTTP 请求示例
复制链接
1.9.2.1.6.1. 请求正文
复制链接
{
  "apiVersion": "policy.open-cluster-management.io/v1/v1alpha1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patchß"
              ],
            },
          ],
        },
      },
    },
  },
Copy to Clipboard Toggle word wrap
1.9.2.2. 查询所有策略
复制链接
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.9.2.2.1. 描述
复制链接

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

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

Header

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/json
1.9.2.2.5. Tags
复制链接
  • policy.open-cluster-management.io
1.9.2.3. 查询单个策略
复制链接
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.9.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

policy_name
必需

要查询的策略的名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.3.4. Tags
复制链接
  • policy.open-cluster-management.io
1.9.2.4. 删除策略
复制链接
DELETE /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.9.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

policy_name
必需

要删除的策略名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

1.9.3. 定义
复制链接

1.9.3.1. policy
复制链接
Expand
Name描述模式

apiVersion
必需

策略的版本化模式（schema）。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Expand
Name描述模式

remediationAction
可选

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

字符串

namespaceSelector
必需

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

字符串

policy-templates

Expand
Name描述模式

apiVersion
必需

策略的版本化模式（schema）。

字符串

kind
可选

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

complianceType

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

字符串

clusterConditions
可选

定义标签的部分。

字符串

rules
可选

 

字符串

clusterConditions

Expand
Name描述模式

matchLabels
可选

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

对象

cloud
可选

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

字符串

rules

Expand
Name描述模式

apiGroups
必需

适用于该规则的 API 列表。

字符串

resources
必需

资源类型列表。

对象

verbs
必需

动词列表。

字符串

1.10. Observability API
复制链接

1.10.1. 概述
复制链接

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

1.10.1.1. 版本信息
复制链接

版本 ：2.2.0

1.10.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.10.1.3. 许可证信息
复制链接

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

1.10.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.10.1.5. Tags
复制链接
  • observability.open-cluster-management.io :创建和管理 multiclusterobservabilities
1.10.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.10.2. 路径
复制链接

1.10.2.1. 创建 multiclusterobservability 资源
复制链接
POST /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
Copy to Clipboard Toggle word wrap
1.10.2.1.1. 描述
复制链接

创建 MultiClusterObservability 资源。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

body
必需

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

MultiClusterObservability

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
复制链接
  • observability.apps.open-cluster-management.io
1.10.2.1.6. HTTP 请求示例
复制链接
1.10.2.1.6.1. 请求正文
复制链接
{
  "apiVersion": "observability.open-cluster-management.io/v1beta1",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "storageConfigObject": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      }
    }
  }
}
Copy to Clipboard Toggle word wrap
1.10.2.2. 查询所有 multiclusterobservabilities
复制链接
GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
Copy to Clipboard Toggle word wrap
1.10.2.2.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

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
复制链接
  • observability.apps.open-cluster-management.io
1.10.2.3. 查询单个 multiclusterobservability
复制链接
GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
Copy to Clipboard Toggle word wrap
1.10.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

multiclusterobservability_name
必需

要查询的 multiclusterobservability 的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.3.4. Tags
复制链接
  • observability.apps.open-cluster-management.io
1.10.2.4. 删除一个 multiclusterobservability 资源
复制链接
DELETE /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
Copy to Clipboard Toggle word wrap
1.10.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

multiclusterobservability_name
必需

要删除的 multiclusterobservability 的名称。

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.4.3. Tags
复制链接
  • observability.apps.open-cluster-management.io

1.10.3. 定义
复制链接

1.10.3.1. MultiClusterObservability
复制链接
Expand
Name描述模式

apiVersion
必需

版本化的 MultiClusterObservability schema。

字符串

kind
必需

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

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Expand
Name描述模式

availabilityConfig
可选

用于选择高可用性支持参数。这可提供对故障切换的支持，并消耗更多资源。
选项：Basic 和 High

字符串

enableDownSampling
可选

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

布尔值

imagePullPolicy
可选

拉取 Observability 镜像的策略。

字符串

imagePullSecret
可选

Observability 镜像的 pull secret。

字符串

nodeSelector
可选

支持节点选择限制

对象

observabilityAddonSpec
optional

所有启用了附加组件的受管集群的全局设置。

observabilityAddonSpec

retentionResolution1h
可选

在存储桶中保留分辨率 2 样本（1 小时）的时间长度。默认为 30 天（30d）。

字符串

retentionResolution5m
可选

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

字符串

retentionResolutionRaw
optional

在存储桶中保留原始分辨率样本的时间。

字符串

storageConfigObject
必需

指定 Observability 使用的存储。

storageConfigObject

observabilityAddonSpec

Expand
Name描述模式

enableMetrics
可选

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

布尔值

interval
可选

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

整数

storageConfigObject

Expand
Name描述模式

metricObjectStorage
必需

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

metricObjectStorage

statefulSetSize
可选

适用于 Observability StatefulSets（如 Thanos store、rule、compact 和 receiver）的存储量。默认值为 10Gi。

字符串

statefulSetStorageClass
可选

指定 storageClass StatefulSets。如果为您的操作系统配置 MetricObjectStorage 来创建存储，则此存储用于对象存储。默认值为 gp2。

字符串

metricObjectStorage

Expand
Name描述模式

key
必需

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

字符串

name
必需

metricObjectStorage 的名称。

字符串

1.11. 搜索自定义 API
复制链接

1.11.1. 概述
复制链接

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

1.11.1.1. 版本信息
复制链接

版本 ：2.2.0

1.11.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.11.1.3. 许可证信息
复制链接

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

1.11.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.11.1.5. Tags
复制链接
  • search.open-cluster-management.io/v1 :创建和管理持久性卷
1.11.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.11.2. 路径
复制链接

1.11.2.1. 创建 searchCustomization
复制链接
POST /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.11.2.1.1. 描述
复制链接

创建 searchCustomization。

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

描述要创建策略的参数。

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

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

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

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

Header

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. 使用
复制链接
  • searchCustomization/json
1.11.2.2.5. Tags
复制链接
  • search.open-cluster-management.io
1.11.2.3. 查询单个策略
复制链接
GET /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.11.2.3.1. 描述
复制链接

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

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

Header

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
复制链接
  • search.open-cluster-management.io
1.11.2.4. 删除 searchCustomization
复制链接
DELETE /search.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
Copy to Clipboard Toggle word wrap
1.11.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

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
复制链接
  • search.open-cluster-management.io

1.11.3. 定义
复制链接

1.11.3.1. SearchCustomization
复制链接
Expand
Name描述模式

apiVersion
必需

SearchCustomization 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

spec

Expand
Name描述模式

remediationAction
可选

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

字符串

namespaces
必需

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

字符串

policy-templates

Expand
Name描述模式

apiVersion
必需

SearchCustomization 的版本化模式。

字符串

kind
可选

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义策略的规则。

对象

complianceType

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

字符串

clusterConditions
可选

定义标签的部分。

字符串

rules
可选

 

字符串

clusterConditions

Expand
Name描述模式

matchLabels
可选

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

对象

cloud
可选

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

字符串

rules

Expand
Name描述模式

apiGroups
必需

适用于该规则的 API 列表。

字符串

resources
必需

资源类型列表。

对象

verbs
必需

动词列表。

字符串

1.12. MultiClusterHub API
复制链接

1.12.1. 概述
复制链接

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

1.12.1.1. 版本信息
复制链接

版本 ：2.2.0

1.12.1.2. 联系信息
复制链接

Contact Email : apiteam@swagger.io

1.12.1.3. 许可证信息
复制链接

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

1.12.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes :HTTPS

1.12.1.5. Tags
复制链接
  • multiclusterhubs.operator.open-cluster-management.io :创建和管理多集群 hub operator
1.12.1.6. 外部文档
复制链接

描述 ：了解有关 Swagger 的更多信息。
URL : http://swagger.io

1.12.2. 路径
复制链接

1.12.2.1. 创建 MultiClusterHub 资源
复制链接
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch
Copy to Clipboard Toggle word wrap
1.12.2.1.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

Body

body
必需

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

定义

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.1.4. 使用
复制链接
  • multiclusterhubs/yaml
1.12.2.1.5. Tags
复制链接
  • multiclusterhubs.operator.open-cluster-management.io
1.12.2.1.6. HTTP 请求示例
复制链接
1.12.2.1.6.1. 请求正文
复制链接
{
	"apiVersion": "apiextensions.k8s.io/v1beta1",
	"kind": "CustomResourceDefinition",
	"metadata": {
		"name": "multiclusterhubs.operator.open-cluster-management.io"
	},
	"spec": {
		"additionalPrinterColumns": [
			{
				"JSONPath": ".status.phase",
				"description": "The overall status of the MultiClusterHub.",
				"name": "Status",
				"type": "string"
			},
			{
				"JSONPath": ".metadata.creationTimestamp",
				"name": "Age",
				"type": "date"
			}
		],
		"group": "operator.open-cluster-management.io",
		"names": {
			"kind": "MultiClusterHub",
			"listKind": "MultiClusterHubList",
			"plural": "multiclusterhubs",
			"shortNames": [
				"mch"
			],
			"singular": "multiclusterhub"
		},
		"scope": "Namespaced",
		"subresources": {
			"status": {}
		},
		"validation": {
			"openAPIV3Schema": {
				"description": "MultiClusterHub defines the configuration for an instance of the MultiClusterHub.",
				"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": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
						"properties": {
							"availabilityConfig": {
								"description": "Specifies deployment replication for improved availability. Options are: Basic and High (default).",
								"type": "string"
							},
							"customCAConfigmap": {
								"description": "Provide the customized OpenShift default ingress CA certificate to {product-title-short}.",
								"type": "string"
							},
							"disableHubSelfManagement": {
								"description": "Disable automatic import of the hub cluster as a managed cluster.",
								"type": "boolean"
							},
							"disableUpdateClusterImageSets": {
								"description": "Disable automatic update of ClusterImageSets.",
								"type": "boolean"
							},
							"hive": {
								"description": "(Deprecated) Overrides for the default HiveConfig specification.",
								"properties": {
									"additionalCertificateAuthorities": {
										"description": "(Deprecated) AdditionalCertificateAuthorities is a list of references to secrets in the `hive` namespace that contain an additional Certificate Authority to use when communicating with target clusters. These certificate authorities are used in addition to any self-signed CA generated by each cluster on installation.",
										"items": {
											"description": "LocalObjectReference contains enough 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 as changes that happen during this interval are queued up and result in a backup happening 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 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 references a secret that are 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 GCP-specific settings for external DNS",
												"properties": {
													"credentials": {
														"description": "(Deprecated) Credentials references 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 named `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 can be 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 we need to ensure nothing is running that adds or acts 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": "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 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. The values that can be used are: 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 contains 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. The values that can be used are: 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"
			}
		},
		"version": "v1",
		"versions": [
			{
				"name": "v1",
				"served": true,
				"storage": true
			}
		]
	}
}
Copy to Clipboard Toggle word wrap
1.12.2.2. 查询所有 MultiClusterHubs
复制链接
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator
Copy to Clipboard Toggle word wrap
1.12.2.2.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.2.4. 使用
复制链接
  • operator/yaml
1.12.2.2.5. Tags
复制链接
  • multiclusterhubs.operator.open-cluster-management.io
1.12.2.3. 查询 MultiClusterHub operator
复制链接
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
Copy to Clipboard Toggle word wrap
1.12.2.3.1. 描述
复制链接

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

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

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

application_name
required

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

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.3.4. Tags
复制链接
  • multiclusterhubs.operator.open-cluster-management.io
1.12.2.4. 删除 MultiClusterHub operator
复制链接
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multicllusterhub_name}
Copy to Clipboard Toggle word wrap
1.12.2.4.1. 参数
复制链接
Expand
类型Name描述模式

Header

COOKIE
必需

授权：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

application_name
required

要删除的 multicluster hub Operator 的名称。

字符串

路径

namespace
必需

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

字符串

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

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.12.2.4.3. Tags
复制链接
  • multiclusterhubs.operator.open-cluster-management.io

1.12.3. 定义
复制链接

1.12.3.1. multicluster hub operator
复制链接
Expand
Name描述模式

apiVersion
必需

MultiClusterHub 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

描述定义资源的规则。

对象

spec
必需

资源规格。

spec

spec

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

customCAConfigmap
optional

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

字符串

disableHubSelfManagement
optional

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

布尔值

disableUpdateClusterImageSets
optional

禁用 ClusterImageSets 的自动更新。

布尔值

hive
可选

（已弃用）用于覆盖默认 HiveConfig 规格的对象。

hive

imagePullSecret
可选

覆盖用于访问 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
必须

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

failedProvisionConfig

globalPullSecret
可选

（已弃用）用于指定供所有集群部署全局使用的 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
可选

集群条件的类型。

字符串

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat