Language:
Format:

Language:
Format:

11.3. Clusterview API (v1alpha1)

11.3.1. 概要

このドキュメントは、Kubernetes のマルチクラスターエンジンの clusterview リソースを対象としています。clusterview リソースには、アクセス可能なマネージドクラスターおよびマネージドクラスターセットの一覧を表示できる CLI コマンドが含まれます。使用できる要求は、list、get、および watch の 3 つです。

11.3.1.1. URI スキーム

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

11.3.1.2. タグ

clusterview.open-cluster-management.io: お使いの ID がアクセスできるマネージドクラスターの一覧を表示します。

11.3.2. パス

11.3.2.1. マネージドクラスターの取得

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

11.3.2.1.1. 説明

アクセス可能なマネージドクラスターの一覧を表示します。

11.3.2.1.2. パラメーター

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

11.3.2.1.3. レスポンス

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

11.3.2.1.4. 消費

managedcluster/yaml

11.3.2.1.5. タグ

clusterview.open-cluster-management.io

11.3.2.2. マネージドクラスターの一覧表示

LIST /managedclusters.clusterview.open-cluster-management.io

11.3.2.2.1. 説明

アクセス可能なマネージドクラスターの一覧を表示します。

11.3.2.2.2. パラメーター

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
ボディー	body 任意	マネージドクラスターを一覧表示するユーザー ID の名前	文字列

11.3.2.2.3. レスポンス

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

11.3.2.2.4. 消費

managedcluster/yaml

11.3.2.2.5. タグ

clusterview.open-cluster-management.io

11.3.2.2.6. HTTP 要求の例

11.3.2.2.6.1. 要求のボディー

{
  "apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
  "kind" : "ClusterView",
  "metadata" : {
    "name" : "<user_ID>"
  },
  "spec": { },
  "status" : { }
}

11.3.2.3. マネージドクラスターセットの監視

WATCH /managedclusters.clusterview.open-cluster-management.io

11.3.2.3.1. 説明

アクセス可能なマネージドクラスターを確認します。

11.3.2.3.2. パラメーター

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
パス	clusterview_name 任意	監視するユーザー ID の名前	文字列

11.3.2.3.3. レスポンス

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

11.3.2.4. マネージドクラスターセットの一覧表示

GET /managedclustersets.clusterview.open-cluster-management.io

11.3.2.4.1. 説明

アクセス可能なマネージドクラスターを一覧表示します。

11.3.2.4.2. パラメーター

型	名前	説明	スキーマ
ヘッダー	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	文字列
パス	clusterview_name 任意	監視するユーザー ID の名前	文字列

11.3.2.4.3. レスポンス

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

11.3.2.5. マネージドクラスターセットの一覧表示

LIST /managedclustersets.clusterview.open-cluster-management.io

11.3.2.5.1. 説明