Language:
Format:

Language:
Format:

第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.3.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. パラメーター

タイプ	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

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. 要求ボディー

{
  "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. パラメーター

タイプ	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}

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. クラスター

Name (名前)	スキーマ
apiVersion 必須	文字列
kind 必須	文字列
metadata 必須	オブジェクト
spec 必須	spec

spec

Name (名前)	スキーマ
hubAcceptsClient 必須	ブール値
managedClusterClientConfigs 任意	< managedClusterClientConfigs > array
leaseDurationSeconds 任意	整数 (int32)

managedClusterClientConfigs

Name (名前)	説明	スキーマ
URL 必須		文字列
cabundle 任意	パターン: `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`	文字列 (バイト)

Language and Page Formatting Options