Menu Close

API

Red Hat Advanced Cluster Management for Kubernetes 2.1

API

摘要

API guide for Red Hat Advanced Cluster Management for Kubernetes

第 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.1.0

1.1.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.1.1.3. 许可证信息

License : 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. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.1.2. 路径

1.1.2.1. 查询所有集群

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
1.1.2.2.1. 描述

创建集群

1.1.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

正文
必需

描述要创建集群的参数。

Cluster

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. 请求正文
{
  "apiVersion" : "cluster.open-cluster-management.io/v1",
  "kind" : "ManagedCluster",
  "metadata" : {
    "labels" : {
      "vendor" : "OpenShift"
    },
    "name" : "cluster1"
  },
  "spec": {
    "hubAcceptsClient": true,
    "managedClusterClientConfigs": [
      {
        "caBundle": "test",
        "url": "https://test.com"
      }
    ]
  },
  "status" : { }
}

1.1.2.3. 查询单个集群

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}
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
必需

字符串

类型
必需

字符串

元数据
必需

对象

spec
必需

spec

spec

Name模式

hubAcceptsClient
required

bool

managedClusterClientConfigs
optional

< managedClusterClientConfigs > array

leaseDurationSeconds
optional

integer (int32)

managedClusterClientConfigs

Name描述模式

URL
必需

 

字符串

cabundle
可选

Pattern"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

字符串(字节)

1.2. Clustersets API(v1alpha1)

1.2.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 Clusterset 资源相关的 API 信息。Clusterset 资源有 4 个可能的请求:create、query、delete 和 update。

1.2.1.1. 版本信息

版本 : 2.1.0

1.2.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.2.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.2.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.2.1.5. Tags

  • cluster.open-cluster-management.io:创建和管理 Clustersets

1.2.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.2.2. 路径

1.2.2.1. 查询所有集群集(clusterset)

GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets
1.2.2.1.1. 描述

查询 Clustersets 以获取更多详细信息。

1.2.2.1.2. 参数
类型Name描述模式

Header

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/v1alpha1/managedclustersets
1.2.2.2.1. 描述

创建一个 clusterset。

1.2.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

正文
必需

描述要创建的 clusterset 的参数。

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. 请求正文
{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "ManagedClusterSet",
  "metadata" : {
    "name" : "clusterset1"
  },
  "spec": { },
  "status" : { }
}

1.2.2.3. 查询单个集群集

GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
1.2.2.3.1. 描述

查询单个集群集以获取更多详细信息。

1.2.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

clusterset_name
required

要查询的集群集的名称。

字符串

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/v1alpha1/managedclustersets/{clusterset_name}
1.2.2.4.1. 描述

删除单个集群集。

1.2.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

clusterset_name
required

要删除的集群集的名称。

字符串

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
必需

字符串

类型
必需

字符串

元数据
必需

对象

1.3. Clustersetbindings API (v1alpha1)

1.3.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 clustersetbinding 资源相关的 API 信息。Clustersetbinding 资源有 4 个可能的请求:create、query、delete 和 update。

1.3.1.1. 版本信息

版本 : 2.1.0

1.3.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.3.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.3.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.3.1.5. Tags

  • cluster.open-cluster-management.io:创建和管理 clustersetbindings

1.3.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.3.2. 路径

1.3.2.1. 查询所有 clustersetbindings

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
1.3.2.1.1. 描述

查询 clustersetbindings 以获取更多详细信息。

1.3.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 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/v1alpha1/namespaces/{namespace}/managedclustersetbindings
1.3.2.2.1. 描述

创建 clustersetbinding。

1.3.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建的 clustersetbinding 的参数。

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. 请求正文
{
  "apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.3.2.3. 查询单个 clustersetbinding

GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.3.2.3.1. 描述

查询单个 clustersetbinding 获取更多详细信息。

1.3.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

路径

clustersetbinding_name
required

要查询的 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/v1alpha1/managedclustersetbindings/{clustersetbinding_name}
1.3.2.4.1. 描述

删除单个 clustersetbinding。

1.3.2.4.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

路径

clustersetbinding_name
required

要删除的 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
必需

字符串

类型
必需

字符串

元数据
必需

对象

spec
必需

spec

spec

Name模式

clusterSet
required

字符串

1.4. Channels API

1.4.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的频道资源相关的 API 信息。频道资源有 4 个可用的请求:create、query、delete 和 update。

1.4.1.1. 版本信息

版本 : 2.1.0

1.4.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.4.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.4.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.4.1.5. Tags

  • channels.apps.open-cluster-management.io : 创建和管理可部署性资源(deployables)

1.4.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.4.2. 路径

1.4.2.1. 创建频道

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.4.2.1.1. 描述

创建频道

1.4.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建的 deployable 的参数。

Channel

1.4.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.1.4. 使用
  • application/yaml
1.4.2.1.5. Tags
  • channels.apps.open-cluster-management.io
1.4.2.1.6. HTTP 请求示例
1.4.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Channel",
  "name" : "sample-channel",
  "namespace" : "default",
  "spec" : {
    "type" : "Git",
    "pathname" : "https://github.com/IBM/charts.git",
    "configMapRef" : {
      "name" : "bookinfo-resource-filter-configmap",
      "kind" : "configmap"
    }
  }
}

1.4.2.2. 为目标命名空间查询所有频道

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.4.2.2.1. 描述

查询您的频道以获得更详细的信息。

1.4.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.4.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.2.4. 使用
  • application/yaml
1.4.2.2.5. Tags
  • channels.apps.open-cluster-management.io

1.4.2.3. 查询命名空间的单个频道

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.4.2.3.1. 描述

查询单个频道以了解更多详情。

1.4.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

channel_name
required

您要查询的 deployable 的名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.4.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.3.4. Tags
  • channels.apps.open-cluster-management.io

1.4.2.4. 删除频道

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.4.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

channel_name
required

要删除的频道名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.4.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.4.2.4.3. Tags
  • channels.apps.open-cluster-management.io

1.4.3. 定义

1.4.3.1. Channel

Name模式

apiVersion
必需

字符串

类型
必需

字符串

元数据
必需

对象

spec
必需

spec

spec

Name描述模式

configMapRef
optional

ObjectReference 包含足够信息供您检查或修改引用的对象。

configMapRef

gates
可选

ChannelGate 定义推广到频道的条件

gates

路径名称
必需

 

字符串

secretRef
optional

ObjectReference 包含足够信息供您检查或修改引用的对象。

secretRef

sourceNamespaces
optional

 

< enum(Namespace、HelmRepo、ObjectBucket、Git、namespace、helmrepo、objectbucket、github)> 数组

configMapRef

Name描述模式

apiVersion
optional

引用的 API 版本。

字符串

fieldPath
optional

如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的,且该字段在将来会有所改变。

字符串

kind
可选

引用的 kind更多信息:https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

字符串

名称
可选

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

字符串

命名空间
可选

引用的命名空间更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

字符串

resourceVersion
optional

指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

字符串

UID
可选

引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

字符串

gates

Name描述模式

注解
可选

k8s 的典型注解

annotations

labelSelector
optional

标签选择器,即一组资源的标签查询。matchLabels 和 matchExpressions 的逻辑关系是 AND。空标签选择器匹配所有对象。null 标签选择器不匹配任何对象。

labelSelector

名称
可选

 

字符串

annotations

Name模式


可选

字符串


可选

字符串

labelSelector

Name描述模式

matchExpressions
optional

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

< matchExpressions > array

matchLabels
optional

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

< string, string > map

matchExpressions

Name描述模式


必需

key 是选择器应用到的标签键。

字符串

Operator
必需

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

字符串


可选

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

< string > 数字

secretRef

Name描述模式

apiVersion
optional

引用的 API 版本。

字符串

fieldPath
optional

如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。Todo: 这个设计不是最终设计的,且该字段在将来会有所改变。

字符串

kind
可选

引用的 kind更多信息:https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

字符串

名称
可选

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

字符串

命名空间
可选

引用的命名空间更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

字符串

resourceVersion
optional

指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

字符串

UID
可选

引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

字符串

1.5. Subscriptions API

1.5.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的订阅资源相关的 API 信息。订阅资源有 4 个可用的请求:create、query、delete 和 update。

1.5.1.1. 版本信息

版本 : 2.1.0

1.5.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.5.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.5.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.5.1.5. Tags

  • subscription.apps.open-cluster-management.io : 创建和管理订阅

1.5.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.5.2. 路径

