1.15. 放置 API (v1beta1)
已弃用: API 的文档已弃用。使用控制台中的API Explorer或oc命令来查看当前和支持的 API。
1.15.1. 概述 复制链接链接已复制到粘贴板!
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的放置(Placement)资源相关的 API 信息。放置资源有 4 个可用的请求:create、query、delete 和 update。Placement 定义了一个规则,从绑定到放置命名空间的 ManagedClusterSets 中选择一组 ManagedClusters。会创建一个带有标签 cluster.open-cluster-management.io/placement={placement name} 的 PlacementDecisions 片段,以表示由这个放置选择的 ManagedClusters。
1.15.1.1. 版本信息 复制链接链接已复制到粘贴板!
版本 2.7
1.15.1.2. URI scheme 复制链接链接已复制到粘贴板!
BasePath : /kubernetes/apis
Schemes : HTTPS
1.15.1.3. Tags 复制链接链接已复制到粘贴板!
- cluster.open-cluster-management.io:创建和管理放置
1.15.2. 路径 复制链接链接已复制到粘贴板!
1.15.2.1. 查询所有放置 复制链接链接已复制到粘贴板!
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement
1.15.2.1.1. 描述 复制链接链接已复制到粘贴板!
查询您的放置以获取更多详细信息。
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. 使用 复制链接链接已复制到粘贴板!
-
placement/yaml
1.15.2.1.5. Tags 复制链接链接已复制到粘贴板!
- cluster.open-cluster-management.io
1.15.2.2. 创建一个放置 复制链接链接已复制到粘贴板!
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements
1.15.2.2.1. 描述 复制链接链接已复制到粘贴板!
创建一个放置。
1.15.2.2.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的放置绑定的参数。 |
1.15.2.2.3. 响应 复制链接链接已复制到粘贴板!
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.15.2.2.4. 使用 复制链接链接已复制到粘贴板!
-
placement/yaml
1.15.2.2.5. Tags 复制链接链接已复制到粘贴板!
- cluster.open-cluster-management.io
1.15.2.2.6. HTTP 请求示例 复制链接链接已复制到粘贴板!
1.15.2.2.6.1. 请求正文 复制链接链接已复制到粘贴板!
1.15.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.15.2.3.1. 描述 复制链接链接已复制到粘贴板!
查询单个放置以获取更多详细信息。
1.15.2.3.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
placement_name | 要查询的放置名称。 | 字符串 |
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. 删除一个放置 复制链接链接已复制到粘贴板!
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.15.2.4.1. 描述 复制链接链接已复制到粘贴板!
删除一个放置。
1.15.2.4.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
placement_name | 要删除的放置名称。 | 字符串 |
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. 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 |