主页
产品
Red Hat Advanced Cluster Management for Kubernetes
2.14
API
1.10. Helm API

1.10. Helm API

deprecated ： API 的文档已弃用。使用控制台或 oc 命令中的 API Explorer 查看当前和支持的 API。

1.10.1. 概述
复制链接

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

1.10.1.1. 版本信息
复制链接

版本 2.7

1.10.1.2. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.10.1.3. Tags
复制链接

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

1.10.2. 路径
复制链接

1.10.2.1. 创建 helmrelease
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.10.2.1.1. 描述
复制链接

创建 helmrelease。

1.10.2.1.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 helmrelease 的参数。	HelmRelease

1.10.2.1.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.1.4. 使用
复制链接

application/yaml

1.10.2.1.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.2.1.6. HTTP 请求示例
复制链接

1.10.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
    }
  }
}

{
  "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
    }
  }
}

Copy to Clipboard

Toggle word wrap

1.10.2.2. 查询所有 helmreleases
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.10.2.2.1. 描述
复制链接

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

1.10.2.2.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.10.2.2.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.2.4. 使用
复制链接

application/yaml

1.10.2.2.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.2.3. 查询单个 helmrelease
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.10.2.3.1. 描述
复制链接

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

1.10.2.3.2. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	helmrelease_name 必需	要查询的 helmrelease 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.10.2.3.3. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.3.4. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.2.4. 删除 helmrelease
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

Copy to Clipboard

Toggle word wrap

1.10.2.4.1. 参数
复制链接

Expand

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	helmrelease_name 必需	要删除的 helmrelease 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.10.2.4.2. 响应
复制链接

Expand

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.10.2.4.3. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.10.3. 定义
复制链接

1.10.3.1. HelmRelease
复制链接

Expand

Name	模式
apiVersion 必需	字符串
kind 必需	字符串
metadata 必需	对象
repo 必需	repo
spec 必需	对象
status 必需	status

repo

Expand

Name	模式
chartName 可选	字符串
configMapRef 可选	configMapRef
secretRef 可选	secretRef
source 可选	source
version 可选	字符串

configMapRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

secretRef

Expand

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

source

Expand

Name	模式
github 可选	github
helmRepo 可选	helmRepo
type 可选	字符串

github

Expand

Name	模式
branch 可选	字符串
chartPath 可选	字符串
urls 可选	字符串数组

helmRepo

Expand

Name	模式
urls 可选	字符串数组

status

Expand

Name	模式
conditions 必需	conditions 数组
deployedRelease 可选	deployedRelease

conditions

Expand

Name	模式
lastTransitionTime 可选	字符串（date-time）
message 可选	字符串
reason 可选	字符串
status 必需	字符串
type 必需	字符串

deployedRelease

Expand

Name	模式
manifest 可选	字符串
name 可选	字符串

返回顶部

1.10. Helm API

1.10.1. 概述
复制链接

1.10.1.1. 版本信息
复制链接

1.10.1.2. URI scheme
复制链接

1.10.1.3. Tags
复制链接

1.10.2. 路径
复制链接

1.10.2.1. 创建 helmrelease
复制链接

1.10.2.1.1. 描述
复制链接

1.10.2.1.2. 参数
复制链接

1.10.2.1.3. 响应
复制链接

1.10.2.1.4. 使用
复制链接

1.10.2.1.5. Tags
复制链接

1.10.2.1.6. HTTP 请求示例
复制链接

1.10.2.1.6.1. 请求正文
复制链接

1.10.2.2. 查询所有 helmreleases
复制链接

1.10.2.2.1. 描述
复制链接

1.10.2.2.2. 参数
复制链接

1.10.2.2.3. 响应
复制链接

1.10.2.2.4. 使用
复制链接

1.10.2.2.5. Tags
复制链接

1.10.2.3. 查询单个 helmrelease
复制链接

1.10.2.3.1. 描述
复制链接

1.10.2.3.2. 参数
复制链接

1.10.2.3.3. 响应
复制链接

1.10.2.3.4. Tags
复制链接

