红帽全球峰会API
API
摘要
第 1 章 API
您可以使用 API 来创建和管理应用程序资源、频道、订阅和查询信息。
用户需要的访问权限： 您只能执行已分配角色的操作。了解 基于角色的访问控制文档中的访问要求。
您还可以从集成控制台访问所有 API。在 local-cluster 视图中，进入到 Home > API Explorer 以探索 API 组。
如需更多信息，请参阅以下每个资源的 API 文档：
- Clusters API
- ClusterSets API (v1beta2)
- ClusterSetBindings API (v1beta2)
- Channels API
- Subscriptions API
- PlacementRules API (已弃用)
- Applications API
- Helm API
- Policy API
- Observability API
- 搜索查询 API
- MultiClusterHub API
- Placements API (v1beta1)
- PlacementDecisions API (v1beta1)
- DiscoveryConfig API
- DiscoveredCluster API
- AddOnDeploymentConfig API (v1alpha1)
- ClusterManagementAddOn API (v1alpha1)
- ManagedClusterAddOn API (v1alpha1)
- ManagedClusterSet API
- KlusterletConfig API (v1alpha1)
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.1. 版本信息
版本 : 2.9.0
1.1.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.1.1.3. Tags
- cluster.open-cluster-management.io：创建和管理集群
1.1.2. 路径
1.1.2.1. 查询所有集群
GET /cluster.open-cluster-management.io/v1/managedclusters
GET /cluster.open-cluster-management.io/v1/managedclusters1.1.2.1.1. 描述
查询集群以获取更多详细信息。
1.1.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.1.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.1.2.1.4. 使用
-
cluster/yaml
1.1.2.1.5. Tags
- cluster.open-cluster-management.io
1.1.2.2. 创建集群
POST /cluster.open-cluster-management.io/v1/managedclusters
POST /cluster.open-cluster-management.io/v1/managedclusters1.1.2.2.1. 描述
创建集群
1.1.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建集群的参数。 |
1.1.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.1.2.2.4. 使用
-
cluster/yaml
1.1.2.2.5. Tags
- cluster.open-cluster-management.io
1.1.2.2.6. HTTP 请求示例
1.1.2.2.6.1. 请求正文
1.1.2.3. 查询单个集群
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}1.1.2.3.1. 描述
查询单个集群以获取更多详细信息。
1.1.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
cluster_name | 要查询的集群的名称。 | 字符串 |
1.1.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.1.2.3.4. Tags
- cluster.open-cluster-management.io
1.1.2.4. 删除集群
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}1.1.2.4.1. 描述
删除单个集群
1.1.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
cluster_name | 要删除的集群的名称。 | 字符串 |
1.1.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.1.2.4.4. Tags
- cluster.open-cluster-management.io
1.1.3. 定义
1.1.3.1. Cluster
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion |
| 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata |
| 对象 |
|
spec |
|
spec
| Name | 描述 | 模式 |
|---|---|---|
|
hubAcceptsClient |
指定 hub 是否可以与受管集群中的 klusterlet 代理建立连接。默认值为 | bool |
|
managedClusterClientConfigs | 列出受管集群的 apiserver 地址。 | |
|
leaseDurationSeconds | 指定受管集群中 klusterlet 代理的租期更新时间间隔。默认情况下，Klusterlet 代理每 60 秒更新其租期。 | integer (int32) |
|
taint | 防止在调度过程中将受管集群分配给一个或多个受管集群集。 | 污点 数组 |
managedClusterClientConfigs
| Name | 描述 | 模式 |
|---|---|---|
|
URL | 字符串 | |
|
CABundle | Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
| 字符串（字节） |
taint
| Name | 描述 | 模式 |
|---|---|---|
|
key | 应用到集群的污点键。 | 字符串 |
|
value | 与污点键对应的污点值。 | 字符串 |
|
effect |
污点对于不容许污点的放置的影响。有效值为 | 字符串 |
1.2. ClusterSets API (v1beta2)
1.2.1. 概述
本文档介绍了与 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.2.1.1. 版本信息
版本 : 2.9.0
1.2.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.2.1.3. Tags
- cluster.open-cluster-management.io：创建和管理 Clustersets
1.2.2. 路径
1.2.2.1. 查询所有集群集（clusterset）
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets1.2.2.1.1. 描述
查询 Clustersets 以获取更多详细信息。
1.2.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.2.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.2.2.1.4. 使用
-
clusterset/yaml
1.2.2.1.5. Tags
- cluster.open-cluster-management.io
1.2.2.2. 创建一个 clusterset
POST /cluster.open-cluster-management.io/v1beta2/managedclustersets
POST /cluster.open-cluster-management.io/v1beta2/managedclustersets1.2.2.2.1. 描述
创建 Clusterset。
1.2.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 clusterset 的参数。 |
1.2.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.2.2.2.4. 使用
-
clusterset/yaml
1.2.2.2.5. Tags
- cluster.open-cluster-management.io
1.2.2.2.6. HTTP 请求示例
1.2.2.2.6.1. 请求正文
1.2.2.3. 查询单个集群集
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}1.2.2.3.1. 描述
查询单个集群集以获取更多详细信息。
1.2.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clusterset_name | 要查询的集群集的名称。 | 字符串 |
1.2.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.2.2.3.4. Tags
- cluster.open-cluster-management.io
1.2.2.4. 删除集群集
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}1.2.2.4.1. 描述
删除单个集群集。
1.2.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clusterset_name | 要删除的集群集的名称。 | 字符串 |
1.2.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.2.2.4.4. Tags
- cluster.open-cluster-management.io
1.2.3. 定义
1.2.3.1. Clusterset
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
kind | 字符串 |
|
metadata | 对象 |
1.3. Clustersetbindings API (v1beta2)
1.3.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ClusterSetBinding 资源相关的 API 信息。ClusterSetBinding 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterSetBinding 将 ManagedClusterSet 项目到一个特定命名空间中。在一个命名空间中创建一个 ManagedClusterSetBinding，如果您有一个 RBAC 规则，允许您在 managedclustersets/bind 的虚拟子资源上创建它。
1.3.1.1. 版本信息
版本 : 2.9.0
1.3.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.3.1.3. Tags
- cluster.open-cluster-management.io：创建和管理 clustersetbindings
1.3.2. 路径
1.3.2.1. 查询所有 clustersetbindings
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings1.3.2.1.1. 描述
查询 clustersetbindings 以获取更多详细信息。
1.3.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.3.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.3.2.1.4. 使用
-
clustersetbinding/yaml
1.3.2.1.5. Tags
- cluster.open-cluster-management.io
1.3.2.2. 创建 clustersetbinding
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings1.3.2.2.1. 描述
创建 clustersetbinding。
1.3.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace |
要使用的命名空间，如 | 字符串 |
| Body |
body | 描述要创建的 clustersetbinding 的参数。 |
1.3.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.3.2.2.4. 使用
-
clustersetbinding/yaml
1.3.2.2.5. Tags
- cluster.open-cluster-management.io
1.3.2.2.6. HTTP 请求示例
1.3.2.2.6.1. 请求正文
1.3.2.3. 查询单个 clustersetbinding
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}1.3.2.3.1. 描述
查询单个 clustersetbinding 获取更多详细信息。
1.3.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace |
要使用的命名空间，如 | 字符串 |
| 路径 |
clustersetbinding_name | 要查询的 clustersetbinding 的名称。 | 字符串 |
1.3.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.3.2.3.4. Tags
- cluster.open-cluster-management.io
1.3.2.4. 删除 clustersetbinding
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}1.3.2.4.1. 描述
删除单个 clustersetbinding。
1.3.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace |
要使用的命名空间，如 | 字符串 |
| 路径 |
clustersetbinding_name | 要删除的 clustersetbinding 的名称。 | 字符串 |
1.3.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.3.2.4.4. Tags
- cluster.open-cluster-management.io
1.3.3. 定义
1.3.3.1. Clustersetbinding
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion |
| 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata |
| 对象 |
|
spec |
|
spec
| Name | 描述 | 模式 |
|---|---|---|
|
clusterSet |
要绑定的 | 字符串 |
1.4. Clusterview API (v1alpha1)
1.4.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 clusterview 资源相关的 API 信息。clusterview 资源提供了一个 CLI 命令，可让您查看您可以访问的受管集群和受管集群集的列表。三个可能的请求有：list、get 和 watch。
1.4.1.1. 版本信息
版本 : 2.9.0
1.4.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.4.1.3. Tags
- clusterview.open-cluster-management.io：查看 ID 可访问的受管集群列表。
1.4.2. 路径
1.4.2.1. 获取受管集群
GET /managedclusters.clusterview.open-cluster-management.io
GET /managedclusters.clusterview.open-cluster-management.io1.4.2.1.1. 描述
查看您可以访问的受管集群列表。
1.4.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.4.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.4.2.1.4. 使用
-
managedcluster/yaml
1.4.2.1.5. Tags
- clusterview.open-cluster-management.io
1.4.2.2. 列出受管集群
LIST /managedclusters.clusterview.open-cluster-management.io
LIST /managedclusters.clusterview.open-cluster-management.io1.4.2.2.1. 描述
查看您可以访问的受管集群列表。
1.4.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 要列出受管集群的用户 ID 的名称。 | 字符串 |
1.4.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.4.2.2.4. 使用
-
managedcluster/yaml
1.4.2.2.5. Tags
- clusterview.open-cluster-management.io
1.4.2.2.6. HTTP 请求示例
1.4.2.2.6.1. 请求正文
1.4.2.3. 观察受管集群集
WATCH /managedclusters.clusterview.open-cluster-management.io
WATCH /managedclusters.clusterview.open-cluster-management.io1.4.2.3.1. 描述
观察您可以访问的受管集群。
1.4.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clusterview_name | 要监视的用户 ID 的名称。 | 字符串 |
1.4.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.4.2.4. 列出受管集群集。
GET /managedclustersets.clusterview.open-cluster-management.io
GET /managedclustersets.clusterview.open-cluster-management.io1.4.2.4.1. 描述
列出您可以访问的受管集群。
1.4.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clusterview_name | 要监视的用户 ID 的名称。 | 字符串 |
1.4.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.4.2.5. 列出受管集群集。
LIST /managedclustersets.clusterview.open-cluster-management.io
LIST /managedclustersets.clusterview.open-cluster-management.io1.4.2.5.1. 描述
列出您可以访问的受管集群。
1.4.2.5.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clusterview_name | 要监视的用户 ID 的名称。 | 字符串 |
1.4.2.5.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.4.2.6. 观察受管集群集。
WATCH /managedclustersets.clusterview.open-cluster-management.io
WATCH /managedclustersets.clusterview.open-cluster-management.io1.4.2.6.1. 描述
观察您可以访问的受管集群。
1.4.2.6.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clusterview_name | 要监视的用户 ID 的名称。 | 字符串 |
1.4.2.6.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.5. Channels API
1.5.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的频道资源相关的 API 信息。频道资源有 4 个可用的请求：create、query、delete 和 update。
1.5.1.1. 版本信息
版本 : 2.9.0
1.5.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.5.1.3. Tags
- channels.apps.open-cluster-management.io : 创建和管理可部署性资源（deployables）
1.5.2. 路径
1.5.2.1. 创建频道
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels1.5.2.1.1. 描述
创建频道
1.5.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的 deployable 的参数。 |
1.5.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.5.2.1.4. 使用
-
application/yaml
1.5.2.1.5. Tags
- channels.apps.open-cluster-management.io
1.5.2.1.6. HTTP 请求示例
1.5.2.1.6.1. 请求正文
1.5.2.2. 为目标命名空间查询所有频道
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels1.5.2.2.1. 描述
查询您的频道以获得更详细的信息。
1.5.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.5.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.5.2.2.4. 使用
-
application/yaml
1.5.2.2.5. Tags
- channels.apps.open-cluster-management.io
1.5.2.3. 查询命名空间的单个频道
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}1.5.2.3.1. 描述
查询单个频道以了解更多详情。
1.5.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
channel_name | 您要查询的 deployable 的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.5.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.5.2.3.4. Tags
- channels.apps.open-cluster-management.io
1.5.2.4. 删除频道
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}1.5.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
channel_name | 要删除的频道名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.5.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.5.2.4.3. Tags
- channels.apps.open-cluster-management.io
1.5.3. 定义
1.5.3.1. Channel
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
kind | 字符串 |
|
metadata | 对象 |
|
spec |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
configMapRef | ObjectReference 包含足够信息供您检查或修改引用的对象。 | |
|
gates | ChannelGate 定义推广到频道的条件 | |
|
pathname | 字符串 | |
|
secretRef | ObjectReference 包含足够信息供您检查或修改引用的对象。 | |
|
sourceNamespaces | enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) array |
configMapRef
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 引用的 API 版本。 | 字符串 |
|
fieldPath | 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的，且该字段在将来会有所改变。 | 字符串 |
|
kind | 引用的类型。更多信息：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
| Name | 描述 | 模式 |
|---|---|---|
|
annotations | k8s 的典型注解 | |
|
labelSelector | 标签选择器，即一组资源的标签查询。matchLabels 和 matchExpressions 的逻辑关系是 AND。空标签选择器匹配所有对象。null 标签选择器不匹配任何对象。 | |
|
name | 字符串 |
annotations
| Name | 模式 |
|---|---|
|
key | 字符串 |
|
value | 字符串 |
labelSelector
| Name | 描述 | 模式 |
|---|---|---|
|
matchExpressions | matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 | |
|
matchLabels | matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 | 字符串、字符串映射 |
matchExpressions
| Name | 描述 | 模式 |
|---|---|---|
|
key | key 是选择器应用到的标签键。 | 字符串 |
|
operator | 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 | 字符串 |
|
values | 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 | 字符串数组 |
secretRef
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 引用的 API 版本。 | 字符串 |
|
fieldPath | 如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的，且该字段在将来会有所改变。 | 字符串 |
|
kind | 引用的类型。更多信息： 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.6. Subscriptions API
1.6.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的订阅资源相关的 API 信息。订阅资源有 4 个可用的请求：create、query、delete 和 update。已弃用： PlacementRule
1.6.1.1. 版本信息
版本 : 2.9.0
1.6.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.6.1.3. Tags
- subscription.apps.open-cluster-management.io : 创建和管理订阅
1.6.2. 路径
1.6.2.1. 创建订阅
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions1.6.2.1.1. 描述
创建订阅
1.6.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的订阅的参数。 |
1.6.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.6.2.1.4. 使用
-
subscription/yaml
1.6.2.1.5. Tags
- subscriptions.apps.open-cluster-management.io
1.6.2.1.6. HTTP 请求示例
1.6.2.1.6.1. 请求正文
1.6.2.2. 查询所有订阅
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions1.6.2.2.1. 描述
查询您的订阅以获取更多详情。
1.6.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.6.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.6.2.2.4. 使用
-
subscription/yaml
1.6.2.2.5. Tags
- subscriptions.apps.open-cluster-management.io
1.6.2.3. 查询单个订阅
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}1.6.2.3.1. 描述
查询单个订阅以了解更多详情。
1.6.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| 路径 |
subscription_name | 要查询的订阅名称。 | 字符串 |
1.6.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.6.2.3.4. Tags
- subscriptions.apps.open-cluster-management.io
1.6.2.4. 创建一个订阅：
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}1.6.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| 路径 |
subscription_name | 要删除的订阅的名称。 | 字符串 |
1.6.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.6.2.4.3. Tags
- subscriptions.apps.open-cluster-management.io
1.6.3. 定义
1.6.3.1. Subscription
metadata
| Name | 模式 |
|---|---|
|
annotations | 对象 |
|
labels | 对象 |
|
name | 字符串 |
|
namespace | 字符串 |
spec
| Name | 模式 |
|---|---|
|
channel | 字符串 |
|
name | 字符串 |
|
overrides | overrides 数组 |
|
packageFilter | |
|
packageOverrides | |
|
placement | |
|
timewindow |
overrides
| Name | 模式 |
|---|---|
|
clusterName | 字符串 |
|
clusterOverrides | 对象数组 |
packageFilter
| Name | 描述 | 模式 |
|---|---|---|
|
annotations | 字符串、字符串映射 | |
|
filterRef | ||
|
labelSelector | ||
|
version |
Pattern : | 字符串 |
filterRef
| Name | 模式 |
|---|---|
|
name | 字符串 |
labelSelector
| Name | 模式 |
|---|---|
|
matchExpressions | |
|
matchLabels | 字符串、字符串映射 |
matchExpressions
| Name | 模式 |
|---|---|
|
key | 字符串 |
|
operator | 字符串 |
|
values | 字符串数组 |
packageOverrides
| Name | 模式 |
|---|---|
|
packageAlias | 字符串 |
|
packageName | 字符串 |
|
packageOverrides | 对象数组 |
placement
| Name | 模式 |
|---|---|
|
clusterSelector | |
|
clusters | clusters 数组 |
|
local | 布尔值 |
|
placementRef |
clusterSelector
| Name | 模式 |
|---|---|
|
matchExpressions | |
|
matchLabels | 字符串、字符串映射 |
matchExpressions
| Name | 模式 |
|---|---|
|
key | 字符串 |
|
operator | 字符串 |
|
values | 字符串数组 |
clusters
| Name | 模式 |
|---|---|
|
name | 字符串 |
placementRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
timewindow
| Name | 模式 |
|---|---|
|
daysofweek | 字符串数组 |
|
hours | hours 数组 |
|
location | 字符串 |
|
windowtype | enum（active、blocked、Active、Blocked） |
hours
| Name | 模式 |
|---|---|
|
end | 字符串 |
|
start | 字符串 |
status
| Name | 模式 |
|---|---|
|
lastUpdateTime | 字符串（date-time） |
|
message | 字符串 |
|
phase | 字符串 |
|
reason | 字符串 |
|
statuses | object |
1.7. PlacementRules API (已弃用)
1.7.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 PlacementRule 资源相关的 API 信息。PlacementRule 资源有 4 个可用的请求：create、query、delete 和 update。
1.7.1.1. 版本信息
版本 : 2.9.0
1.7.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.7.1.3. Tags
- placementrules.apps.open-cluster-management.io：创建和管理放置规则
1.7.2. 路径
1.7.2.1. 创建放置规则
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.7.2.1.1. 描述
创建放置规则。
1.7.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的放置规则的参数。 |
1.7.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.1.4. 使用
-
application/yaml
1.7.2.1.5. Tags
- placementrules.apps.open-cluster-management.io
1.7.2.1.6. HTTP 请求示例
1.7.2.1.6.1. 请求正文
1.7.2.2. 查询所有放置规则
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.7.2.2.1. 描述
查询放置规则以获取更多详细信息。
1.7.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.7.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.2.4. 使用
-
application/yaml
1.7.2.2.5. Tags
- placementrules.apps.open-cluster-management.io
1.7.2.3. 查询单个放置规则
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.7.2.3.1. 描述
查询单个放置规则以了解更多详细信息。
1.7.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| 路径 |
placementrule_name | 要查询的放置规则的名称。 | 字符串 |
1.7.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.3.4. Tags
- placementrules.apps.open-cluster-management.io
1.7.2.4. 删除放置规则
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.7.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| 路径 |
placementrule_name | 要删除的放置规则的名称。 | 字符串 |
1.7.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.4.3. Tags
- placementrules.apps.open-cluster-management.io
1.7.3. 定义
1.7.3.1. PlacementRule
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
kind | 字符串 |
|
metadata | 对象 |
|
spec |
spec
| Name | 模式 |
|---|---|
|
clusterConditions | |
|
clusterReplicas | 整数 |
|
clusterSelector | |
|
clusters | clusters 数组 |
|
policies | policies 数组 |
|
resourceHint | |
|
schedulerName | 字符串 |
clusterConditions
| Name | 模式 |
|---|---|
|
status | 字符串 |
|
type | 字符串 |
clusterSelector
| Name | 模式 |
|---|---|
|
matchExpressions | |
|
matchLabels | 字符串、字符串映射 |
matchExpressions
| Name | 模式 |
|---|---|
|
key | 字符串 |
|
operator | 字符串 |
|
values | 字符串数组 |
clusters
| Name | 模式 |
|---|---|
|
name | 字符串 |
policies
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
resourceHint
| Name | 模式 |
|---|---|
|
order | 字符串 |
|
type | 字符串 |
1.8. Applications API
1.8.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的应用程序资源相关的 API 信息。应用程序资源有 4 个可用的请求：create、query、delete 和 update。
1.8.1.1. 版本信息
版本 : 2.9.0
1.8.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.8.1.3. Tags
- Applications.app.k8s.io : 创建和管理应用程序
1.8.2. 路径
1.8.2.1. 创建应用程序
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications1.8.2.1.1. 描述
创建应用程序。
1.8.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的应用程序的参数。 |
1.8.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.8.2.1.4. 使用
-
application/yaml
1.8.2.1.5. Tags
- applications.app.k8s.io
1.8.2.1.6. HTTP 请求示例
1.8.2.1.6.1. 请求正文
1.8.2.2. 查询所有应用程序
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications1.8.2.2.1. 描述
查询您的应用程序以获取更多详情。
1.8.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.8.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.8.2.2.4. 使用
-
application/yaml
1.8.2.2.5. Tags
- applications.app.k8s.io
1.8.2.3. 查询单个应用程序
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}1.8.2.3.1. 描述
查询单个应用程序以获取更多详细信息。
1.8.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
application_name | 您要查询的应用程序的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.8.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.8.2.3.4. Tags
- applications.app.k8s.io
1.8.2.4. 删除应用程序
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}1.8.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
application_name | 要删除的应用程序的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.8.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.8.2.4.3. Tags
- applications.app.k8s.io
1.8.3. 定义
1.8.3.1. Application
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
kind | 字符串 |
|
metadata | 对象 |
|
spec |
spec
| Name | 模式 |
|---|---|
|
assemblyPhase | 字符串 |
|
componentKinds | 对象数组 |
|
descriptor | |
|
info | info 数组 |
|
selector | 对象 |
descriptor
| Name | 模式 |
|---|---|
|
description | 字符串 |
|
icons | icons 数组 |
|
keywords | 字符串数组 |
|
links | links 数组 |
|
maintainers | maintainers 数组 |
|
notes | 字符串 |
|
owners | owners 数组 |
|
type | 字符串 |
|
version | 字符串 |
icons
| Name | 模式 |
|---|---|
|
size | 字符串 |
|
src | 字符串 |
|
type | 字符串 |
links
| Name | 模式 |
|---|---|
|
description | 字符串 |
|
url | 字符串 |
maintainers
| Name | 模式 |
|---|---|
|
email | 字符串 |
|
name | 字符串 |
|
url | 字符串 |
owners
| Name | 模式 |
|---|---|
|
email | 字符串 |
|
name | 字符串 |
|
url | 字符串 |
info
| Name | 模式 |
|---|---|
|
name | 字符串 |
|
type | 字符串 |
|
value | 字符串 |
|
valueFrom |
valueFrom
| Name | 模式 |
|---|---|
|
configMapKeyRef | |
|
ingressRef | |
|
secretKeyRef | |
|
serviceRef | |
|
type | 字符串 |
configMapKeyRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
key | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
ingressRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
host | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
path | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
secretKeyRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
key | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
serviceRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
path | 字符串 |
|
port | integer (int32) |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
1.9. Helm API
1.9.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 HelmRelease 资源相关的 API 信息。HelmRelease 有 4 个可用的请求：create、query、delete 和 update。
1.9.1.1. 版本信息
版本 : 2.9.0
1.9.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.9.1.3. Tags
- helmreleases.apps.open-cluster-management.io : 创建和管理 helmreleases
1.9.2. 路径
1.9.2.1. 创建 helmrelease
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases1.9.2.1.1. 描述
创建 helmrelease。
1.9.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的 helmrelease 的参数。 |
1.9.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.9.2.1.4. 使用
-
application/yaml
1.9.2.1.5. Tags
- helmreleases.apps.open-cluster-management.io
1.9.2.1.6. HTTP 请求示例
1.9.2.1.6.1. 请求正文
1.9.2.2. 查询所有 helmreleases
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases1.9.2.2.1. 描述
查询您的 helmreleases 获取更多详细信息。
1.9.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.9.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.9.2.2.4. 使用
-
application/yaml
1.9.2.2.5. Tags
- helmreleases.apps.open-cluster-management.io
1.9.2.3. 查询单个 helmrelease
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}1.9.2.3.1. 描述
查询单个 helmrelease 获取更多详细信息。
1.9.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
helmrelease_name | 要查询的 helmrelease 的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.9.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.9.2.3.4. Tags
- helmreleases.apps.open-cluster-management.io
1.9.2.4. 删除 helmrelease
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}1.9.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
helmrelease_name | 要删除的 helmrelease 的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.9.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.9.2.4.3. Tags
- helmreleases.apps.open-cluster-management.io
1.9.3. 定义
1.9.3.1. HelmRelease
repo
| Name | 模式 |
|---|---|
|
chartName | 字符串 |
|
configMapRef | |
|
secretRef | |
|
source | |
|
version | 字符串 |
configMapRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
secretRef
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
fieldPath | 字符串 |
|
kind | 字符串 |
|
name | 字符串 |
|
namespace | 字符串 |
|
resourceVersion | 字符串 |
|
uid | 字符串 |
source
github
| Name | 模式 |
|---|---|
|
branch | 字符串 |
|
chartPath | 字符串 |
|
urls | 字符串数组 |
helmRepo
| Name | 模式 |
|---|---|
|
urls | 字符串数组 |
status
| Name | 模式 |
|---|---|
|
conditions | conditions 数组 |
|
deployedRelease |
conditions
| Name | 模式 |
|---|---|
|
lastTransitionTime | 字符串（date-time） |
|
message | 字符串 |
|
reason | 字符串 |
|
status | 字符串 |
|
type | 字符串 |
deployedRelease
| Name | 模式 |
|---|---|
|
manifest | 字符串 |
|
name | 字符串 |
1.10. Policy API
1.10.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的策略（Policy）资源相关的 API 信息。Policy 资源有 4 个可用的请求：create、query、delete 和 update。
1.10.1.1. 版本信息
版本 : 2.9.0
1.10.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.10.1.3. Tags
- policy.open-cluster-management.io/v1 : 创建和管理策略
1.10.2. 路径
1.10.2.1. 创建策略
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.10.2.1.1. 描述
创建策略
1.10.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建策略的参数。 |
1.10.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.10.2.1.4. 使用
-
application/json
1.10.2.1.5. Tags
- policy.open-cluster-management.io
1.10.2.1.6. HTTP 请求示例
1.10.2.1.6.1. 请求正文
1.10.2.2. 查询所有策略
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.10.2.2.1. 描述
查询您的策略以获得更详细的信息。
1.10.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要应用策略的命名空间，如 default。 | 字符串 |
1.10.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.10.2.2.4. 使用
-
application/json
1.10.2.2.5. Tags
- policy.open-cluster-management.io
1.10.2.3. 查询单个策略
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.10.2.3.1. 描述
查询单个策略以获取更多详细信息。
1.10.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
policy_name | 要查询的策略的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.10.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.10.2.3.4. Tags
- policy.open-cluster-management.io
1.10.2.4. 删除策略
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.10.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
policy_name | 要删除的策略名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.10.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.10.2.4.3. Tags
- policy.open-cluster-management.io
1.10.3. 定义
1.10.3.1. policy
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 策略的版本化模式（schema）。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义策略的规则。 | 对象 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
remediationAction | 代表资源中定义的处理违反情况的值。 | 字符串 |
|
namespaceSelector | 代表策略要应用到的命名空间的值。 | 字符串 |
policy-templates
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 策略的版本化模式（schema）。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义策略的规则。 | 对象 |
| complianceType | 用于列出必须被评估或应用到受管集群的角色的预期行为和任何 Kubernetes 对象。 | 字符串 |
|
metadataComplianceType |
为用户提供处理对象标签和注解的方式与其他字段不同。参数值默认为 | 字符串 |
| 定义标签的部分。 | 字符串 | |
|
rules | 字符串 |
clusterConditions
| Name | 描述 | 模式 |
|---|---|---|
|
matchLabels | 策略应用到一个命名空间所需的标签。 | 对象 |
|
cloud | 策略应用到一个云供应商所需的标签。 | 字符串 |
rules
| Name | 描述 | 模式 |
|---|---|---|
|
apiGroups | 适用于该规则的 API 列表。 | 字符串 |
|
resources | 资源类型列表。 | 对象 |
|
verbs | 动词列表。 | 字符串 |
1.11. Observability API
1.11.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 MultiClusterObservability 资源相关的 API 信息。MultiClusterObservability 资源有 4 个可用的请求：create、query、delete 和 update。
1.11.1.1. 版本信息
版本 : 2.9.0
1.11.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.11.1.3. Tags
- Observability.open-cluster-management.io : 创建和管理多集群的观察性
1.11.2. 路径
1.11.2.1. 创建 multiclusterobservability 资源
POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities1.11.2.1.1. 描述
创建 MultiClusterObservability 资源。
1.11.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 MultiClusterObservability 资源的参数。 |
1.11.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.1.4. 使用
-
application/yaml
1.11.2.1.5. Tags
- observability.apps.open-cluster-management.io
1.11.2.1.6. HTTP 请求示例
1.11.2.1.6.1. 请求正文
1.11.2.2. 查询所有 multiclusterobservabilities
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities1.11.2.2.1. 描述
查询 MultiClusterObservability 资源以获取更多详细信息。
1.11.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.11.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.2.4. 使用
-
application/yaml
1.11.2.2.5. Tags
- observability.apps.open-cluster-management.io
1.11.2.3. 查询单个 multiclusterobservability
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}1.11.2.3.1. 描述
查询单个 MultiClusterObservability 资源以获取更多详细信息。
1.11.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
multiclusterobservability_name | 要查询的 multiclusterobservability 的名称。 | 字符串 |
1.11.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.3.4. Tags
- observability.apps.open-cluster-management.io
1.11.2.4. 删除一个 multiclusterobservability 资源
DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}1.11.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
multiclusterobservability_name | 要删除的 multiclusterobservability 的名称。 | 字符串 |
1.11.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.4.3. Tags
- observability.apps.open-cluster-management.io
1.11.3. 定义
1.11.3.1. MultiClusterObservability
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 版本化的 MultiClusterObservability schema。 | 字符串 |
|
kind | 代表 REST 资源、MultiClusterObservability 的字符串值。 | 字符串 |
|
metadata | 描述定义策略的规则。 | 对象 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
enableDownsampling |
启用或禁用 downsample。默认值为 | 布尔值 |
|
imagePullPolicy |
MultiClusterObservability 镜像的 pull 策略。默认值为 | corev1.PullPolicy |
|
imagePullSecret |
MultiClusterObservability 镜像的 pull secret。默认值为 | 字符串 |
|
nodeSelector | 节点选择器规格。 | map[string]string |
|
observabilityAddonSpec | 所有安装了可观察附加组件的受管集群的全局设置。 | |
|
storageConfig | 指定可观察性要使用的存储配置。 | StorageConfig |
|
tolerations | 提供了所有组件可以容忍任何污点的功能。 | []corev1.Toleration |
|
advanced | 可观察性的高级配置设置。 | |
|
resources | MultiClusterObservability 所需的计算资源。 | corev1.ResourceRequirements |
|
replicas | MultiClusterObservability 副本。 | 整数 |
storageConfig
| Name | 描述 | 模式 |
|---|---|---|
|
alertmanagerStorageSize |
应用到 alertmanager 有状态集的存储量。默认值为 | 字符串 |
|
compactStorageSize |
应用于 thanos 紧凑有状态集合的存储量。默认值为 | 字符串 |
|
metricObjectStorage | 用于为指标配置 secret 的对象存储。 | |
|
receiveStorageSize |
应用到 thanos 接收有状态集的存储量。默认值为 | 字符串 |
|
ruleStorageSize |
应用到 thanos 规则有状态集的存储量。默认值为 | 字符串 |
|
storageClass |
指定 | 字符串 |
|
storeStorageSize |
应用到 thanos 存储有状态集合的存储量。默认值为 | 字符串 |
|
writeStorage | 端点访问信息列表。 | [ ]WriteStorage |
writeStorage
| Name | 描述 | 模式 |
|---|---|---|
|
name | 带有端点访问信息的 secret 名称。 | 字符串 |
|
key | 要从中选择的 secret 的密钥。 | 字符串 |
metricObjectStorage
| Name | 描述 | 模式 |
|---|---|---|
|
key | 要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。请参阅 Thanos 文档。 | 字符串 |
|
name |
| 字符串 |
observabilityAddonSpec
| Name | 描述 | 模式 |
|---|---|---|
|
enableMetrics |
指示 Observability 附加组件是否将指标发送到 hub 集群。默认值为 | 布尔值 |
|
interval |
Observability 附加组件将指标发送到 hub 集群的间隔。默认值为 300 秒 ( | 整数 |
|
resources |
指标收集器资源要求的资源。默认 CPU 请求为 | corev1.ResourceRequirements |
advanced
| Name | 描述 | 模式 |
|---|---|---|
|
retentionConfig | 指定供可观察性使用的数据保留配置。 |
|
|
rbacQueryProxy | 指定 rbac-query-proxy 部署的副本和资源。 | CommonSpec |
|
grafana | 指定 grafana 部署的副本和资源 | CommonSpec |
|
alertmanager | 指定 alertmanager statefulset 的副本和资源。 | CommonSpec |
|
observatoriumAPI |
指定 | CommonSpec |
|
queryFrontend | 为 query-frontend 部署指定副本和资源。 | CommonSpec |
|
query | 指定查询部署的副本和资源。 | CommonSpec |
|
receive | 指定接收 statefulset 的副本和资源。 | CommonSpec |
|
rule | 指定规则 statefulset 的副本和资源。 | CommonSpec |
|
store | 指定存储 statefulset 的副本和资源。 | CommonSpec |
|
CompactSpec | 指定紧凑 statefulset 的资源。 | |
|
storeMemcached | 指定 store-memcached 的副本、资源等。 | |
|
queryFrontendMemcached | 指定 query-frontend-memcached 的副本、资源等。 | CacheConfig |
retentionConfig
| Name | 描述 | 模式 |
|---|---|---|
|
blockDuration |
阻塞时间序列数据库（TSDB）块持续时间的时间长度。默认值为 | 字符串 |
|
cleanupInterval |
清理部分上传块的频率，以及清理启用了 | 字符串 |
|
deleteDelay |
从存储桶中删除标记要删除的块前的时间。默认值为 | 字符串 |
|
retentionInLocal |
从本地存储保留原始样本的时间长度。默认值为 | 字符串 |
|
retentionResolutionRaw |
在存储桶中保留原始分辨率样本的时间。默认值为 30 天（ | 字符串 |
|
retentionResolution5m |
在存储桶中保留分辨率 1 样本（5 分钟）的时间长度。默认值为 180 天（ | 字符串 |
|
retentionResolution1h |
在存储桶中保留分辨率 2 样本（1 小时）的时间长度。默认值为 0 天（ | 字符串 |
CompactSpec
| Name | 描述 | 模式 |
|---|---|---|
|
resources | thanos 紧凑所需的计算资源。 | corev1.ResourceRequirements |
|
serviceAccountAnnotations | annotations 是一个无结构的键值映射，它存储有紧凑的服务帐户。 | map[string]string |
storeMemcached
| Name | 描述 | 模式 |
|---|---|---|
|
resources | MultiCLusterObservability 所需的计算资源. | corev1.ResourceRequirements |
|
replicas | MultiClusterObservability 副本。 | 整数 |
|
memoryLimitMb | 以 MB 为单位的 Memcached 内存限值。 | 整数 |
|
maxItemSize |
Memcached 的最大项目大小。默认值为 | 字符串 |
|
connectionLimit | Memcached 同时连接数上限。默认值为 | 整数 |
status
| Name | 描述 | 模式 |
|---|---|---|
|
status | status 包含 MultiClusterObservability 的不同条件状态。 | metav1.Condition |
CommonSpec
| Name | 描述 | 模式 |
|---|---|---|
|
resources | 组件所需的计算资源。 | corev1.ResourceRequirements |
|
replicas | 组件的副本。 | 整数 |
QuerySpec
| Name | 描述 | 模式 |
|
CommonSpec | 指定查询部署的副本和资源。 | CommonSpec |
|
serviceAccountAnnotations | annotations 是一个无结构的键值映射，它会与查询服务帐户存储。 | map[string]string |
ReceiveSpec
| Name | 描述 | 模式 |
|
CommonSpec | 指定查询部署的副本和资源。 | CommonSpec |
|
serviceAccountAnnotations | annotations 是一个无结构的键值映射，它会与查询服务帐户存储。 | map[string]string |
StoreSpec
| Name | 描述 | 模式 |
|
CommonSpec | 指定查询部署的副本和资源。 | CommonSpec |
|
serviceAccountAnnotations | annotations 是一个无结构的键值映射，它会与查询服务帐户存储。 | map[string]string |
RuleSpec
| Name | 描述 | 模式 |
|
CommonSpec | 指定查询部署的副本和资源。 | CommonSpec |
|
evalInterval | 指定规则的评估间隔。 | 字符串 |
|
serviceAccountAnnotations | annotations 是一个无结构的键值映射，它会与查询服务帐户存储。 | map[string]string |
1.12. 搜索查询 API
搜索查询 API 不是 Kubernetes API，因此无法通过 Red Hat OpenShift Container Platform API Explorer 显示。继续阅读以了解搜索查询 API 功能。
1.12.1. 概述
您可以使用路由公开搜索查询 API，并使用 API 解析搜索查询。API 是一个 GraphQL 端点。您可以使用任何客户端，如 curl 或 Postman。
1.12.1.1. 版本信息
版本 : 2.9.0
1.12.1.2. URI scheme
basePath : /searchapi/graphql
Schemes : HTTPS
1.12.1.3. 配置 API 访问
使用以下命令，创建路由以访问集群外部的搜索 API：
oc create route passthrough search-api --service=search-search-api -n open-cluster-management
oc create route passthrough search-api --service=search-search-api -n open-cluster-management重要： 您必须配置路由来保护您的环境。如需了解更多详细信息，请参阅 OpenShift Container Platform 文档中的 Route 配置。
1.12.2. 模式设计
带有 ! 的参数表示需要字段。
1.12.2.1. 查询输入的描述表
| 类型 | 描述 | 属性 |
|---|---|---|
| SearchFilter | 定义用于过滤结果的键和值。当您为属性提供多个值时，API 会将值解释为"OR"操作。当您提供多个过滤器时，结果会匹配所有过滤器，API 会解释为"AND"操作。 | 字符串 |
| SearchInput | 输入关键字以接收资源列表。当您提供许多关键字时，API 会将它解析为"AND"操作。 | 字符串 |
| limit |
确定输入查询后返回的最大结果数。默认值为 | 整数 |
1.12.2.2. 模式示例
1.12.3. 通用模式
1.12.4. 支持的查询
继续读取以查看 JSON 格式支持的查询类型。
1.12.4.1. 搜索部署
query：
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}变量：
1.12.4.2. 搜索 pod
query：
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}变量：
1.13. MultiClusterHub API
1.13.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 MultiClusterHub 资源相关的 API 信息。MultiClusterHub 资源有 4 个可用的请求：create、query、delete 和 update。
1.13.1.1. 版本信息
版本 : 2.9.0
1.13.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.13.1.3. Tags
- multiclusterhubs.operator.open-cluster-management.io : 创建和管理多集群 hub operator
1.13.2. 路径
1.13.2.1. 创建 MultiClusterHub 资源
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch1.13.2.1.1. 描述
创建一个 MultiClusterHub 资源来定义 multicluster hub 实例的配置。
1.13.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的 multicluster hub 的参数。 |
1.13.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.13.2.1.4. 使用
-
multiclusterhubs/yaml
1.13.2.1.5. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.2.1.6. HTTP 请求示例
1.13.2.1.6.1. 请求正文
1.13.2.2. 查询所有 MultiClusterHubs
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator1.13.2.2.1. 描述
查询您的 multicluster hub operator 以获取更多详细信息。
1.13.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.13.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.13.2.2.4. 使用
-
operator/yaml
1.13.2.2.5. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.2.3. 查询 MultiClusterHub operator
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}1.13.2.3.1. 描述
查询单个 multicluster hub operator 以获取更多详细信息。
1.13.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
application_name | 您要查询的应用程序的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.13.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.13.2.3.4. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.2.4. 删除 MultiClusterHub operator
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}1.13.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
application_name | 要删除的 multicluster hub Operator 的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.13.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.13.2.4.3. Tags
- multiclusterhubs.operator.open-cluster-management.io
1.13.3. 定义
1.13.3.1. multicluster hub operator
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | MultiClusterHub 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义资源的规则。 | 对象 |
|
spec | 资源规格。 |
spec
| availabilityConfig 可选 | 指定部署复制以提高可用性。默认值为 High。 | 字符串 |
|---|---|---|
|
customCAConfigmap | 为 Red Hat Advanced Cluster Management 提供自定义的 OpenShift 默认入口 CA 证书。 | 字符串 |
|
disableHubSelfManagement | 禁用自动导入 hub 集群作为受管集群。 | 布尔值 |
|
disableUpdateClusterImageSets | 禁用 ClusterImageSets 的自动更新。 | 布尔值 |
|
hive | （已弃用）用于覆盖默认 HiveConfig 规格的对象。 | |
|
imagePullSecret | 覆盖用于访问 MultiClusterHub 操作对象和端点镜像的 pull secret。 | 字符串 |
|
ingress | 入口管理的配置选项。 | |
|
nodeSelector | 设置节点选择器。 | 字符串 |
|
separateCertificateManagement |
（已弃用）将 | 布尔值 |
hive
| additionalCertificateAuthorities 可选 | （已弃用）到 hive 命名空间中的 secret 的引用列表，它包含了在与目标集群通信时要使用的额外证书颁发机构（CA）。除了安装时每个集群生成的任何自签名 CA 外，这些证书颁发机构也被使用。 | 对象 |
|---|---|---|
|
backup | （已弃用）指定备份集成的配置。如果没有，则禁用备份集成。 | |
|
externalDNS |
（已弃用）如果要由 Hive 部署，指定 | 对象 |
|
failedProvisionConfig | （已弃用）用于配置与处理调配失败相关的设置。 | |
|
globalPullSecret |
（已弃用）用于指定供所有集群部署全局使用的 pull secret。对于每个集群部署， | 对象 |
|
maintenanceMode |
（已弃用）在您需要确保没有运行任何会在 Hive 类型的 finalizer 上进行添加或操作时，可以使用它来禁用 hive 控制器。这应该很少需要。将 | 布尔值 |
ingress
| sslCiphers 可选 | 为管理入口启用的 SSL 密码列表。默认为所支持密码的完整列表。 | 字符串 |
|---|
backup
| minBackupPeriodSeconds 可选 | （已弃用）指定在每个备份之间的最小 MinBackupPeriodSeconds 。这用于对备份进行比率限制。这可能会将多个更改组合到一个备份中。因为在这一时间段内发生的更改会被放入排队，在备份间隔时间后这些队列中的更改会被备份，因此不会丢失备份数据。 | 整数 |
|---|---|---|
|
velero | （已弃用）Velero 指定 Velero 备份集成的配置。 | 对象 |
failedProvisionConfig
| skipGatherLogs 可选 | （已弃用）当安装因为任何原因失败时，禁用尝试从集群收集完整日志的功能。日志会存储在持久卷中，并最多存储七天。 | 布尔值 |
|---|
status
| components 可选 | 状态配置的组件。 | 对象 |
|---|---|---|
|
conditions | 包含 multicluster hub 的不同条件。 | |
|
desiredVersion | 表示所需的版本。 | 字符串 |
|
phase |
代表 MultiClusterHub 资源的活跃阶段。用于此参数的值包括： | 字符串 |
conditions
| lastTransitionTime 可选 | 条件从一个状态变为另一个状态的最后一次的时间。 | 字符串 |
|---|---|---|
|
lastUpdateTime | 最后一次更新此条件的时间。 | 字符串 |
|
message | Message 是人类可读的消息，表示关于上次状态更改的详细信息。 | 字符串 |
|
reason | 条件发生状态更改的原因。 | 字符串 |
|
status | 条件的状态。 | 字符串 |
|
type | 集群条件的类型。 | 字符串 |
StatusConditions
| kind 必需 | 代表此状态的资源 kind。 | 字符串 |
|---|---|---|
|
available | 指明此组件是否在正确运行。 | 布尔值 |
|
lastTransitionTime | 条件从一个状态变为另一个状态的最后一次的时间。 | metav1.time |
|
lastUpdateTime | 最后一次更新此条件的时间。 | metav1.time |
|
message | Message 是人类可读的消息，表示关于上次状态更改的详细信息。 | 字符串 |
|
reason | 条件发生状态更改的原因。 | 字符串 |
|
status | 条件的状态。 | 字符串 |
|
type | 集群条件的类型。 | 字符串 |
1.14. 放置 API (v1beta1)
1.14.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.14.1.1. 版本信息
版本 : 2.9.0
1.14.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.14.1.3. Tags
- cluster.open-cluster-management.io：创建和管理放置
1.14.2. 路径
1.14.2.1. 查询所有放置
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement1.14.2.1.1. 描述
查询您的放置以获取更多详细信息。
1.14.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.14.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.14.2.1.4. 使用
-
placement/yaml
1.14.2.1.5. Tags
- cluster.open-cluster-management.io
1.14.2.2. 创建一个放置
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements1.14.2.2.1. 描述
创建一个放置。
1.14.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的放置绑定的参数。 |
1.14.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.14.2.2.4. 使用
-
placement/yaml
1.14.2.2.5. Tags
- cluster.open-cluster-management.io
1.14.2.2.6. HTTP 请求示例
1.14.2.2.6.1. 请求正文
1.14.2.3. 查询单个放置
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}1.14.2.3.1. 描述
查询单个放置以获取更多详细信息。
1.14.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
placement_name | 要查询的放置名称。 | 字符串 |
1.14.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.14.2.3.4. Tags
- cluster.open-cluster-management.io
1.14.2.4. 删除一个放置
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}1.14.2.4.1. 描述
删除一个放置。
1.14.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
placement_name | 要删除的放置名称。 | 字符串 |
1.14.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.14.2.4.4. Tags
- cluster.open-cluster-management.io
1.14.3. 定义
1.14.3.1. Placement
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 放置的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 放置的元数据。 | 对象 |
|
spec | 放置的规格。 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
clusterSets |
从中选择 | 字符串数组 |
|
numberOfClusters |
要选择的 | integer (int32) |
|
predicates |
选择 | |
|
prioritizerPolicy | 优先级器的策略。 | |
|
tolerations | 允许但不是必需的值，通过放置具有匹配容限的放置来选择具有特定污点的受管集群。 | 容限数组 |
clusterPredicate
| Name | 描述 | 模式 |
|---|---|---|
|
requiredClusterSelector |
选择带有标签和集群声明的 |
clusterSelector
| Name | 描述 | 模式 |
|---|---|---|
|
labelSelector |
按标签的 | 对象 |
|
claimSelector |
按声明的 |
clusterClaimSelector
| Name | 描述 | 模式 |
|---|---|---|
|
matchExpressions | 集群声明选择器要求的子集。条件逻辑是 AND。 | < object > 数组 |
prioritizerPolicy
| Name | 描述 | 模式 |
|---|---|---|
|
mode |
| 字符串 |
|
configurations | 配置优先级。 |
prioritizerConfig
| Name | 描述 | 模式 |
|---|---|---|
|
scoreCoordinate | 配置优先级和分数源。 | |
|
weight | 优先级分数的权重。该值的范围： [-10,10]。 | int32 |
scoreCoordinate
| Name | 描述 | 模式 |
|---|---|---|
|
type | 优先级分数的类型。有效值为 "BuiltIn" 或 "AddOn"。 | 字符串 |
|
builtIn |
来自以下选项的 | 字符串 |
|
addOn |
当类型为 | 对象 |
容限 (tolerations)
| Name | 描述 | 模式 |
|---|---|---|
|
key | 容限应用到的污点键。空表示与所有污点键匹配。 | 字符串 |
|
operator |
键与值的关系。有效的运算符为 | 字符串 |
|
value | 匹配容限的污点值。 | 字符串 |
|
effect |
要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值是 | 字符串 |
|
tolerationSeconds | 容许污点的时间长度，之后污点不会被容许。默认值为 nil，这表示污点的容许时间没有时间限制。 | int64 |
1.15. PlacementDecisions API (v1beta1)
1.15.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.15.1.1. 版本信息
版本 : 2.9.0
1.15.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.15.1.3. Tags
- cluster.open-cluster-management.io：创建和管理放置Decisions。
1.15.2. 路径
1.15.2.1. 查询所有 PlacementDecisions
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions1.15.2.1.1. 描述
查询您的 PlacementDecisions 获取更多详细信息。
1.15.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.15.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.15.2.1.4. 使用
-
placementdecision/yaml
1.15.2.1.5. Tags
- cluster.open-cluster-management.io
1.15.2.2. 创建 PlacementDecision
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions1.15.2.2.1. 描述
创建 PlacementDecision。
1.15.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 PlacementDecision 的参数。 |
1.15.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.15.2.2.4. 使用
-
placementdecision/yaml
1.15.2.2.5. Tags
- cluster.open-cluster-management.io
1.15.2.2.6. HTTP 请求示例
1.15.2.2.6.1. 请求正文
1.15.2.3. 查询单个 PlacementDecision
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}1.15.2.3.1. 描述
查询单个 PlacementDecision 获取更多详细信息。
1.15.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
placementdecision_name | 要查询的 PlacementDecision 的名称。 | 字符串 |
1.15.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.15.2.3.4. Tags
- cluster.open-cluster-management.io
1.15.2.4. 删除 PlacementDecision
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}1.15.2.4.1. 描述
删除单个 PlacementDecision。
1.15.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
placementdecision_name | 要删除的 PlacementDecision 的名称。 | 字符串 |
1.15.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.15.2.4.4. Tags
- cluster.open-cluster-management.io
1.15.3. 定义
1.15.3.1. PlacementDecision
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion |
| 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata |
| 对象 |
|
status |
|
PlacementStatus
| Name | 描述 | 模式 |
|---|---|---|
|
Decisions | 根据放置的决策分片。 |
ClusterDecision
| Name | 描述 | 模式 |
|---|---|---|
|
clusterName |
| 字符串 |
|
reason |
选择 | 字符串 |
1.16. DiscoveryConfig API
1.16.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 DiscoveryConfig 资源相关的 API 信息。DiscoveryConfig 资源有 4 个可用的请求：create、query、delete 和 update。
1.16.1.1. 版本信息
版本 : 2.9.0
1.16.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.16.1.3. Tags
- discoveryconfigs.discovery.open-cluster-management.io : 创建和管理 DiscoveryConfigs
1.16.2. 路径
1.16.2.1. 创建 DiscoveryConfig
POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs
POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs1.16.2.1.1. 描述
创建 DiscoveryConfig。
1.16.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的 DiscoveryConfig 的参数。 | DiscoveryConfig |
1.16.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.16.2.1.4. 使用
-
discoveryconfigs/yaml
1.16.2.1.5. Tags
- discoveryconfigs.discovery.open-cluster-management.io
1.16.2.1.5.1. 请求正文
1.16.2.2. 查询所有 DiscoveryConfigs
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator1.16.2.2.1. 描述
查询发现配置 operator 以获取更多详细信息。
1.16.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.16.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.16.2.2.4. 使用
-
operator/yaml
1.16.2.2.5. Tags
- discoveryconfigs.discovery.open-cluster-management.io
1.16.2.3. 删除 DiscoveryConfig Operator
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}1.16.2.3.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
application_name | 要删除的 Discovery Config operator 的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.16.2.3.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.16.2.3.3. Tags
- discoveryconfigs.operator.open-cluster-management.io
1.16.3. 定义
1.16.3.1. DiscoveryConfig
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | discoveryconfig 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义资源的规则。 | 对象 |
|
spec | 定义 DiscoveryConfig 所需的状态。 | 请参阅 specs 列表 |
1.16.3.2. specs 列表
| Name | 描述 | 模式 |
|---|---|---|
|
credential | 凭据是包含代表用户连接到 OCM API 的凭证的 secret。 | 字符串 |
|
filters | 对要发现的集群类型设置限制。 | 请参阅过滤器列表 |
1.16.3.3. 过滤器列表
| Name | 描述 | 模式 |
|---|---|---|
|
lastActive | lastActive 是集群中要发现的最新活跃天数的集群，由活动时间戳决定。 | 整数 |
|
openShiftVersions | OpenShiftVersions 是 OpenShift 的发行版本列表，格式为 "<Major>.<Minor>" | 对象 |
1.17. DiscoveredCluster API
1.17.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 DiscoveredCluster 资源相关的 API 资源。DiscoveredCluster 资源有 4 个可用的请求：create、query、delete 和 update。
1.17.1.1. 版本信息
版本 : 2.9.0
1.17.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.17.1.3. Tags
- DiscoveredClusters.discovery.open-cluster-management.io : 创建和管理 DiscoveredClusters
1.17.2. 路径
1.17.2.1. 创建一个 DiscoveredCluster
POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters
POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters1.17.2.1.1. 描述
创建一个 DiscoveredCluster。
1.17.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建的 DiscoveredCluster 的参数。 | DiscoveredCluster |
1.17.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.17.2.1.4. 使用
-
discoveredclusters/yaml
1.17.2.1.5. Tags
- discoveredclusters.discovery.open-cluster-management.io
1.17.2.1.5.1. 请求正文
1.17.2.2. 查询所有 DiscoveredClusters
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator1.17.2.2.1. 描述
查询发现的集群 operator 以获取更多详细信息。
1.17.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.17.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.17.2.2.4. 使用
-
operator/yaml
1.17.2.2.5. Tags
- discoveredclusters.discovery.open-cluster-management.io
1.17.2.3. 删除 DiscoveredCluster Operator
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}1.17.2.3.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
application_name | 要删除的发现的 Cluster Operator 的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.17.2.3.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.17.2.3.3. Tags
- discoveredclusters.operator.open-cluster-management.io
1.17.3. 定义
1.17.3.1. DiscoveredCluster
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 发现集群的版本化 schema。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义资源的规则。 | 对象 |
|
spec | DiscoveredClusterSpec 定义所需的 DiscoveredCluster 状态。 | 请参阅 specs 列表 |
1.17.3.2. specs 列表
| 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.18. AddOnDeploymentConfig API (v1alpha1)
1.18.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 AddOnDeploymentConfig 资源相关的 API 信息。AddOnDeploymentConfig 资源有 4 个可用的请求：create、query、delete 和 update。AddOnDeploymentConfig 代表附加组件的部署配置。
1.18.1.1. 版本信息
版本 : 2.9.0
1.18.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.18.1.3. Tags
- addon.open-cluster-management.io：创建和管理 AddOnDeploymentConfig
1.18.2. 路径
1.18.2.1. 查询所有 AddOnDeploymentConfig
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs1.18.2.1.1. 描述
查询您的 AddOnDeploymentConfig 以获取更多详细信息。
1.18.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.18.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.18.2.1.4. 使用
-
addondeploymentconfig/yaml
1.18.2.1.5. Tags
- addon.open-cluster-management.io
1.18.2.2. 创建 AddOnDeploymentConfig
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs1.18.2.2.1. 描述
创建 AddOnDeploymentConfig。
1.18.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 AddOnDeploymentConfig 绑定的参数。 |
1.18.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.18.2.2.4. 使用
-
addondeploymentconfig/yaml
1.18.2.2.5. Tags
- addon.open-cluster-management.io
1.18.2.2.6. HTTP 请求示例
1.18.2.2.6.1. 请求正文
1.18.2.3. 查询单个 AddOnDeploymentConfig
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}1.18.2.3.1. 描述
查询单个 AddOnDeploymentConfig 获取更多详细信息。
1.18.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
addondeploymentconfig_name | 要查询的 AddOnDeploymentConfig 的名称。 | 字符串 |
1.18.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.18.2.3.4. Tags
- addon.open-cluster-management.io
1.18.2.4. 删除 AddOnDeploymentConfig
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}1.18.2.4.1. 描述
删除单个 AddOnDeploymentConfig。
1.18.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
addondeploymentconfig_name | 要删除的 AddOnDeploymentConfig 的名称。 | 字符串 |
1.18.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.18.2.4.4. Tags
- addon.open-cluster-management.io
1.18.3. 定义
1.18.3.1. AddOnDeploymentConfig
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | AddOnDeploymentConfig 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | AddOnDeploymentConfig 的元数据。 | object |
|
spec | AddOnDeploymentConfig 的规格。 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
customizedVariables | 当前附加组件部署的 name-value 变量列表。附加组件实施可以使用这些变量呈现其附加组件部署。 | |
|
nodePlacement | 启用对受管集群中附加组件代理调度的显式控制。 |
customizedVariable
| Name | 描述 | 模式 |
|---|---|---|
|
name | 此变量的名称。 | 字符串 |
|
value | 此变量的值。 | 字符串 |
nodePlacement
| Name | 描述 | 模式 |
|---|---|---|
|
nodeSelector |
定义 pod 调度到运行的节点。当 | map[string]string |
|
tolerations |
应用到 pod，并使用匹配的运算符( | []corev1.Toleration |
1.19. ClusterManagementAddOn API (v1alpha1)
1.19.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ClusterManagementAddOn 资源相关的 API 信息。ClusterManagementAddOn 资源有 4 个可用的请求：create、query、delete 和 update。
ClusterManagementAddOn 代表集群管理器的附加组件注册。此资源允许用户发现哪些附加组件可用于集群管理器，并提供有关附加组件的元数据信息。此资源还提供对 ManagedClusterAddOn 的引用，即用于命名空间范围的 ManagedClusterAddOn 资源的 ClusterManagementAddOn 资源的名称。ClusterManagementAddOn 是一个集群范围的资源。
1.19.1.1. 版本信息
版本 : 2.9.0
1.19.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.19.1.3. Tags
- addon.open-cluster-management.io：创建和管理 ClusterManagementAddOns
1.19.2. 路径
1.19.2.1. 查询所有 ClusterManagementAddOns
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons1.19.2.1.1. 描述
查询 ClusterManagementAddOns 获取更多详细信息。
1.19.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.19.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.1.4. 使用
-
clustermanagementaddon/yaml
1.19.2.1.5. Tags
- addon.open-cluster-management.io
1.19.2.2. 创建 ClusterManagementAddOn
POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons1.19.2.2.1. 描述
创建 ClusterManagementAddOn。
1.19.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 ClusterManagementAddon 绑定的参数。 |
1.19.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.2.4. 使用
-
clustermanagementaddon/yaml
1.19.2.2.5. Tags
- addon.open-cluster-management.io
1.19.2.2.6. HTTP 请求示例
1.19.2.2.6.1. 请求正文
1.19.2.3. 查询单个 ClusterManagementAddOn
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}1.19.2.3.1. 描述
查询单个 ClusterManagementAddOn 获取更多详细信息。
1.19.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clustermanagementaddon_name | 要查询的 ClusterManagementAddOn 的名称。 | 字符串 |
1.19.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.3.4. Tags
- addon.open-cluster-management.io
1.19.2.4. 删除 ClusterManagementAddOn
DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}1.19.2.4.1. 描述
删除单个 ClusterManagementAddOn。
1.19.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clustermanagementaddon_name | 要删除的 ClusterManagementAddOn 的名称。 | 字符串 |
1.19.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.4.4. Tags
- addon.open-cluster-management.io
1.19.3. 定义
1.19.3.1. ClusterManagementAddOn
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | ClusterManagementAddOn 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | ClusterManagementAddOn 的元数据。 | object |
|
spec | ClusterManagementAddOn 的规格。 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
addOnMeta | AddOnMeta 是对附加组件的元数据信息的引用。 | |
|
supportedConfigs | SupportedConfigs 是附加组件支持的配置类型列表。 | configMeta 数组 |
addOnMeta
| Name | 描述 | 模式 |
|---|---|---|
|
displayName | 表示显示的附加组件名称。 | 字符串 |
|
description | 代表附加组件的详细描述。 | 字符串 |
configMeta
| Name | 描述 | 模式 |
|---|---|---|
|
group | 附加组件配置的组。 | 字符串 |
|
resource | 附加组件配置的资源。 | 字符串 |
|
defaultConfig | 代表默认附加组件配置的命名空间和名称。这是所有附加组件都有相同的配置的位置。 |
configReferent
| Name | 描述 | 模式 |
|---|---|---|
|
namespace | 附加组件配置的命名空间。如果没有设置此字段，则配置是 cluster-scope。 | 字符串 |
|
name | 附加组件配置的名称。 | 字符串 |
1.20. ManagedClusterAddOn API (v1alpha1)
1.20.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ManagedClusterAddOn 资源相关的 API 信息。ManagedClusterAddOn 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterAddOn 是包含附加组件当前状态的自定义资源对象。此资源应该在 ManagedCluster 命名空间中创建。
1.20.1.1. 版本信息
版本 : 2.9.0
1.20.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.20.1.3. Tags
- addon.open-cluster-management.io：创建和管理 ManagedClusterAddOns
1.20.2. 路径
1.20.2.1. 查询所有 ManagedClusterAddOns
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons1.20.2.1.1. 描述
查询 ManagedClusterAddOns 获取更多详细信息。
1.20.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.20.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.20.2.1.4. 使用
-
managedclusteraddon/yaml
1.20.2.1.5. Tags
- addon.open-cluster-management.io
1.20.2.2. 创建 ManagedClusterAddOn
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons1.20.2.2.1. 描述
创建 ManagedClusterAddOn。
1.20.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 ManagedClusterAddOn 绑定的参数。 |
1.20.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.20.2.2.4. 使用
-
managedclusteraddon/yaml
1.20.2.2.5. Tags
- addon.open-cluster-management.io
1.20.2.2.6. HTTP 请求示例
1.20.2.2.6.1. 请求正文
1.20.2.3. 查询单个 ManagedClusterAddOn
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}1.20.2.3.1. 描述
查询单个 ManagedClusterAddOn 获取更多详细信息。
1.20.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
managedclusteraddon_name | 要查询的 ManagedClusterAddOn 的名称。 | 字符串 |
1.20.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.20.2.3.4. Tags
- addon.open-cluster-management.io
1.20.2.4. 删除 ManagedClusterAddOn
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}1.20.2.4.1. 描述
删除单个 ManagedClusterAddOn。
1.20.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
managedclusteraddon_name | 要删除的 ManagedClusterAddOn 的名称。 | 字符串 |
1.20.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.20.2.4.4. Tags
- addon.open-cluster-management.io
1.20.3. 定义
1.20.3.1. ManagedClusterAddOn
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | ManagedClusterAddOn 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | ManagedClusterAddOn 的元数据。 | object |
|
spec | ManagedClusterAddOn 的规格。 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
installNamespace | 受管集群上的命名空间，用于安装附加组件代理。如果没有设置，则使用 open-cluster-management-agent-addon 命名空间来安装附加组件代理。 | 字符串 |
|
configs | 当前附加组件有其自身配置的附加组件配置列表。 | addOnConfig 数组 |
addOnConfig
| Name | 描述 | 模式 |
|---|---|---|
|
group | 附加组件配置的组。 | 字符串 |
|
resource | 附加组件配置的资源。 | 字符串 |
|
namespace | 附加组件配置的命名空间。如果没有设置此字段，则配置是 cluster-scope。 | 字符串 |
|
name | 附加组件配置的名称。 | 字符串 |
1.21. ManagedClusterSet API (v1beta2)
1.21.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ManagedClusterSet 资源相关的 API 信息。ManagedClusterSet 资源有 4 个可用的请求：create、query、delete 和 update。ManagedClusterSet 将两个或多个受管集群分组到可一起工作的集合。属于集合的受管集群可以有类似的属性，如共享使用目的或同一部署区域。
1.21.1.1. 版本信息
版本 : 2.9.0
1.21.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.21.1.3. Tags
- cluster.open-cluster-management.io : 创建和管理 ManagedClusterSets
1.21.2. 路径
1.21.2.1. 查询所有 managedclustersets
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets1.21.2.1.1. 描述
查询 managedclustersets 以获取更多详细信息。
1.21.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.21.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.21.2.1.4. 使用
-
managedclusterset/yaml
1.21.2.1.5. Tags
- cluster.open-cluster-management.io
1.21.2.2. 创建 managedclusterset
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets1.21.2.2.1. 描述
创建 managedclusterset.
1.21.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace |
要使用的命名空间，如 | 字符串 |
| Body |
body | 描述要创建的 managedclusterset 的参数。 |
1.21.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.21.2.2.4. 使用
-
managedclusterset/yaml
1.21.2.2.5. Tags
- cluster.open-cluster-management.io
1.21.2.2.6. HTTP 请求示例
1.21.2.2.6.1. 请求正文
1.21.2.3. 查询单个 managedclusterset
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets/{managedclusterset_name}
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets/{managedclusterset_name}1.21.2.3.1. 描述
查询单个 managedclusterset 获取更多详细信息。
1.21.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace |
要使用的命名空间，如 | 字符串 |
| 路径 |
managedclusterset_name | 要查询的 managedclusterset 的名称。 | 字符串 |
1.21.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.21.2.3.4. Tags
- cluster.open-cluster-management.io
1.21.2.4. 删除 managedclusterset
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{managedclusterset_name}
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{managedclusterset_name}1.21.2.4.1. 描述
删除单个 managedclusterset
1.21.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace |
要使用的命名空间，如 | 字符串 |
| 路径 |
managedclusterset_name | 要删除的 managedclusterset 的名称。 | 字符串 |
1.21.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.21.2.4.4. Tags
- cluster.open-cluster-management.io
1.21.3. 定义
1.21.3.1. ManagedClusterSet
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion |
| 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata |
| object |
| spec必需 |
| spec |
1.22. KlusterletConfig API (v1alpha1)
1.22.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.22.1.1. 版本信息
版本 : 2.9.0
1.22.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.22.1.3. Tags
- config.open-cluster-management.io : 创建和管理 KlusterletConfig
1.22.2. 路径
1.22.2.1. 查询所有 KlusterletConfig
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs1.22.2.1.1. 描述
查询 KlusterletConfigs 以获取更多详细信息。
1.22.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.22.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.22.2.1.4. 使用
-
klusterletconfig/yaml
1.22.2.1.5. Tags
- config.open-cluster-management.io
1.22.2.2. 创建 KlusterletConfig
POST /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs
POST /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs1.22.2.2.1. 描述
创建 KlusterletConfig。
1.22.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 KlusterletConfig 绑定的参数。 |
1.22.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.22.2.2.4. 使用
-
klusterletconfig/yaml
1.22.2.2.5. Tags
- config.open-cluster-management.io
1.22.2.2.6. HTTP 请求示例
1.22.2.2.6.1. 请求正文
1.22.2.3. 查询单个 KlusterletConfig
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}1.22.2.3.1. 描述
查询单个 KlusterletConfig 获取更多详细信息。
1.22.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
klusterletconfig_name | 要查询的 KlusterletConfig 的名称。 | 字符串 |
1.22.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.22.2.3.4. Tags
- config.open-cluster-management.io
1.22.2.4. 删除 KlusterletConfig
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}1.22.2.4.1. 描述
删除单个 klusterletconfig。
1.22.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
klusterletconfig_name | 要删除的 KlusterletConfig 的名称。 | 字符串 |
1.22.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.22.2.4.4. Tags
- config.open-cluster-management.io
1.22.3. 定义
1.22.3.1. KlusterletConfig
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | KlusterletConfig 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | KlusterletConfig 的元数据。 | object |
|
spec | KlusterletConfig 的规格。 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
registry | 包括镜像和源 registry。源 registry 被镜像替代。 | registry |
|
pullSecret | 镜像 pull secret 的名称。 | object |
|
nodePlacement | 在受管集群中启用附加代理的调度控制。 | |
|
hubKubeAPIServerProxyConfig | 包含受管集群中 klusterlet 或附加代理和 hub 集群上的 kube-apiserver 之间的连接的代理设置。空表示没有可用的代理设置。 |
nodePlacement
| Name | 描述 | 模式 |
|---|---|---|
|
nodeSelector |
定义 pod 调度到运行的节点。当 | map[string]string |
|
tolerations |
应用到 pod，并使用匹配的运算符( | []corev1.Toleration |
kubeAPIServerProxyConfig
| Name | 描述 | 模式 |
|---|---|---|
|
cabundle | 用于验证代理服务器的 CA 证书捆绑包。如果只设置了 HTTPProxy，则捆绑包将被忽略。当设置 HTTPSProxy 且代理服务器使用自签名 CA 证书时，需要捆绑包。 | map[string]string |
|
httpProxy | HTTP 请求的代理的 URL | map[string]string |
|
httpsProxy | HTTPS 请求的代理的 URL。如果设置了 HTTPProxy 和 HTTPSProxy，则会选择 httpsProxy。 | map[string]string |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}