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

1.12. API

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

multicluster engine Operator を使用して、クラスターライフサイクル管理用の次の API にアクセスできます。ユーザーに必要なアクセス権: ロールが割り当てられているアクションのみを実行できます。

注記:

  • 統合コンソールからすべての API にアクセスすることもできます。Administrator パースペクティブを選択し、Home > API Explorer に移動して API グループを調べます。
  • Red Hat OpenShift Container Platform バージョン 4.20 より前のバージョンの場合は、クラスタースイッチャーから local-cluster を選択します。次に、Home > API Explorer を選択して、API グループを調べます。

詳細は、以下の各リソースに関する API のドキュメントを参照してください。

1.12.1. Clusters API
リンクのコピー

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

1.12.1.1. 概要
リンクのコピー

このドキュメントは、multicluster engine for Kubernetes Operator の Cluster リソースに関するものです。Cluster リソースには、create、query、delete、update の 4 つの要求を使用できます。

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

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

1.12.1.3. タグ
リンクのコピー

  • cluster.open-cluster-management.io: クラスターを作成して管理します。

1.12.1.4. パス
リンクのコピー

1.12.1.5. 全クラスターのクエリー
リンクのコピー

GET /cluster.open-cluster-management.io/v1/managedclusters

1.12.1.6. 説明
リンクのコピー

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

1.12.1.7. パラメーター
リンクのコピー

Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

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

string

1.12.1.8. レスポンス
リンクのコピー

Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.1.9. 消費されるアイテム
リンクのコピー

  • cluster/yaml

1.12.1.10. タグ
リンクのコピー

  • cluster.open-cluster-management.io

1.12.1.11. クラスターの作成
リンクのコピー

POST /cluster.open-cluster-management.io/v1/managedclusters

1.12.1.12. 説明
リンクのコピー

クラスターの作成

1.12.1.13. パラメーター
リンクのコピー

Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

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

string

本文

body
必須

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

クラスター

1.12.1.14. レスポンス
リンクのコピー

Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.1.15. 消費されるアイテム
リンクのコピー

  • cluster/yaml

1.12.1.16. タグ
リンクのコピー

  • cluster.open-cluster-management.io

1.12.1.17. HTTP リクエストボディーの例
リンクのコピー

{
  "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.12.1.18. 単一クラスターのクエリー
リンクのコピー

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

1.12.1.19. 説明
リンクのコピー

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

1.12.1.20. パラメーター
リンクのコピー

Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

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

string

パス

cluster_name
必須

問い合わせるクラスターの名前。

string

1.12.1.21. レスポンス
リンクのコピー

Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.1.22. タグ
リンクのコピー

  • cluster.open-cluster-management.io

1.12.1.23. クラスターの削除
リンクのコピー

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}

1.12.1.24. 説明
リンクのコピー

単一クラスターを削除します。

1.12.1.25. パラメーター
リンクのコピー

Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

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

string

パス

cluster_name
必須

削除するクラスターの名前。

string

1.12.1.26. レスポンス
リンクのコピー

Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.12.1.27. タグ
リンクのコピー

  • cluster.open-cluster-management.io

1.12.1.28. 定義
リンクのコピー

1.12.1.29. クラスター
リンクのコピー

Expand
名前スキーマ

apiVersion
必須

文字列

kind
必須

文字列

metadata
必須

オブジェクト

spec
必須

spec

spec

Expand
名前スキーマ

hubAcceptsClient
必須

ブール型

managedClusterClientConfigs
任意

< managedClusterClientConfigs > array

leaseDurationSeconds
任意

整数 (int32)

managedClusterClientConfigs

Expand
名前説明スキーマ

URL
必須

 

文字列

cabundle
任意

Pattern: 

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

string (バイト)

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

会社概要

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

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

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

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

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

Legal Notice

Theme

© 2026 Red Hatトップに戻る