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

1.20. ClusterManagementAddOn API (v1alpha1)

非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。

1.20.1. 概要
リンクのコピー

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

ClusterManagementAddOn は、クラスターマネージャーへのアドオンの登録を表します。このリソースを使用すると、ユーザーはクラスターマネージャーで使用できるアドオンを見つけ、アドオンに関するメタデータ情報を取得できます。このリソースは、namespace のスコープが指定された ManagedClusterAddOn リソースに使用される ClusterManagementAddOn リソースの名前である ManagedClusterAddOn への参照も指定します。ClusterManagementAddOn はクラスターのスコープが指定されたリソースです。

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

バージョン: 2.14.0

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

BasePath: /kubernetes/apis
Schemes: HTTPS

1.20.1.3. タグ
リンクのコピー

  • addon.open-cluster-management.io: ClusterManagementAddOns の作成と管理

1.20.2. パス
リンクのコピー

1.20.2.1. Query all ClusterManagementAddOns
リンクのコピー

GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
Copy to Clipboard Toggle word wrap
1.20.2.1.1. 説明
リンクのコピー

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

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

Header

COOKIE
必須

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

string

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.20.2.1.4. 消費されるアイテム
リンクのコピー
  • clustermanagementaddon/yaml
1.20.2.1.5. タグ
リンクのコピー
  • addon.open-cluster-management.io

1.20.2.2. Create a ClusterManagementAddOn
リンクのコピー

POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
Copy to Clipboard Toggle word wrap
1.20.2.2.1. 説明
リンクのコピー

ClusterManagementAddOn を作成します。

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

Header

COOKIE
必須

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

string

Body

body
必須

作成する ClusterManagementAddon バインディングを記述するパラメーター。

ClusterManagementAddOn

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.20.2.2.4. 消費されるアイテム
リンクのコピー
  • clustermanagementaddon/yaml
1.20.2.2.5. タグ
リンクのコピー
  • addon.open-cluster-management.io
1.20.2.2.6. HTTP リクエストの例
リンクのコピー
1.20.2.2.6.1. リクエストのボディー
リンクのコピー
{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "ClusterManagementAddOn",
  "metadata": {
    "name": "helloworld"
  },
  "spec": {
    "supportedConfigs": [
      {
        "defaultConfig": {
          "name": "deploy-config",
          "namespace": "open-cluster-management-hub"
        },
        "group": "addon.open-cluster-management.io",
        "resource": "addondeploymentconfigs"
      }
    ]
  },
  "status" : { }
}
Copy to Clipboard Toggle word wrap

1.20.2.3. Query a single ClusterManagementAddOn
リンクのコピー

GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
Copy to Clipboard Toggle word wrap
1.20.2.3.1. 説明
リンクのコピー

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

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

Header

COOKIE
必須

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

string

Path

clustermanagementaddon_name
必須

クエリーを実行する ClusterManagementAddOn の名前。

string

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.20.2.3.4. タグ
リンクのコピー
  • addon.open-cluster-management.io

1.20.2.4. ClusterManagementAddOn の削除
リンクのコピー

DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
Copy to Clipboard Toggle word wrap
1.20.2.4.1. 説明
リンクのコピー

1 つの ClusterManagementAddOn を削除します。

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

Header

COOKIE
必須

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

string

Path

clustermanagementaddon_name
必須

削除する ClusterManagementAddOn の名前。

string

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.20.2.4.4. タグ
リンクのコピー
  • addon.open-cluster-management.io

1.20.3. 定義
リンクのコピー

1.20.3.1. ClusterManagementAddOn
リンクのコピー

Expand
名前説明スキーマ

apiVersion
必須

ClusterManagementAddOn のバージョン管理されたスキーマ。

string

kind
必須

REST リソースを表す文字列の値

string

metadata
必須

ClusterManagementAddOn のメタデータ。

object

spec
必須

ClusterManagementAddOn の仕様。

spec

spec

Expand
名前説明スキーマ

addOnMeta
任意

AddOnMeta は、アドオンのメタデータ情報への参照です。

addOnMeta

supportedConfigs
任意

SupportedConfigs は、アドオンでサポートされる設定タイプのリストです。

configMeta array

addOnMeta

Expand
名前説明スキーマ

displayName
任意

表示されるアドオンの名前を表します。

string

description
任意

アドオンの詳細な説明を表します。

string

configMeta

Expand
名前説明スキーマ

group
任意

アドオン設定のグループ。

string

resource
必須

アドオン設定のリソース。

string

defaultConfig
必須

デフォルトのアドオン設定の namespace と名前を表します。すべてのアドオンで同じ設定になります。

configReferent

configReferent

Expand
名前説明スキーマ

namespace
任意

アドオン設定の namespace。このフィールドが設定されていない場合、設定は cluster-scope になります。

string

name
必須

アドオン設定の名前。

string

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat