11.7. PlacementDecisions API (v1alpha1)
11.7.1. 概要
このドキュメントは、Kubernetes のマルチクラスターエンジンの PlacementDecision リソースを対象としています。PlacementDecision リソースには、create、query、delete、update の 4 つの要求を使用できます。
11.7.1.1. URI スキーム
ベースパス: /kubernetes/apis
スキーム: HTTPS
11.7.1.2. タグ
- cluster.open-cluster-management.io: PlacementDecision を作成して管理します。
11.7.2. パス
11.7.2.1. 全 PlacementDecision のクエリー
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions11.7.2.1.1. 説明
PlacementDecisions に対してクエリーを実行して詳細を確認します。
11.7.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
11.7.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.7.2.1.4. 消費
-
placementdecision/yaml
11.7.2.1.5. タグ
- cluster.open-cluster-management.io
11.7.2.2. PlacementDecision の作成
POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions11.7.2.2.1. 説明
PlacementDecisions を作成します。
11.7.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| ボディー |
body | 作成する PlacementDecision を記述するパラメーター |
11.7.2.2.3. 応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.7.2.2.4. 消費
-
placementdecision/yaml
11.7.2.2.5. タグ
- cluster.open-cluster-management.io
11.7.2.2.6. HTTP 要求の例
11.7.2.2.6.1. 要求のボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1alpha1",
"kind" : "PlacementDecision",
"metadata" : {
"labels" : {
"cluster.open-cluster-management.io/placement" : "placement1"
},
"name" : "placement1-decision1",
"namespace": "ns1"
},
"status" : { }
}11.7.2.3. 単一の PlacementDecision のクエリー
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}11.7.2.3.1. 説明
1 つの PlacementDecisions に対してクエリーを実行して詳細を確認します。
11.7.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
placementdecision_name | 問い合わせる PlacementDecision の名前 | 文字列 |
11.7.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.7.2.3.4. タグ
- cluster.open-cluster-management.io
11.7.2.4. PlacementDecision の削除
DELETE /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/placementdecisions/{placementdecision_name}11.7.2.4.1. 説明
単一の PlacementDecision を削除します。
11.7.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
placementdecision_name | 削除する PlacementDecision の名前 | 文字列 |
11.7.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
11.7.2.4.4. タグ
- cluster.open-cluster-management.io
11.7.3. 定義
11.7.3.1. PlacementDecision
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | PlacementDecision のバージョンスキーマ | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | PlacementDecision のメタデータ | オブジェクト |
