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

第1章 API

API にアクセスして、アプリケーションリソース、チャネル、サブスクリプションの作成や管理、さらに情報のクエリーを行うことができます。

ユーザーに必要なアクセス権: ロールが割り当てられているアクションのみを実行できます。ロールベースのアクセス制御 のドキュメントで、アクセス要件を確認してください。

統合コンソールからすべての API にアクセスすることもできます。local-cluster ビューから、Home > API Explorer に移動して、API グループを確認します。

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

1.1. Clusters API
リンクのコピー

1.1.1. 概要
リンクのコピー

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のクラスターリソースを説明します。Cluster リソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedCluster はマネージドクラスターの望ましい状態と現在の状態を表します。ManagedCluster はクラスタースコープのリソースです。

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

バージョン: 2.12.0

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

BasePath: /kubernetes/apis
Schemes: HTTPS

1.1.1.3. タグ
リンクのコピー

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

1.1.2. パス
リンクのコピー

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

GET /cluster.open-cluster-management.io/v1/managedclusters
Copy to Clipboard Toggle word wrap
1.1.2.1.1. 説明
リンクのコピー

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

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

Header

COOKIE
必須

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

string

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

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

POST /cluster.open-cluster-management.io/v1/managedclusters
Copy to Clipboard Toggle word wrap
1.1.2.2.1. 説明
リンクのコピー

クラスターの作成

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

Header

COOKIE
必須

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

string

Body

body
必須

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

クラスター

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.1.2.2.4. 消費されるアイテム
リンクのコピー
  • cluster/yaml
1.1.2.2.5. タグ
リンクのコピー
  • 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" : { }
}
Copy to Clipboard Toggle word wrap

1.1.2.3. 単一クラスターのクエリー
リンクのコピー

GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
Copy to Clipboard Toggle word wrap
1.1.2.3.1. 説明
リンクのコピー

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

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

Header

COOKIE
必須

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

string

Path

cluster_name
必須

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

string

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

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

DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
Copy to Clipboard Toggle word wrap 
DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
Copy to Clipboard Toggle word wrap
1.1.2.4.1. 説明
リンクのコピー

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

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

Header

COOKIE
必須

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

string

Path

cluster_name
必須

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

string

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

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

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

1.1.3. 定義
リンクのコピー

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

Expand
名前説明スキーマ

apiVersion
必須

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

string

kind
必須

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

string

metadata
必須

ManagedCluster のメタデータ。

object

spec
必須

ManagedCluster の仕様。

spec

spec

Expand
名前説明スキーマ

hubAcceptsClient
必須

ハブがマネージドクラスター上の klusterlet エージェントとの接続を確立できるかどうかを指定します。デフォルト値は false で、ハブクラスターに RBAC ルールが設定されている場合にのみ true に変更できます。これにより、managedclusters/accept の仮想サブリソースを更新できます。

bool

managedClusterClientConfigs
任意

マネージドクラスターの apiserver アドレスを一覧表示します。

managedClusterClientConfigs array

leaseDurationSeconds
任意

マネージドクラスター上の klusterlet エージェントのリース更新時間間隔を指定します。デフォルトでは、klusterlet エージェントはそのリースを 60 秒ごとに更新します。

integer (int32)

taints
任意

スケジューリング中にマネージドクラスターが 1 つ以上のマネージドクラスターセットに割り当てられないようにします。

taint array

managedClusterClientConfigs

Expand
名前説明スキーマ

URL
必須

 

string

CABundle
任意

Pattern: 

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

string (バイト)

taint

Expand
名前説明スキーマ

key
必須

クラスターに適用される taint キー。

string

value
任意

テイントキーに対応する taint 値。

string

effect
任意

taint を許容しない配置に対する taint の影響。有効な値は NoSelect、PreferNoSelect、および NoSelectIfNew です。

string

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat