1.7. PlacementRules API
1.7.1. 概述 复制链接链接已复制到粘贴板!
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 PlacementRule 资源相关的 API 信息。PlacementRule 资源有 4 个可用的请求:create、query、delete 和 update。
1.7.1.1. 版本信息 复制链接链接已复制到粘贴板!
版本 : 2.5.0
1.7.1.2. URI scheme 复制链接链接已复制到粘贴板!
BasePath : /kubernetes/apis
Schemes : HTTPS
1.7.1.3. Tags 复制链接链接已复制到粘贴板!
- placementrules.apps.open-cluster-management.io:创建和管理放置规则
1.7.2. 路径 复制链接链接已复制到粘贴板!
1.7.2.1. 创建放置规则 复制链接链接已复制到粘贴板!
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.7.2.1.1. 描述 复制链接链接已复制到粘贴板!
创建放置规则。
1.7.2.1.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间,如 default。 | 字符串 |
| Body |
body | 描述要创建的放置规则的参数。 |
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}/placementrules
1.7.2.2.1. 描述 复制链接链接已复制到粘贴板!
查询放置规则以获取更多详细信息。
1.7.2.2.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间,如 default。 | 字符串 |
1.7.2.2.3. 响应 复制链接链接已复制到粘贴板!
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.2.4. 使用 复制链接链接已复制到粘贴板!
-
application/yaml
1.7.2.2.5. Tags 复制链接链接已复制到粘贴板!
- placementrules.apps.open-cluster-management.io
1.7.2.3. 查询单个放置规则 复制链接链接已复制到粘贴板!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.3.1. 描述 复制链接链接已复制到粘贴板!
查询单个放置规则以了解更多详细信息。
1.7.2.3.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间,如 default。 | 字符串 |
| 路径 |
placementrule_name | 要查询的放置规则的名称。 | 字符串 |
1.7.2.3.3. 响应 复制链接链接已复制到粘贴板!
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.3.4. Tags 复制链接链接已复制到粘贴板!
- placementrules.apps.open-cluster-management.io
1.7.2.4. 删除放置规则 复制链接链接已复制到粘贴板!
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.7.2.4.1. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
COOKIE | 身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间,如 default。 | 字符串 |
| 路径 |
placementrule_name | 要删除的放置规则的名称。 | 字符串 |
1.7.2.4.2. 响应 复制链接链接已复制到粘贴板!
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.7.2.4.3. Tags 复制链接链接已复制到粘贴板!
- placementrules.apps.open-cluster-management.io
1.7.3. 定义 复制链接链接已复制到粘贴板!
1.7.3.1. PlacementRule 复制链接链接已复制到粘贴板!
| Name | 模式 |
|---|---|
|
apiVersion | 字符串 |
|
kind | 字符串 |
|
metadata | 对象 |
|
spec |
spec
| 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 | 字符串 |