1.3. Clustersetbindings API (v1beta2)

1.3.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterSetBinding リソースについて説明します。ClusterSetBinding リソースには、create、query、delete、update の 4 つのリクエストを使用できます。ManagedClusterSetBinding は、ManagedClusterSet を特定の namespace に投影します。managedclustersets/bind の仮想サブリソースでの create を許可する RBAC ルールがある場合は、namespace で ManagedClusterSetBinding を作成し、ManagedClusterSet にバインドできます。

1.3.1.1. バージョン情報

バージョン: 2.9.0

1.3.1.2. URI スキーム

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

1.3.1.3. タグ

cluster.open-cluster-management.io: clustersetbinding を作成して管理します。

1.3.2. パス

1.3.2.1. 全 clustersetbinding のクエリー

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings

1.3.2.1.1. 説明

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

1.3.2.1.2. パラメーター

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

1.3.2.1.3. レスポンス

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

1.3.2.1.4. 消費

clustersetbinding/yaml

1.3.2.1.5. タグ

cluster.open-cluster-management.io

1.3.2.2. clustersetbinding の作成

POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings

1.3.2.2.1. 説明

clustersetbinding を作成します。

1.3.2.2.2. パラメーター

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

1.3.2.2.3. レスポンス

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

1.3.2.2.4. 消費

clustersetbinding/yaml

1.3.2.2.5. タグ

cluster.open-cluster-management.io

1.3.2.2.6. HTTP リクエストの例

1.3.2.2.6.1. 要求の body

{
  "apiVersion" : "cluster.open-cluster-management.io/v1beta2",
  "kind" : "ManagedClusterSetBinding",
  "metadata" : {
    "name" : "clusterset1",
    "namespace" : "ns1"
  },
 "spec": {
    "clusterSet": "clusterset1"
  },
  "status" : { }
}

1.3.2.3. 単一 clustersetbinding のクエリー

GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}

1.3.2.3.1. 説明

単一の clustersetbinding に対してクエリーを実行して詳細を確認します。

1.3.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: `default`)	string
パス	clustersetbinding_name 必須	問い合わせる clustersetbinding の名前	string

1.3.2.3.3. レスポンス

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

1.3.2.3.4. タグ

cluster.open-cluster-management.io

1.3.2.4. clustersetbinding の削除

DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}

1.3.2.4.1. 説明

単一 clustersetbinding を削除します。

1.3.2.4.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: `default`)	string
パス	clustersetbinding_name 必須	削除する clustersetbinding の名前	string

1.3.2.4.3. レスポンス

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

1.3.2.4.4. タグ

cluster.open-cluster-management.io

1.3.3. 定義

1.3.3.1. Clustersetbinding

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

spec

名前	説明	スキーマ
clusterSet 必須	バインドする `ManagedClusterSet` の名前。`ManagedClusterSetBinding` のインスタンス名と一致する必要があり、作成後に変更することはできません。	string