ホーム
製品
Red Hat Advanced Cluster Management for Kubernetes
2.13
API
第1章 API

第1章 API

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

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

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

統合コンソールからすべての 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. バージョン情報

Version : 2.13.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

1.1.2.1.1. 説明

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

1.1.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string

1.1.2.1.3. レスポンス

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

1.1.2.2.1. 説明

クラスターの作成

1.1.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Body	body 必須	作成するクラスターを記述するパラメーター	クラスター

1.1.2.2.3. レスポンス

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. 要求の body

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

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

1.1.2.3.1. 説明

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

1.1.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Path	cluster_name 必須	問い合わせるクラスターの名前。	string

1.1.2.3.3. レスポンス

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}

DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}

1.1.2.4.1. 説明

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

1.1.2.4.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
Path	cluster_name 必須	削除するクラスターの名前。	string

1.1.2.4.3. レスポンス

HTTP コード	説明	スキーマ
200	成功	コンテンツなし
403	アクセス禁止	コンテンツなし
404	リソースが見つからない	コンテンツなし
500	内部サービスエラー	コンテンツなし
503	サービスが利用できない	コンテンツなし

1.1.2.4.4. タグ

cluster.open-cluster-management.io

1.1.3. 定義

1.1.3.1. クラスター

名前	説明	スキーマ
apiVersion 必須	`ManagedCluster` のバージョン管理されたスキーマ。	string
kind 必須	REST リソースを表す文字列の値	string
metadata 必須	`ManagedCluster` のメタデータ。	object
spec 必須	`ManagedCluster` の仕様。	spec

spec

名前	説明	スキーマ
hubAcceptsClient 必須	ハブがマネージドクラスター上の klusterlet エージェントとの接続を確立できるかどうかを指定します。デフォルト値は `false` で、ハブクラスターに RBAC ルールが設定されている場合にのみ `true` に変更できます。これにより、`managedclusters/accept` の仮想サブリソースを更新できます。	bool
managedClusterClientConfigs 任意	マネージドクラスターの apiserver アドレスを一覧表示します。	managedClusterClientConfigs array
leaseDurationSeconds 任意	マネージドクラスター上の klusterlet エージェントのリース更新時間間隔を指定します。デフォルトでは、klusterlet エージェントはそのリースを 60 秒ごとに更新します。	integer (int32)
taints 任意	スケジューリング中にマネージドクラスターが 1 つ以上のマネージドクラスターセットに割り当てられないようにします。	taint array

managedClusterClientConfigs

名前	説明	スキーマ
URL 必須		string
CABundle 任意	Pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"	string (バイト)

名前

説明

スキーマ

URL
必須

string

CABundle
任意

Pattern:

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

string (バイト)

taint

名前	説明	スキーマ
key 必須	クラスターに適用される taint キー。	string
value 任意	テイントキーに対応する taint 値。	string
effect 任意	taint を許容しない配置に対する taint の影響。有効な値は `NoSelect`、`PreferNoSelect`、および `NoSelectIfNew` です。	string

トップに戻る