API
API
概要
第1章 API リンクのコピーリンクがクリップボードにコピーされました!
API にアクセスして、アプリケーションリソース、チャネル、サブスクリプションの作成や管理、さらに情報のクエリーを行うことができます。
必要なユーザーアクセス権: ロールが割り当てられているアクションのみを実行できます。「ロールベースのアクセス制御」のドキュメントで、アクセス要件について確認してください。
詳細は、以下のリソースに関する API のドキュメントを参照してください。
1.1. Clusters API リンクのコピーリンクがクリップボードにコピーされました!
1.1.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のクラスターリソースについて説明します。クラスターリソースには、create、query、delete、update の 4 つの要求を使用できます。
1.1.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.1.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.1.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.1.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.1.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io: クラスターを作成して管理します。
1.1.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.1.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.1.2.1. 全クラスターのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /cluster.open-cluster-management.io/v1/managedclusters
GET /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
クラスターに対してクエリーを実行して詳細を確認します。
1.1.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
1.1.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
cluster/yaml
1.1.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io
1.1.2.2. クラスターを作成します。 リンクのコピーリンクがクリップボードにコピーされました!
POST /cluster.open-cluster-management.io/v1/managedclusters
POST /cluster.open-cluster-management.io/v1/managedclusters
1.1.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
クラスターを作成します。
1.1.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| ボディー |
body | 作成するクラスターを記述するパラメーター |
1.1.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
cluster/yaml
1.1.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io
1.1.2.2.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.1.2.2.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.1.2.3. 単一クラスターのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
1.1.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つのクラスターに対してクエリーを実行して詳細を確認します。
1.1.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
cluster_name | 問い合わせるクラスターの名前。 | 文字列 |
1.1.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io
1.1.2.4. クラスターを削除します。 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
1.1.2.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一クラスターの削除
1.1.2.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
cluster_name | 削除するクラスターの名前。 | 文字列 |
1.1.2.4.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.4.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io
1.1.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.1.3.1. クラスター リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | Schema |
|---|---|
|
hubAcceptsClient | bool |
|
managedClusterClientConfigs | < managedClusterClientConfigs > array |
|
leaseDurationSeconds | 整数 (int32) |
managedClusterClientConfigs
| 名前 | 説明 | Schema |
|---|---|---|
|
URL | string | |
|
cabundle |
パターン : | 文字列 (バイト) |
1.2. Clustersets API (v1alpha1) リンクのコピーリンクがクリップボードにコピーされました!
1.2.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のクラスターセットリソースについて説明します。クラスターセットリソースには、create、query、delete、update の 4 つの要求を使用できます。
1.2.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.2.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.2.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.2.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io: クラスターセットを作成して管理します。
1.2.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.2.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.2.2.1. 全クラスターセットのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets
GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets
1.2.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
クラスターセットに対してクエリーを実行して詳細を確認します。
1.2.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
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. クラスターセットの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /cluster.open-cluster-management.io/v1alpha1/managedclustersets
POST /cluster.open-cluster-management.io/v1alpha1/managedclustersets
1.2.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
クラスターセットの作成
1.2.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| ボディー |
body | 作成するクラスターセットを記述するパラメーター |
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. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.2.2.3. 単一クラスターセットのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
GET /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
1.2.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一のクラスターセットに対してクエリーを実行して詳細を確認します。
1.2.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
clusterset_name | 問い合わせるクラスターセットの名前。 | 文字列 |
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. クラスターセットの削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersets/{clusterset_name}
1.2.2.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一クラスターセットの削除
1.2.2.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
clusterset_name | 削除するクラスターセットの名前。 | 文字列 |
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. クラスターセット リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
1.3. Clustersetbindings API (v1alpha1) リンクのコピーリンクがクリップボードにコピーされました!
1.3.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の clustersetbinding リソースについて説明します。clustersetbinding リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.3.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.3.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.3.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.3.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.3.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- cluster.open-cluster-management.io: clustersetbinding を作成して管理します。
1.3.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.3.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.3.2.1. 全 clustersetbinding のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
1.3.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
clustersetbinding に対してクエリーを実行して詳細を確認します。
1.3.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
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/v1alpha1/namespaces/{namespace}/managedclustersetbindings
POST /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings
1.3.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
clustersetbinding の作成
1.3.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成する 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. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.3.2.3. 単一 clustersetbinding のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
GET /cluster.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}
1.3.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一の clustersetbinding に対してクエリーを実行して詳細を確認します。
1.3.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
clustersetbinding_name | 問い合わせる clustersetbinding の名前。 | 文字列 |
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/v1alpha1/managedclustersetbindings/{clustersetbinding_name}
DELETE /cluster.open-cluster-management.io/v1alpha1/managedclustersetbindings/{clustersetbinding_name}
1.3.2.4.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一 clustersetbinding の削除
1.3.2.4.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
clustersetbinding_name | 削除する clustersetbinding の名前。 | 文字列 |
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 リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | Schema |
|---|---|
|
clusterSet | string |
1.4. Channels API リンクのコピーリンクがクリップボードにコピーされました!
1.4.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のチャネルリソースについて説明します。チャネルリソースには、create、query、delete、update の 4 つの要求を使用できます。
1.4.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.4.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.4.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.4.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.4.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- channels.apps.open-cluster-management.io : deployable を作成して管理します。
1.4.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.4.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.4.2.1. チャネルの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.4.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
チャネルを作成します。
1.4.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成する deployable を記述するパラメーター |
1.4.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.4.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- channels.apps.open-cluster-management.io
1.4.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.4.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.4.2.2. ターゲット namespace の全チャネルのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels
1.4.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
チャネルに対してクエリーを実行して詳細を確認します。
1.4.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.4.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.4.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- channels.apps.open-cluster-management.io
1.4.2.3. namespace の単一チャネルのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.4.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一のチャネルに対してクエリーを実行して詳細を確認します。
1.4.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
channel_name | 問い合わせる deployable の名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.4.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- channels.apps.open-cluster-management.io
1.4.2.4. チャネルの削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}
1.4.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
channel_name | 削除するチャネルの名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.4.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- channels.apps.open-cluster-management.io
1.4.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.4.3.1. チャネル リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| Name (名前) | 説明 | Schema |
|---|---|---|
|
configMapRef | ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 | |
|
gates | ChannelGate はチャネルにプロモートする基準を定義します。 | |
|
pathname | string | |
|
secretRef | ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 | |
|
sourceNamespaces | < enum (Namespace, HelmRepo, ObjectBucket, Git, namespace, helmrepo, objectbucket, github) > 配列 |
configMapRef
| 名前 | 説明 | Schema |
|---|---|---|
|
apiVersion | 参照先の API バージョン。 | string |
|
fieldPath | オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、「spec.containers{name}」などの値に設定されます (「name」はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、「spec.containers[2]」の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 | string |
|
kind | 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string |
|
name | 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | string |
|
namespace | 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
|
resourceVersion | この参照が作成される特定の resourceVersion (ある場合)。少子: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | string |
|
uid | 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | 文字列 |
gates
| 名前 | 説明 | Schema |
|---|---|---|
|
annotations | k8s の典型的なアノテーション | |
|
labelSelector | ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。 | |
|
name | string |
annotations
| 名前 | Schema |
|---|---|
|
key | string |
|
value | string |
labelSelector
| 名前 | 説明 | Schema |
|---|---|---|
|
matchExpressions | matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合します。 | < matchExpressions > array |
|
matchLabels | matchLabels は、{key,value} ペアのマップです。MatchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには「key」、演算子には「In」、値配列には「value」のみが含まれます。要件は AND で結合します。 | < string, string > マップ |
matchExpressions
| 名前 | 説明 | Schema |
|---|---|---|
|
key | key は、セレクターの適用先のラベルキーです。 | string |
|
operator | Operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 | string |
|
values | value は文字列値の配列です。Operator が In または NotIn の場合には、値の配列を空白にできません。Operator が Exists または DoesNotExist の場合には、値の配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 | < 文字列 > 配列 |
secretRef
| 名前 | 説明 | Schema |
|---|---|---|
|
apiVersion | 参照先の API バージョン。 | string |
|
fieldPath | オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、「spec.containers{name}」などの値に設定されます (「name」はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、「spec.containers[2]」の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 | string |
|
kind | 参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string |
|
name | 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | string |
|
namespace | 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
|
resourceVersion | この参照が作成される特定の resourceVersion (ある場合)。少子: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | string |
|
uid | 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | 文字列 |
1.5. Subscriptions API リンクのコピーリンクがクリップボードにコピーされました!
1.5.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のサブスクリプションリソースについて説明します。サブスクリプションリソースには、create、query、delete、update の 4 つの要求を使用できます。
1.5.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.5.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.5.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.5.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.5.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- subscriptions.apps.open-cluster-management.io : サブスクリプションを作成して管理します。
1.5.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.5.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.5.2.1. サブスクリプションの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.5.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
サブスクリプションを作成します。
1.5.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成するサブスクリプションを記述するパラメーター。 |
1.5.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
subscription/yaml
1.5.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- subscriptions.apps.open-cluster-management.io
1.5.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.5.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.5.2.2. 全サブスクリプションのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions
1.5.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
サブスクリプションにクエリーを行い、詳細を確認します。
1.5.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.5.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
subscription/yaml
1.5.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- subscriptions.apps.open-cluster-management.io
1.5.2.3. 単一サブスクリプションのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.5.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つのサブスクリプションにクエリーを行い、詳細を確認します。
1.5.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
subscription_name | 問い合わせるサブスクリプションの名前。 | 文字列 |
1.5.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- subscriptions.apps.open-cluster-management.io
1.5.2.4. サブスクリプションの削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}
1.5.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
subscription_name | 削除するサブスクリプションの名前。 | 文字列 |
1.5.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- subscriptions.apps.open-cluster-management.io
1.5.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.5.3.1. Subscription リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | |
|
spec | |
|
status |
metadata
| 名前 | Schema |
|---|---|
|
annotations | object |
|
labels | object |
|
name | string |
|
namespace | string |
spec
| 名前 | Schema |
|---|---|
|
channel | string |
|
name | string |
|
overrides | <overrides > 配列 |
|
packageFilter | |
|
packageOverrides | < packageOverrides > array |
|
placement | |
|
timewindow |
overrides
| 名前 | Schema |
|---|---|
|
clusterName | string |
|
clusterOverrides | < オブジェクト > 配列 |
packageFilter
| 名前 | 説明 | Schema |
|---|---|---|
|
annotations | < string, string > マップ | |
|
filterRef | ||
|
labelSelector | ||
|
version |
Pattern : | string |
filterRef
| 名前 | Schema |
|---|---|
|
name | string |
labelSelector
| 名前 | Schema |
|---|---|
|
matchExpressions | < matchExpressions > array |
|
matchLabels | < string, string > マップ |
matchExpressions
| 名前 | Schema |
|---|---|
|
key | string |
|
operator | string |
|
values | < 文字列 > 配列 |
packageOverrides
| 名前 | Schema |
|---|---|
|
packageAlias | string |
|
packageName | string |
|
packageOverrides | < オブジェクト > 配列 |
placement
| 名前 | Schema |
|---|---|
|
clusterSelector | |
|
clusters | <clusters > 配列 |
|
local | boolean |
|
placementRef |
clusterSelector
| 名前 | Schema |
|---|---|
|
matchExpressions | < matchExpressions > array |
|
matchLabels | < string, string > マップ |
matchExpressions
| 名前 | Schema |
|---|---|
|
key | string |
|
operator | string |
|
values | < 文字列 > 配列 |
clusters
| 名前 | Schema |
|---|---|
|
name | string |
placementRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
timewindow
| 名前 | Schema |
|---|---|
|
daysofweek | < 文字列 > 配列 |
|
hours | <hours > 配列 |
|
location | string |
|
windowtype | 列挙 (active, blocked, Active, Blocked) |
hours
| 名前 | Schema |
|---|---|
|
end | string |
|
start | string |
status
| 名前 | Schema |
|---|---|
|
lastUpdateTime | 文字列 (date-time) |
|
message | string |
|
phase | string |
|
reason | string |
|
statuses | object |
1.6. PlacementRules API リンクのコピーリンクがクリップボードにコピーされました!
1.6.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の PlacementRule リソースについて説明します。PlacementRule リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.6.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.6.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.6.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.6.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.6.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- placementrules.apps.open-cluster-management.io: 配置ルールを作成して管理します。
1.6.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.6.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.6.2.1. 配置ルールの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.6.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
配置ルールを作成します。
1.6.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成する配置ルールを記述するパラメーター。 |
1.6.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.6.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- placementrules.apps.open-cluster-management.io
1.6.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.6.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.6.2.2. 全 placementrules のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules
1.6.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
配置ルールに対してクエリーを実行して詳細を確認します。
1.6.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.6.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.6.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- placementrules.apps.open-cluster-management.io
1.6.2.3. 単一の placementrule のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.6.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つの配置ルールに対してクエリーを実行して詳細を確認します。
1.6.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
placementrule_name | 問い合わせる配置ルールの名前。 | 文字列 |
1.6.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- placementrules.apps.open-cluster-management.io
1.6.2.4. Placementrule の削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}
1.6.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| パス |
placementrule_name | 削除する placementrule の名前。 | 文字列 |
1.6.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- placementrules.apps.open-cluster-management.io
1.6.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.6.3.1. Placementrule リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | Schema |
|---|---|
|
clusterConditions | < clusterConditions > array |
|
clusterReplicas | integer |
|
clusterSelector | |
|
clusters | <clusters > 配列 |
|
policies | <policies > 配列 |
|
resourceHint | |
|
schedulerName | string |
clusterConditions
| 名前 | Schema |
|---|---|
|
status | string |
|
type | string |
clusterSelector
| 名前 | Schema |
|---|---|
|
matchExpressions | < matchExpressions > array |
|
matchLabels | < string, string > マップ |
matchExpressions
| 名前 | Schema |
|---|---|
|
key | string |
|
operator | string |
|
values | < 文字列 > 配列 |
clusters
| 名前 | Schema |
|---|---|
|
name | string |
policies
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
resourceHint
| 名前 | Schema |
|---|---|
|
order | string |
|
type | string |
1.7. Applications API リンクのコピーリンクがクリップボードにコピーされました!
1.7.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のアプリケーションリソースについて説明します。アプリケーションリソースには、create、query、delete、update の 4 つの要求を使用できます。
1.7.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.7.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.7.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.7.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.7.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- applications.app.k8s.io : アプリケーションを作成して管理します。
1.7.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.7.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.7.2.1. アプリケーションの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.7.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
アプリケーションを作成します。
1.7.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成するアプリケーションを記述するパラメーター。 |
1.7.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.7.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- applications.app.k8s.io
1.7.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.7.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.7.2.2. 全アプリケーションのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications
1.7.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
アプリケーションにクエリーを行い、詳細を確認します。
1.7.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.7.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.7.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- applications.app.k8s.io
1.7.2.3. 単一アプリケーションのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.7.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つのアプリケーション に対してクエリーを行い、詳細を確認します。
1.7.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
application_name | 問い合わせるアプリケーションの名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.7.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- applications.app.k8s.io
1.7.2.4. アプリケーションの削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}
1.7.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
application_name | 削除するアプリケーションの名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.7.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- applications.app.k8s.io
1.7.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.7.3.1. アプリケーション リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | Schema |
|---|---|
|
assemblyPhase | string |
|
componentKinds | < オブジェクト > 配列 |
|
descriptor | |
|
info | <info > 配列 |
|
selector | object |
記述子
| 名前 | Schema |
|---|---|
|
description | string |
|
icons | <icons > 配列 |
|
keywords | < 文字列 > 配列 |
|
links | <links > 配列 |
|
maintainers | <maintainers > 配列 |
|
notes | string |
|
owners | <owners > 配列 |
|
type | string |
|
version | string |
icons
| 名前 | Schema |
|---|---|
|
size | string |
|
src | string |
|
type | string |
links
| 名前 | Schema |
|---|---|
|
description | string |
|
url | string |
maintainers
| 名前 | Schema |
|---|---|
|
email | string |
|
name | string |
|
url | string |
owners
| 名前 | Schema |
|---|---|
|
email | string |
|
name | string |
|
url | string |
info
| 名前 | Schema |
|---|---|
|
name | string |
|
type | string |
|
value | string |
|
valueFrom |
valueFrom
| 名前 | Schema |
|---|---|
|
configMapKeyRef | |
|
ingressRef | |
|
secretKeyRef | |
|
serviceRef | |
|
type | string |
configMapKeyRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
key | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
ingressRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
host | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
path | string |
|
resourceVersion | string |
|
uid | string |
secretKeyRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
key | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
serviceRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
path | string |
|
port | 整数 (int32) |
|
resourceVersion | string |
|
uid | string |
1.8. Helm API リンクのコピーリンクがクリップボードにコピーされました!
1.8.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の HelmRelease リソースについて説明します。HelmRelease リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.8.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.8.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.8.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.8.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.8.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- helmreleases.apps.open-cluster-management.io : helmreleases を作成して管理します。
1.8.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.8.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.8.2.1. helmrelease の作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.8.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
Helmrelease を作成します。
1.8.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成する helmrelease を記述するパラメーター。 |
1.8.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.8.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- helmreleases.apps.open-cluster-management.io
1.8.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.8.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.8.2.2. 全 helmreleases のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases
1.8.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
helmreleases に対してクエリーを実行して詳細を確認します。
1.8.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.8.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.8.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- helmreleases.apps.open-cluster-management.io
1.8.2.3. 単一の helmrelease のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.8.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つの helmrelease に対してクエリーを実行して詳細を確認します。
1.8.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
helmrelease_name | 問い合わせる helmrelease の名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.8.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- helmreleases.apps.open-cluster-management.io
1.8.2.4. helmrelease の削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}
1.8.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
helmrelease_name | 削除する helmrelease の名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.8.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- helmreleases.apps.open-cluster-management.io
1.8.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.8.3.1. HelmRelease リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
repo | |
|
spec | object |
|
status |
repo
| 名前 | Schema |
|---|---|
|
chartName | string |
|
configMapRef | |
|
secretRef | |
|
source | |
|
version | string |
configMapRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
secretRef
| 名前 | Schema |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
source
github
| 名前 | Schema |
|---|---|
|
branch | string |
|
chartPath | string |
|
urls | < 文字列 > 配列 |
helmRepo
| 名前 | Schema |
|---|---|
|
urls | < 文字列 > 配列 |
status
| 名前 | Schema |
|---|---|
|
conditions | <conditions > 配列 |
|
deployedRelease |
conditions
| 名前 | Schema |
|---|---|
|
lastTransitionTime | 文字列 (date-time) |
|
message | string |
|
reason | string |
|
status | string |
|
type | string |
deployedRelease
| 名前 | Schema |
|---|---|
|
manifest | string |
|
name | string |
1.9. Policy API リンクのコピーリンクがクリップボードにコピーされました!
1.9.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のポリシーリソースについて説明します。ポリシーリソースには、create、query、delete、update の 4 つの要求を使用できます。
1.9.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.9.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.9.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.9.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.9.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- policy.open-cluster-management.io/v1 : ポリシーを作成して管理します。
1.9.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.9.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.9.2.1. ポリシーの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
ポリシーを作成します。
1.9.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成するポリシーを記述するパラメーター |
1.9.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/json
1.9.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- policy.open-cluster-management.io
1.9.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.9.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.9.2.2. 全ポリシーのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
ポリシーに対してクエリーを実行して詳細を確認します。
1.9.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | ポリシーを適用する namespace (例: default) | 文字列 |
1.9.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/json
1.9.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- policy.open-cluster-management.io
1.9.2.3. 単一ポリシーのクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
GET /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
1 つのポリシーに対してクエリーを実行して詳細を確認します。
1.9.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
policy_name | 問い合わせるポリシーの名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.9.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- policy.open-cluster-management.io
1.9.2.4. ポリシーの削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
DELETE /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
1.9.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
policy_name | 削除するポリシーの名前。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.9.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- policy.open-cluster-management.io
1.9.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.9.3.1. ポリシー リンクのコピーリンクがクリップボードにコピーされました!
| Name (名前) | 説明 | Schema |
|---|---|---|
|
apiVersion | ポリシーのバージョンスキーマ。 | string |
|
kind | REST リソースを表す文字列の値。 | string |
|
metadata | ポリシーを定義するルールを記述します。 | オブジェクト |
spec
| Name (名前) | 説明 | Schema |
|---|---|---|
|
remediationAction | リソースで定義されているように違反をどのように処理するかを表す値。 | string |
|
namespaceSelector | ポリシーが適用される namespace を表す値。 | string |
policy-templates
| Name (名前) | 説明 | Schema |
|---|---|---|
|
apiVersion | ポリシーのバージョンスキーマ。 | string |
|
kind | REST リソースを表す文字列の値。 | string |
|
metadata | ポリシーを定義するルールを記述します。 | オブジェクト |
| ラベルを定義するセクション。 | string | |
|
rules | string |
clusterConditions
| Name (名前) | 説明 | Schema |
|---|---|---|
|
matchLabels | ポリシーを namespace に適用するのに必要なラベル。 | object |
|
cloud | ポリシーをクラウドプロバイダーに適用するのに必要なラベル。 | string |
ルール
| Name (名前) | 説明 | Schema |
|---|---|---|
|
apiGroups | このルールが適用される API の一覧です。 | 文字列 |
|
resources | リソースタイプの一覧。 | object |
|
verbs | 動詞の一覧。 | 文字列 |
1.10. Observability API リンクのコピーリンクがクリップボードにコピーされました!
1.10.1. 概要 リンクのコピーリンクがクリップボードにコピーされました!
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の MultiClusterObservability リソースについて説明します。MultiClusterObservability リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.10.1.1. バージョン情報 リンクのコピーリンクがクリップボードにコピーされました!
バージョン : 2.1.0
1.10.1.2. お問い合わせ先 リンクのコピーリンクがクリップボードにコピーされました!
お問い合わせメール: apiteam@swagger.io
1.10.1.3. ライセンス情報 リンクのコピーリンクがクリップボードにコピーされました!
ライセンス: Apache 2.0
ライセンス URL: http://www.apache.org/licenses/LICENSE-2.0.html
利用規約: http://swagger.io/terms/
1.10.1.4. URI スキーム リンクのコピーリンクがクリップボードにコピーされました!
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.10.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- observability.open-cluster-management.io : multiclusterobservabilities を作成して管理します。
1.10.1.6. 外部ドキュメント リンクのコピーリンクがクリップボードにコピーされました!
説明: Swagger に関する詳細は次を確認してください。
URL: http://swagger.io
1.10.2. パス リンクのコピーリンクがクリップボードにコピーされました!
1.10.2.1. multiclusterobservability リソースの作成 リンクのコピーリンクがクリップボードにコピーされました!
POST /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
POST /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
1.10.2.1.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
MultiClusterObservability リソースを作成します。
1.10.2.1.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| ボディー |
body | 作成する MultiClusterObservability リソースを記述するパラメーター |
1.10.2.1.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.1.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.10.2.1.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- observability.apps.open-cluster-management.io
1.10.2.1.6. HTTP 要求の例 リンクのコピーリンクがクリップボードにコピーされました!
1.10.2.1.6.1. 要求ボディー リンクのコピーリンクがクリップボードにコピーされました!
1.10.2.2. すべての multiclusterobservabilities のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities
1.10.2.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。
1.10.2.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
1.10.2.2.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.2.4. 消費 リンクのコピーリンクがクリップボードにコピーされました!
-
application/yaml
1.10.2.2.5. タグ リンクのコピーリンクがクリップボードにコピーされました!
- observability.apps.open-cluster-management.io
1.10.2.3. 単一の multiclusterobservability のクエリー リンクのコピーリンクがクリップボードにコピーされました!
GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
GET /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
1.10.2.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
単一の MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。
1.10.2.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
multiclusterobservability_name | 問い合わせる multiclusterobservability の名前 | 文字列 |
1.10.2.3.3. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.3.4. タグ リンクのコピーリンクがクリップボードにコピーされました!
- observability.apps.open-cluster-management.io
1.10.2.4. multiclusterobservability リソースの削除 リンクのコピーリンクがクリップボードにコピーされました!
DELETE /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
DELETE /apis/observability.open-cluster-management.io/v1beta1/multiclusterobservabilities/{multiclusterobservability_name}
1.10.2.4.1. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
| タイプ | Name (名前) | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}、ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
multiclusterobservability_name | 削除する multiclusterobservability の名前 | 文字列 |
1.10.2.4.2. 応答 リンクのコピーリンクがクリップボードにコピーされました!
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.4.3. タグ リンクのコピーリンクがクリップボードにコピーされました!
- observability.apps.open-cluster-management.io
1.10.3. 定義 リンクのコピーリンクがクリップボードにコピーされました!
1.10.3.1. MultiClusterObservability リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | 説明 | Schema |
|---|---|---|
|
apiVersion | MultiClusterObservability のバージョンスキーマ。 | string |
|
kind | REST リソース (MultiClusterObservability) を表す文字列の値。 | string |
|
metadata | ポリシーを定義するルールを記述します。 | オブジェクト |
spec
| Name (名前) | 説明 | Schema |
|---|---|---|
|
availabilityConfig |
高可用性サポートの選択に使用するパラメーター。これにより、フェイルオーバー時のサポートが提供され、リソースを多く使用できます。 | string |
|
enableDownSampling |
downsample を有効または無効にします。デフォルト値は | boolean |
|
imagePullPolicy | 可観測性イメージのプルポリシー。 | string |
|
imagePullSecret | 可観測性イメージのプルシークレット。 | string |
|
nodeSelector | ノード選択の制約のサポート | object |
|
observabilityAddonSpec | アドオンが有効な全マネージドクラスターのグローバル設定。 | |
|
retentionResolution1h |
バスケットに解像度 2 のサンプルを保持する時間 (1 時間)。デフォルト値は 30 日 ( | string |
|
retentionResolution5m |
バスケットに解像度 1 のサンプルを保持する時間 (5 分)。デフォルト値は 14 日 ( | string |
|
retentionResolutionRaw | バスケットで未加工の解像度サンプルを保持する時間。 | string |
|
storageConfigObject | 可観測性が使用するストレージを指定します。 |
observabilityAddonSpec
| Name (名前) | 説明 | Schema |
|---|---|---|
|
enableMetrics |
可観測性アドオンがメトリクスをハブクラスターに送信するかどうかを指定します。デフォルト値は | boolean |
|
interval |
可観測性アドオンがメトリクスをハブクラスターに送信する間隔。デフォルト値は 60 秒( | 整数 |
storageConfigObject
| 名前 | 説明 | Schema |
|---|---|---|
|
metricObjectStorage | メトリクスのシークレットを設定するオブジェクトストア。 | |
|
statefulSetSize |
可観測性ステートフルセットに適用されるストレージの量 (Thanos ストア、ルール、コンパクト、およびレシーバー)。デフォルト値は | 文字列 |
|
statefulSetStorageClass |
| string |
metricObjectStorage
| Name (名前) | 説明 | Schema |
|---|---|---|
|
key | 選択するシークレットのキー。有効な秘密鍵でなければなりません。 | 文字列 |
|
name |
| 文字列 |