1.5.2.1. 创建订阅

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.5.2.1.1. 描述

创建订阅

1.5.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建的订阅的参数。

Subscription

1.5.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.1.4. 使用
  • subscription/yaml
1.5.2.1.5. Tags
  • subscriptions.apps.open-cluster-management.io
1.5.2.1.6. HTTP 请求示例
1.5.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

1.5.2.2. 查询所有订阅

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.5.2.2.1. 描述

查询您的订阅以获取更多详情。

1.5.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.5.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.2.4. 使用
  • subscription/yaml
1.5.2.2.5. Tags
  • subscriptions.apps.open-cluster-management.io

1.5.2.3. 查询单个订阅

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.5.2.3.1. 描述

查询单个订阅以了解更多详情。

1.5.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

路径

subscription_name
必需

要查询的订阅名称。

字符串

1.5.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.3.4. Tags
  • subscriptions.apps.open-cluster-management.io

1.5.2.4. 创建一个订阅:

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.5.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

路径

subscription_name
必需

要删除的订阅的名称。

字符串

1.5.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.5.2.4.3. Tags
  • subscriptions.apps.open-cluster-management.io

1.5.3. 定义

1.5.3.1. Subscription

Name模式

apiVersion
必需

字符串

类型
必需

字符串

元数据
必需

metadata

spec
必需

spec

状态
可选

status

metadata

Name模式

注解
可选

对象

标签
可选

对象

名称
可选

字符串

命名空间
可选

字符串

spec

Name模式

频道
必需

字符串

名称
可选

字符串

覆盖
可选

<overrides > 数组

packageFilter
可选

packageFilter

packageOverrides
optional

<packageOverrides > 数组

放置
可选

placement

timewindow
optional

timewindow

overrides

Name模式

clusterName
required

字符串

clusterOverrides
required

< object > 数组

packageFilter

Name描述模式

注解
可选

 

< string, string > map

filterRef
optional

 

filterRef

labelSelector
optional

 

labelSelector

版本
可选

Pattern"([0-9]+)\\.[0-9]+)(\\.[0-9]+)|(\\.[0-9]+)?(\\.[xX]$"

字符串

filterRef

Name模式

名称
可选

字符串

labelSelector

Name模式

matchExpressions
optional

< matchExpressions > array

matchLabels
optional

< string, string > map

matchExpressions

Name模式


必需

字符串

Operator
必需

字符串


可选

< string > 数字

packageOverrides

Name模式

packageAlias
optional

字符串

packageName
required

字符串

packageOverrides
optional

< object > 数组

placement

Name模式

clusterSelector
optional

clusterSelector

集群
可选

<clusters > 数组

本地
可选

布尔值

placementRef
optional

placementRef

clusterSelector

Name模式

matchExpressions
optional

< matchExpressions > array

matchLabels
optional

< string, string > map

matchExpressions

Name模式


必需

字符串

Operator
必需

字符串


可选

< string > 数字

clusters

Name模式

名称
必需

字符串

placementRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

timewindow

Name模式

daysofweek
optional

< string > 数字

小时
可选

<hours > 数组

位置
可选

字符串

windowtype
optional

enum(active、blocked、Active、Blocked)

hours

Name模式

结束
可选

字符串

启动
可选

字符串

status

Name模式

lastUpdateTime
optional

字符串(date-time)

消息
可选

字符串

阶段
可选

字符串

原因
可选

字符串

状态
可选

对象

1.6. PlacementRules API

1.6.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 PlacementRule 资源相关的 API 信息。PlacementRule 资源有 4 个可用的请求:create、query、delete 和 update。

1.6.1.1. 版本信息

版本 : 2.1.0

1.6.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.6.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.6.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.6.1.5. Tags

  • placementrules.apps.open-cluster-management.io:创建和管理放置规则。

1.6.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.6.2. 路径

1.6.2.1. 创建放置规则

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.6.2.1.1. 描述

创建放置规则。

1.6.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建的放置规则的参数。

PlacementRule

1.6.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.1.4. 使用
  • application/yaml
1.6.2.1.5. Tags
  • placementrules.apps.open-cluster-management.io