1.10.2.4. 删除 helmrelease
复制链接

1.10.2.4.1. 参数
复制链接

1.10.2.4.2. 响应
复制链接

1.10.2.4.3. Tags
复制链接

1.10.3. 定义
复制链接

1.10.3.1. HelmRelease
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.10. Helm API

1.10.1. 概述复制链接链接已复制到粘贴板!

1.10.1.1. 版本信息复制链接链接已复制到粘贴板!

1.10.1.2. URI scheme复制链接链接已复制到粘贴板!

1.10.1.3. Tags复制链接链接已复制到粘贴板!

1.10.2. 路径复制链接链接已复制到粘贴板!

1.10.2.1. 创建 helmrelease复制链接链接已复制到粘贴板!

1.10.2.1.1. 描述复制链接链接已复制到粘贴板!

1.10.2.1.2. 参数复制链接链接已复制到粘贴板!

1.10.2.1.3. 响应复制链接链接已复制到粘贴板!

1.10.2.1.4. 使用复制链接链接已复制到粘贴板!

1.10.2.1.5. Tags复制链接链接已复制到粘贴板!

1.10.2.1.6. HTTP 请求示例复制链接链接已复制到粘贴板!

1.10.2.1.6.1. 请求正文复制链接链接已复制到粘贴板!

1.10.2.2. 查询所有 helmreleases复制链接链接已复制到粘贴板!

1.10.2.2.1. 描述复制链接链接已复制到粘贴板!

1.10.2.2.2. 参数复制链接链接已复制到粘贴板!

1.10.2.2.3. 响应复制链接链接已复制到粘贴板!

1.10.2.2.4. 使用复制链接链接已复制到粘贴板!

1.10.2.2.5. Tags复制链接链接已复制到粘贴板!

1.10.2.3. 查询单个 helmrelease复制链接链接已复制到粘贴板!

1.10.2.3.1. 描述复制链接链接已复制到粘贴板!

1.10.2.3.2. 参数复制链接链接已复制到粘贴板!

1.10.2.3.3. 响应复制链接链接已复制到粘贴板!

1.10.2.3.4. Tags复制链接链接已复制到粘贴板!

1.10.2.4. 删除 helmrelease复制链接链接已复制到粘贴板!

1.10.2.4.1. 参数复制链接链接已复制到粘贴板!

1.10.2.4.2. 响应复制链接链接已复制到粘贴板!

1.10.2.4.3. Tags复制链接链接已复制到粘贴板!

1.10.3. 定义复制链接链接已复制到粘贴板!

1.10.3.1. HelmRelease复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.10.1. 概述
复制链接

1.10.1.1. 版本信息
复制链接

1.10.1.2. URI scheme
复制链接

1.10.1.3. Tags
复制链接

1.10.2. 路径
复制链接

1.10.2.1. 创建 helmrelease
复制链接

1.10.2.1.1. 描述
复制链接

1.10.2.1.2. 参数
复制链接

1.10.2.1.3. 响应
复制链接

1.10.2.1.4. 使用
复制链接

1.10.2.1.5. Tags
复制链接

1.10.2.1.6. HTTP 请求示例
复制链接

1.10.2.1.6.1. 请求正文
复制链接

1.10.2.2. 查询所有 helmreleases
复制链接

1.10.2.2.1. 描述
复制链接

1.10.2.2.2. 参数
复制链接

1.10.2.2.3. 响应
复制链接

1.10.2.2.4. 使用
复制链接

1.10.2.2.5. Tags
复制链接

1.10.2.3. 查询单个 helmrelease
复制链接

1.10.2.3.1. 描述
复制链接

1.10.2.3.2. 参数
复制链接

1.10.2.3.3. 响应
复制链接

1.10.2.3.4. Tags
复制链接

1.10.2.4. 删除 helmrelease
复制链接

1.10.2.4.1. 参数
复制链接

1.10.2.4.2. 响应
复制链接

1.10.2.4.3. Tags
复制链接

1.10.3. 定义
复制链接

1.10.3.1. HelmRelease
复制链接