第 1 章 API
您可以使用 API 来创建和管理应用程序资源、频道、订阅和查询信息。
用户需要的访问权限:您只能执行分配了相关角色的操作。如需更多关于访问要求的信息,请参阅基于角色的访问控制文档。
如需更多信息,请参阅以下每个资源的 API 文档:
1.1. Clusters API 复制链接链接已复制到粘贴板!
1.1.1. 概述 复制链接链接已复制到粘贴板!
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的集群资源相关的 API 信息。集群资源有 4 个可用的请求:create、query、delete 和 update。
1.1.1.1. 版本信息 复制链接链接已复制到粘贴板!
版本 :2.2.0
1.1.1.2. 联系信息 复制链接链接已复制到粘贴板!
Contact Email : apiteam@swagger.io
1.1.1.3. 许可证信息 复制链接链接已复制到粘贴板!
许可证 :Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/
1.1.1.4. URI scheme 复制链接链接已复制到粘贴板!
BasePath : /kubernetes/apis
Schemes :HTTPS
1.1.1.5. Tags 复制链接链接已复制到粘贴板!
- cluster.open-cluster-management.io :创建和管理集群
1.1.1.6. 外部文档 复制链接链接已复制到粘贴板!
描述 :了解有关 Swagger 的更多信息。
URL : http://swagger.io
1.1.2. 路径 复制链接链接已复制到粘贴板!
1.1.2.1. 查询所有集群 复制链接链接已复制到粘贴板!
GET /cluster.open-cluster-management.io/v1/managedclusters
GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. 描述 复制链接链接已复制到粘贴板!
查询集群以获取更多详细信息。
1.1.2.1.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
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/managedclusters
1.1.2.2.1. 描述 复制链接链接已复制到粘贴板!
创建集群
1.1.2.2.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
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 | 描述 | 模式 |
|---|---|---|---|
| Header |
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}
1.1.2.4.1. 描述 复制链接链接已复制到粘贴板!
删除单个集群
1.1.2.4.2. 参数 复制链接链接已复制到粘贴板!
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| Header |
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 | 字符串 |
|
metadata | 对象 |
|
spec |
spec
| Name | 模式 |
|---|---|
|
hubAcceptsClient | bool |
|
managedClusterClientConfigs | < managedClusterClientConfigs > array |
|
leaseDurationSeconds | integer (int32) |
managedClusterClientConfigs
| Name | 描述 | 模式 |
|---|---|---|
|
URL | 字符串 | |
|
CABundle |
Pattern : | 字符串(字节) |