1.6.2.1.6. HTTP 请求示例
1.6.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "PlacementRule",
  "metadata" : {
    "name" : "towhichcluster",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "clusterConditions" : [ {
      "type": "ManagedClusterConditionAvailable",
      "status": "True"
    } ],
    "clusterSelector" : { }
  }
}

1.6.2.2. 查询所有放置规则

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.6.2.2.1. 描述

查询放置规则以获取更多详细信息。

1.6.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.6.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.2.4. 使用
  • application/yaml
1.6.2.2.5. Tags
  • placementrules.apps.open-cluster-management.io

1.6.2.3. 查询单个放置规则

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.6.2.3.1. 描述

查询单个放置规则以了解更多详细信息。

1.6.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

路径

placementrule_name
required

要查询的放置规则的名称。

字符串

1.6.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.3.4. Tags
  • placementrules.apps.open-cluster-management.io

1.6.2.4. 删除放置规则

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.6.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

路径

placementrule_name
required

要删除的放置规则的名称。

字符串

1.6.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.6.2.4.3. Tags
  • placementrules.apps.open-cluster-management.io

1.6.3. 定义

1.6.3.1. PlacementRule

Name模式

apiVersion
必需

字符串

类型
必需

字符串

元数据
必需

对象

spec
必需

spec

spec

Name模式

clusterConditions
optional

<clusterConditions > 数组

clusterReplicas
optional

整数

clusterSelector
optional

clusterSelector

集群
可选

<clusters > 数组

策略
可选

<policies > 数组

resourceHint
optional

resourceHint

schedulerName
optional

字符串

clusterConditions

Name模式

状态
可选

字符串

输入
可选

字符串

clusterSelector

Name模式

matchExpressions
optional

< matchExpressions > array

matchLabels
optional

< string, string > map

matchExpressions

Name模式


可选

字符串

Operator
可选

字符串


可选

< string > 数字

clusters

Name模式

名称
可选

字符串

policies

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

resourceHint

Name模式

排序
可选

字符串

输入
可选

字符串

1.7. Applications API

1.7.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的应用程序资源相关的 API 信息。应用程序资源有 4 个可用的请求:create、query、delete 和 update。

1.7.1.1. 版本信息

版本 : 2.1.0

1.7.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.7.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.7.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.7.1.5. Tags

  • Applications.app.k8s.io : 创建和管理应用程序

1.7.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.7.2. 路径

1.7.2.1. 创建应用程序

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.7.2.1.1. 描述

创建应用程序。

1.7.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建的应用程序的参数。

Application

1.7.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.1.4. 使用
  • application/yaml
1.7.2.1.5. Tags
  • applications.app.k8s.io
1.7.2.1.6. HTTP 请求示例
1.7.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.7.2.2. 查询所有应用程序

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.7.2.2.1. 描述

查询您的应用程序以获取更多详情。

1.7.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 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
  • applications.app.k8s.io

1.7.2.3. 查询单个应用程序

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.7.2.3.1. 描述

查询单个应用程序以获取更多详细信息。

1.7.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

APPLICATION_NAME
必需

您要查询的应用程序的名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.7.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.3.4. Tags
  • applications.app.k8s.io

1.7.2.4. 删除应用程序

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.7.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

APPLICATION_NAME
必需

要删除的应用程序的名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.7.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.7.2.4.3. Tags
  • applications.app.k8s.io

1.7.3. 定义

1.7.3.1. Application

Name模式

apiVersion
必需

字符串

类型
必需

字符串

元数据
必需

对象

spec
必需

spec

spec

Name模式

assemblyPhase
optional

字符串

componentKinds
optional

< object > 数组

描述符
可选

descriptor

info
可选

<info > 数组

选择器
可选

对象

descriptor

Name模式

描述
可选

字符串

图标
可选

<icons > 数组

关键字
可选

< string > 数字

links
可选

<links > 数组

维护程序
可选

<maintainers > 数组

备注
可选

字符串

所有者
可选

<owners > 数组

输入
可选

字符串

版本
可选

字符串

icons

Name模式

大小
可选

字符串

src
必需

字符串

输入
可选

字符串

Name模式

描述
可选

字符串

URL
可选

字符串

maintainers

Name模式

发送电子邮件
可选

字符串

名称
可选

字符串

URL
可选

字符串

owners

Name模式

发送电子邮件
可选

字符串

名称
可选

字符串

URL
可选

字符串

info

Name模式

