edit-icon download-icon

API 概要

最終更新日: Jun 01, 2018

Container Service API は主に次の 3 つに分類されます。

  • クラスター管理インターフェイス
  • アプリケーション管理インターフェイス
  • トリガー

クラスター管理インターフェイス

Container Service は、クラスター作成用や削除用のインターフェイスなど、クラスターを管理するためのインターフェイスを提供しています。

下記はクラスター管理インターフェイスのリストです。

API 説明
GetClusterList すべてのクラスターを表示します。
CreateCluster クラスターを作成します。
DeleteCluster クラスターを削除します。
GetClusterById クラスターを表示します。
GetClusterCerts クラスター証明書を取得します。
UpdateClusterSizeById クラスターのノード数を更新します。

アプリケーション管理インターフェイス

アプリケーション管理インターフェイスは Docker Remote API と互換性があります。単一の Docker Engine を操作するのと同じ方法で Docker クラスターを操作できます。

下記はアプリケーション管理インターフェイスのリストです。

API 説明
List Projects アプリケーションリストを表示します。
Create project アプリケーションを作成します。
Retrieve project アプリケーションを表示します。
Start project アプリケーションを起動します。
Stop project アプリケーションを停止します。
Kill project アプリケーションを終了します。
Update project アプリケーションを更新します。
Delete project アプリケーションを削除します。
List Services サービスリストを表示します。
Retrieve service サービスを表示します。
Start service サービスを起動します。
Stop service サービスを停止します。
Kill service サービスを終了します。
Scale service サービスをスケールします。

トリガー

トリガーとは、シンプル、短期間かつ継続的なデプロイメントのために Container Service から提供されている API です。詳細については、「トリガー」をご参照ください。