第1章 API
API にアクセスして、アプリケーションリソース、チャネル、サブスクリプションの作成や管理、さらに情報のクエリーを行うことができます。
ユーザーに必要なアクセス権: ロールが割り当てられているアクションのみを実行できます。ロールベースのアクセス制御 のドキュメントで、アクセス要件について確認してください。
詳細は、以下の各リソースに関する API のドキュメントを参照してください。
- Clusters API
- ClusterSets API (v1beta1)
- ClusterSetBindings API (v1beta1)
- Channels API
- Subscriptions API
- PlacementRules API
- Applications API
- Helm API
- Policy API
- Observability API
- Search customization API
- MultiClusterHub API
- Placements API (v1alpha1)
- PlacementDecisions API (v1alpha1)
- DiscoveryConfig API
- DiscoveredCluster 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.4.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
1.1.2.1.1. 説明
クラスターに対してクエリーを実行して詳細を確認します。
1.1.2.1.2. パラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
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
1.1.2.2.1. 説明
クラスターの作成
1.1.2.2.2. パラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
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. 要求のボディー
{ "apiVersion" : "cluster.open-cluster-management.io/v1", "kind" : "ManagedCluster", "metadata" : { "labels" : { "vendor" : "OpenShift" }, "name" : "cluster1" }, "spec": { "hubAcceptsClient": true, "managedClusterClientConfigs": [ { "caBundle": "test", "url": "https://test.com" } ] }, "status" : { } }
1.1.2.3. 単一クラスターのクエリー
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}
1.1.2.3.1. 説明
1 つのクラスターに対してクエリーを実行して詳細を確認します。
1.1.2.3.2. パラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
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 /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}
1.1.2.4.1. 説明
単一クラスターを削除します。
1.1.2.4.2. パラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
ヘッダー |
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. クラスター
名前 | スキーマ |
---|---|
apiVersion | 文字列 |
kind | 文字列 |
metadata | オブジェクト |
spec |
spec
名前 | スキーマ |
---|---|
hubAcceptsClient | ブール型 |
managedClusterClientConfigs | |
leaseDurationSeconds | 整数 (int32) |
managedClusterClientConfigs
名前 | 説明 | スキーマ |
---|---|---|
URL | 文字列 | |
cabundle |
パターン: | 文字列 (バイト) |