名称
可选

字符串

输入
可选

字符串


可选

字符串

valueFrom
optional

valueFrom

valueFrom

Name模式

configMapKeyRef
optional

configMapKeyRef

ingressRef
optional

ingressRef

secretKeyRef
optional

secretKeyRef

serviceRef
optional

serviceRef

输入
可选

字符串

configMapKeyRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串


可选

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

ingressRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串

主机
可选

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

path
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

secretKeyRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串


可选

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

serviceRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

path
可选

字符串

端口
可选

integer (int32)

resourceVersion
optional

字符串

UID
可选

字符串

1.8. Helm API

1.8.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 HelmRelease 资源相关的 API 信息。HelmRelease 有 4 个可用的请求:create、query、delete 和 update。

1.8.1.1. 版本信息

版本 : 2.1.0

1.8.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.8.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.8.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.8.1.5. Tags

  • helmreleases.apps.open-cluster-management.io : 创建和管理 helmreleases

1.8.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.8.2. 路径

1.8.2.1. 创建 helmrelease

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.8.2.1.1. 描述

创建 helmrelease。

1.8.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建的 helmrelease 的参数。

HelmRelease

1.8.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.1.4. 使用
  • application/yaml
1.8.2.1.5. Tags
  • helmreleases.apps.open-cluster-management.io
1.8.2.1.6. HTTP 请求示例
1.8.2.1.6.1. 请求正文
{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "HelmRelease",
  "metadata" : {
    "name" : "nginx-ingress",
    "namespace" : "default"
  },
  "repo" : {
    "chartName" : "nginx-ingress",
    "source" : {
      "helmRepo" : {
        "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
      },
      "type" : "helmrepo"
    },
    "version" : "1.26.0"
  },
  "spec" : {
    "defaultBackend" : {
      "replicaCount" : 3
    }
  }
}

1.8.2.2. 查询所有 helmreleases

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.8.2.2.1. 描述

查询您的 helmreleases 获取更多详细信息。

1.8.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 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
  • helmreleases.apps.open-cluster-management.io

1.8.2.3. 查询单个 helmrelease

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.8.2.3.1. 描述

查询单个 helmrelease 获取更多详细信息。

1.8.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

helmrelease_name
required

要查询的 helmrelease 的名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.8.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.3.4. Tags
  • helmreleases.apps.open-cluster-management.io

1.8.2.4. 删除 helmrelease

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.8.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

helmrelease_name
required

要删除的 helmrelease 的名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.8.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.8.2.4.3. Tags
  • helmreleases.apps.open-cluster-management.io

1.8.3. 定义

1.8.3.1. HelmRelease

Name模式

apiVersion
必需

字符串

类型
必需

字符串

元数据
必需

对象

repo
必需

repo

spec
必需

对象

状态
必需

status

repo

Name模式

chartName
optional

字符串

configMapRef
optional

configMapRef

secretRef
optional

secretRef


可选

source

版本
可选

字符串

configMapRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

secretRef

Name模式

apiVersion
optional

字符串

fieldPath
optional

字符串

kind
可选

字符串

名称
可选

字符串

命名空间
可选

字符串

resourceVersion
optional

字符串

UID
可选

字符串

source

Name模式

GitHub
可选

github

helmRepo
optional

helmRepo

输入
可选

字符串

github

Name模式

分支
可选

字符串

chartPath
optional

字符串

URL
可选

< string > 数字

helmRepo

Name模式

URL
可选

< string > 数字

status

Name模式

条件
必需

<conditions > 数组

deployedRelease
optional

deployedRelease

conditions

Name模式

lastTransitionTime
optional

字符串(date-time)

消息
可选

字符串

原因
可选

字符串

状态
必需

字符串

键入
必需

字符串

deployedRelease

Name模式

清单
可选

字符串

名称
可选

字符串

1.9. Policy API

1.9.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的策略(Policy)资源相关的 API 信息。Policy 资源有 4 个可用的请求:create、query、delete 和 update。

1.9.1.1. 版本信息

版本 : 2.1.0

1.9.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.9.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.9.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.9.1.5. Tags

  • policy.open-cluster-management.io/v1 : 创建和管理策略。

1.9.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.9.2. 路径

1.9.2.1. 创建策略

POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.1.1. 描述

创建策略

1.9.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

