11.4. Clustersetbindings API (v1alpha1)
11.4.1. 概要
このドキュメントは、Kubernetes のマルチクラスターエンジンの clustersetbinding リソースを対象としています。clustersetbinding リソースには、create、query、delete、update の 4 つの要求を使用できます。
11.4.1.1. URI スキーム
ベースパス: /kubernetes/apis
スキーム: HTTPS
11.4.1.2. タグ
- cluster.open-cluster-management.io: clustersetbinding を作成して管理します。
11.4.2. パス
11.4.2.1. 全 clustersetbinding のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings11.4.2.1.1. 説明
clustersetbinding に対してクエリーを実行して詳細を確認します。
11.4.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
11.4.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.4.2.1.4. 消費
-
clustersetbinding/yaml
11.4.2.1.5. タグ
- cluster.open-cluster-management.io
11.4.2.2. clustersetbinding の作成
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings11.4.2.2.1. 説明
clustersetbinding を作成します。
11.4.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成する clustersetbinding を記述するパラメーター |
11.4.2.2.3. 応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.4.2.2.4. 消費
-
clustersetbinding/yaml
11.4.2.2.5. タグ
- cluster.open-cluster-management.io
11.4.2.2.6. HTTP 要求の例
11.4.2.2.6.1. 要求のボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1",
"kind" : "ManagedClusterSetBinding",
"metadata" : {
"name" : "clusterset1",
"namespace" : "ns1"
},
"spec": {
"clusterSet": "clusterset1"
},
"status" : { }
}11.4.2.3. 単一 clustersetbinding のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}11.4.2.3.1. 説明
単一の clustersetbinding に対してクエリーを実行して詳細を確認します。
11.4.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
clustersetbinding_name | 問い合わせる clustersetbinding の名前 | 文字列 |
11.4.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.4.2.3.4. タグ
- cluster.open-cluster-management.io
11.4.2.4. clustersetbinding の削除
DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersetbindings/{clustersetbinding_name}11.4.2.4.1. 説明
単一 clustersetbinding を削除します。
11.4.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
clustersetbinding_name | 削除する clustersetbinding の名前 | 文字列 |
11.4.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.4.2.4.4. タグ
- cluster.open-cluster-management.io
11.4.3. 定義
11.4.3.1. Clustersetbinding
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | スキーマ |
|---|---|
|
clusterSet | string |
