1.2. Clustersets API (v1beta1)
1.2.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Clusterset リソースについて説明します。Clusterset リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.2.1.1. バージョン情報
バージョン: 2.5.0
1.2.1.2. URI スキーム
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.2.1.3. タグ
- cluster.open-cluster-management.io: Clustersets を作成して管理します。
1.2.2. パス
1.2.2.1. 全 clusterset のクエリー
GET /cluster.open-cluster-management.io/v1beta1/managedclustersets
GET /cluster.open-cluster-management.io/v1beta1/managedclustersets
1.2.2.1.1. 説明
Clustersets に対してクエリーを実行して詳細を確認します。
1.2.2.1.2. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
1.2.2.1.3. レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 成功 | コンテンツなし |
403 | アクセス禁止 | コンテンツなし |
404 | リソースが見つからない | コンテンツなし |
500 | 内部サービスエラー | コンテンツなし |
503 | サービスが利用できない | コンテンツなし |
1.2.2.1.4. 消費
-
clusterset/yaml
1.2.2.1.5. タグ
- cluster.open-cluster-management.io
1.2.2.2. clusterset の作成
POST /cluster.open-cluster-management.io/v1beta1/managedclustersets
POST /cluster.open-cluster-management.io/v1beta1/managedclustersets
1.2.2.2.1. 説明
Clusterset を作成します。
1.2.2.2.2. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
ボディー |
body | 作成する clusterset を記述するパラメーター |
1.2.2.2.3. 応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 成功 | コンテンツなし |
403 | アクセス禁止 | コンテンツなし |
404 | リソースが見つからない | コンテンツなし |
500 | 内部サービスエラー | コンテンツなし |
503 | サービスが利用できない | コンテンツなし |
1.2.2.2.4. 消費
-
clusterset/yaml
1.2.2.2.5. タグ
- cluster.open-cluster-management.io
1.2.2.2.6. HTTP 要求の例
1.2.2.2.6.1. 要求のボディー
{ "apiVersion": "cluster.open-cluster-management.io/v1beta1", "kind": "ManagedClusterSet", "metadata": { "name": "clusterset1" }, "spec": { "clusterSelector": { "selectorType": "LegacyClusterSetLabel" } }, "status": {} }
{
"apiVersion": "cluster.open-cluster-management.io/v1beta1",
"kind": "ManagedClusterSet",
"metadata": {
"name": "clusterset1"
},
"spec": {
"clusterSelector": {
"selectorType": "LegacyClusterSetLabel"
}
},
"status": {}
}
1.2.2.3. 単一 clusterset のクエリー
GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
GET /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
1.2.2.3.1. 説明
単一の clusterset に対してクエリーを実行して詳細を確認します。
1.2.2.3.2. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
パス |
clusterset_name | 問い合わせる clusterset の名前。 | 文字列 |
1.2.2.3.3. レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 成功 | コンテンツなし |
403 | アクセス禁止 | コンテンツなし |
404 | リソースが見つからない | コンテンツなし |
500 | 内部サービスエラー | コンテンツなし |
503 | サービスが利用できない | コンテンツなし |
1.2.2.3.4. タグ
- cluster.open-cluster-management.io
1.2.2.4. clusterset の削除
DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
DELETE /cluster.open-cluster-management.io/v1beta1/managedclustersets/{clusterset_name}
1.2.2.4.1. 説明
単一 clusterset を削除します。
1.2.2.4.2. パラメーター
型 | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
パス |
clusterset_name | 削除する clusterset の名前。 | 文字列 |
1.2.2.4.3. レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 成功 | コンテンツなし |
403 | アクセス禁止 | コンテンツなし |
404 | リソースが見つからない | コンテンツなし |
500 | 内部サービスエラー | コンテンツなし |
503 | サービスが利用できない | コンテンツなし |
1.2.2.4.4. タグ
- cluster.open-cluster-management.io
1.2.3. 定義
1.2.3.1. Clusterset
名前 | スキーマ |
---|---|
apiVersion | string |
kind | string |
metadata | object |