Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

1.9. Helm API

1.9.1. 概要
リンクのコピー

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の HelmRelease リソースについて説明します。HelmRelease リソースには、create、query、delete、update の 4 つの要求を使用できます。

1.9.1.1. バージョン情報
リンクのコピー

Version: 2.8.0

1.9.1.2. URI スキーム
リンクのコピー

ベースパス: /kubernetes/apis
スキーム: HTTPS

1.9.1.3. タグ
リンクのコピー

  • helmreleases.apps.open-cluster-management.io: helmreleases を作成して管理します。

1.9.2. パス
リンクのコピー

1.9.2.1. helmrelease の作成
リンクのコピー

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
Copy to Clipboard Toggle word wrap
1.9.2.1.1. 説明
リンクのコピー

helmrelease を作成します。

1.9.2.1.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

namespace
必須

使用する namespace (例: default)

string

Body

body
必須

作成する helmrelease を記述するパラメーター

HelmRelease

1.9.2.1.3. 応答
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.1.4. 消費
リンクのコピー
  • application/yaml
1.9.2.1.5. タグ
リンクのコピー
  • helmreleases.apps.open-cluster-management.io
1.9.2.1.6. HTTP リクエストの例
リンクのコピー
1.9.2.1.6.1. 要求の body
リンクのコピー
{
  "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.9.2.2. 全 helmrelease のクエリー
リンクのコピー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
Copy to Clipboard Toggle word wrap
1.9.2.2.1. 説明
リンクのコピー

helmrelease に対してクエリーを実行して詳細を確認します。

1.9.2.2.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

namespace
必須

使用する namespace (例: default)

string

1.9.2.2.3. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.2.4. 消費
リンクのコピー
  • application/yaml
1.9.2.2.5. タグ
リンクのコピー
  • helmreleases.apps.open-cluster-management.io

1.9.2.3. 単一の helmrelease のクエリー
リンクのコピー

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
Copy to Clipboard Toggle word wrap
1.9.2.3.1. 説明
リンクのコピー

1 つの helmrelease に対してクエリーを実行して詳細を確認します。

1.9.2.3.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

helmrelease_name
必須

問い合わせる helmrelease の名前

string

パス

namespace
必須

使用する namespace (例: default)

string

1.9.2.3.3. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.3.4. タグ
リンクのコピー
  • helmreleases.apps.open-cluster-management.io

1.9.2.4. helmrelease の削除
リンクのコピー

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
Copy to Clipboard Toggle word wrap
1.9.2.4.1. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

Header

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

string

パス

helmrelease_name
必須

削除する helmrelease の名前

string

パス

namespace
必須

使用する namespace (例: default)

string

1.9.2.4.2. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.9.2.4.3. タグ
リンクのコピー
  • helmreleases.apps.open-cluster-management.io

1.9.3. 定義
リンクのコピー

1.9.3.1. HelmRelease
リンクのコピー

Expand
Nameスキーマ

apiVersion
必須

string

kind
必須

string

metadata
必須

object

repo
必須

repo

spec
必須

object

status
必須

status

repo

Expand
Nameスキーマ

chartName
任意

string

configMapRef
任意

configMapRef

secretRef
任意

secretRef

source
任意

比較元

version
任意

string

configMapRef

Expand
Nameスキーマ

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

secretRef

Expand
Nameスキーマ

apiVersion
任意

string

fieldPath
任意

string

kind
任意

string

name
任意

string

namespace
任意

string

resourceVersion
任意

string

uid
任意

string

source

Expand
Nameスキーマ

github
任意

github

helmRepo
任意

helmRepo

type
任意

string

github

Expand
Nameスキーマ

branch
任意

string

chartPath
任意

string

urls
任意

string array

helmRepo

Expand
Nameスキーマ

urls
任意

string array

status

Expand
Nameスキーマ

conditions
必須

conditions array

deployedRelease
任意

deployedRelease

conditions

Expand
Nameスキーマ

lastTransitionTime
任意

string (date-time)

message
任意

string

reason
任意

string

status
必須

string

type
必須

string

deployedRelease

Expand
Nameスキーマ

manifest
任意

string

name
任意

string

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat