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.7.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
1.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. 请求正文
{ "apiVersion" : "app.k8s.io/v1beta1", "kind" : "Application", "metadata" : { "labels" : { "app" : "nginx-app-details" }, "name" : "nginx-app-3", "namespace" : "ns-sub-1" }, "spec" : { "componentKinds" : [ { "group" : "apps.open-cluster-management.io", "kind" : "Subscription" } ] }, "selector" : { "matchLabels" : { "app" : "nginx-app-details" } }, "status" : { } }
1.8.2.2. 查询所有应用程序
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.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}
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}
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 | 字符串 |