Body

正文
必需

描述要创建策略的参数。

Application

1.9.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.1.4. 使用
  • application/json
1.9.2.1.5. Tags
  • policy.open-cluster-management.io
1.9.2.1.6. HTTP 请求示例
1.9.2.1.6.1. 请求正文
{
  "apiVersion": "policy.open-cluster-management.io/v1/v1alpha1",
  "kind": "Policy",
  "metadata": {
    "name": "test-policy-swagger",
    "description": "Example body for Policy API Swagger docs"
  },
  "spec": {
    "remediationAction": "enforce",
    "namespaces": {
      "include": [
        "default"
      ],
      "exclude": [
        "kube*"
      ]
    },
    "policy-templates": {
    "kind": "ConfigurationPolicy",
    "apiVersion": "policy.open-cluster-management.io/v1alpha1",
    "complianceType": "musthave",
    "metadata": {
      "namespace": null,
      "name": "test-role"
    },
    "selector": {
      "matchLabels": {
        "cloud": "IBM"
      }
    },
    "spec" : {
      "object-templates": {
        "complianceType": "mustHave",
        "objectDefinition": {
          "apiVersion": "rbac.authorization.k8s.io/v1",
          "kind": "Role",
          "metadata": {
            "name": "role-policy",
          },
          "rules": [
            {
              "apiGroups": [
                "extensions",
                "apps"
              ],
              "resources": [
                "deployments"
              ],
              "verbs": [
                "get",
                "list",
                "watch",
                "delete"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "pods"
              ],
              "verbs": [
                "create",
                "update",
                "patch"
              ]
            },
            {
              "apiGroups": [
                "core"
              ],
              "resources": [
                "secrets"
              ],
              "verbs": [
                "get",
                "watch",
                "list",
                "create",
                "delete",
                "update",
                "patchß"
              ],
            },
          ],
        },
      },
    },
  },

1.9.2.2. 查询所有策略

GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.2.1. 描述

查询您的策略以获得更详细的信息。

1.9.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

namespace
required

要应用策略的命名空间,如 default。

字符串

1.9.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.2.4. 使用
  • application/json
1.9.2.2.5. Tags
  • policy.open-cluster-management.io

1.9.2.3. 查询单个策略

GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.3.1. 描述

查询单个策略以获取更多详细信息。

1.9.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

policy_name
required

要查询的策略的名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.9.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.3.4. Tags
  • policy.open-cluster-management.io

1.9.2.4. 删除策略

DELETE /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

policy_name
required

要删除的策略名称。

字符串

路径

namespace
required

要使用的命名空间,如 default。

字符串

1.9.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.9.2.4.3. Tags
  • policy.open-cluster-management.io

1.9.3. 定义

1.9.3.1. policy

Name描述模式

apiVersion
必需

策略的版本化模式(schema)。

字符串

类型
必需

代表 REST 资源的字符串值。

字符串

元数据
必需

描述定义策略的规则。

对象

spec

Name描述模式

remediationAction
optional

代表资源中定义的处理违反情况的值。

字符串

namespaceSelector
required

代表策略要应用到的命名空间的值。

字符串

policy-templates

Name描述模式

apiVersion
必需

策略的版本化模式(schema)。

字符串

kind
可选

代表 REST 资源的字符串值。

字符串

元数据
必需

描述定义策略的规则。

对象

clusterConditions
optional

定义标签的部分。

字符串

规则
可选

 

字符串

clusterConditions

Name描述模式

matchLabels
optional

策略应用到一个命名空间所需的标签。

对象

Cloud
可选

策略应用到一个云供应商所需的标签。

字符串

rules

Name描述模式

apiGroups
required

适用于该规则的 API 列表。

字符串

资源
必需

资源类型列表。

对象

verbs
必需

动词列表。

字符串

1.10. Observability API

1.10.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 MultiClusterObservability 资源相关的 API 信息。MultiClusterObservability 资源有 4 个可用的请求:create、query、delete 和 update。

1.10.1.1. 版本信息

版本 : 2.1.0

1.10.1.2. 联系信息

Contact Email : apiteam@swagger.io

1.10.1.3. 许可证信息

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
terms of service : http://swagger.io/terms/

1.10.1.4. URI scheme

BasePath : /kubernetes/apis
schemes : HTTPS

1.10.1.5. Tags

  • Observability.open-cluster-management.io : 创建和管理多集群的观察性

1.10.1.6. 外部文档

Description : 查找更多有关 Swagger.
URL : http://swagger.io

1.10.2. 路径

1.10.2.1. 创建 multiclusterobservability 资源

POST /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
1.10.2.1.1. 描述

创建 MultiClusterObservability 资源。

1.10.2.1.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

正文
必需

描述要创建的 MultiClusterObservability 资源的参数。

MultiClusterObservability

1.10.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.1.4. 使用
  • application/yaml
1.10.2.1.5. Tags
  • observability.apps.open-cluster-management.io
1.10.2.1.6. HTTP 请求示例
1.10.2.1.6.1. 请求正文
{
  "apiVersion": "observability.open-cluster-management.io/v1beta1",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "storageConfigObject": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      }
    }
  }
}

1.10.2.2. 查询所有 multiclusterobservabilities

GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
1.10.2.2.1. 描述

查询 MultiClusterObservability 资源以获取更多详细信息。

1.10.2.2.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

1.10.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.2.4. 使用
  • application/yaml
1.10.2.2.5. Tags
  • observability.apps.open-cluster-management.io

1.10.2.3. 查询单个 multiclusterobservability

GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
1.10.2.3.1. 描述

查询单个 MultiClusterObservability 资源以获取更多详细信息。

1.10.2.3.2. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

multiclusterobservability_name
必需

要查询的 multiclusterobservability 的名称。

字符串

1.10.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.3.4. Tags
  • observability.apps.open-cluster-management.io

1.10.2.4. 删除一个 multiclusterobservability 资源

DELETE /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
1.10.2.4.1. 参数
类型Name描述模式

Header

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

multiclusterobservability_name
必需

要删除的 multiclusterobservability 的名称。

字符串

1.10.2.4.2. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.10.2.4.3. Tags
  • observability.apps.open-cluster-management.io

1.10.3. 定义

1.10.3.1. MultiClusterObservability

Name描述模式

apiVersion
必需

版本化的 MultiClusterObservability schema。

字符串

类型
必需

代表 REST 资源、MultiClusterObservability 的字符串值。

字符串

元数据
必需

描述定义策略的规则。

对象

spec

Name描述模式

availabilityConfig
optional

用于选择高可用性支持参数。这可提供对故障切换的支持,并消耗更多资源。
选项: BasicHigh

字符串

enableDownSampling
optional

启用或禁用 downsample。默认值为 false。如果没有 downsample 数据,则查询不可用。

布尔值

imagePullPolicy
optional

拉取 Observability 镜像的策略。

字符串

imagePullSecret
optional

Observability 镜像的 pull secret。

字符串

nodeSelector
optional

支持节点选择限制

对象

observabilityAddonSpec
optional

所有启用了附加组件的受管集群的全局设置。

observabilityAddonSpec

retentionResolution1h
optional

在存储桶中保留分辨率 2 样本(1 小时)的时间长度。默认值为 30 天(30d)。

字符串

retentionResolution5m
optional

在存储桶中保留分辨率 1 样本(5 分钟)的时间长度。默认值为 14 天(14d)。

字符串

retentionResolutionRaw
optional

在存储桶中保留原始分辨率样本的时间。

字符串

storageConfigObject
required

指定 Observability 使用的存储。

storageConfigObject

observabilityAddonSpec

Name描述模式

enableMetrics
optional

指示 Observability 附加组件是否将指标发送到 hub 集群。默认值为 true

布尔值

间隔
可选

Observability 附加组件将指标发送到 hub 集群的间隔。默认值为 60 秒(60s)。

整数

storageConfigObject

Name描述模式

metricObjectStorage
required

用于为指标配置 secret 的对象存储。

metricObjectStorage

statefulSetSize
optional

适用于 Observability 有状态集合(如 Thanos store、rule、compact 和 receiver)的存储量。默认值为 10Gi

字符串

statefulSetStorageClass
optional

指定 storageClass 有状态集。如果为您的操作系统配置了 MetricObjectStorage 来创建存储,则此存储用于对象存储。默认值为 gp2

字符串

metricObjectStorage

Name描述模式


必需

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

字符串

名称
必需

metricObjectStorage 的名称。

字符串