インストールREST APIの概要

StorageGRID Webscaleには、インストール タスクを実行するためのREST APIとして、StorageGRID WebscaleインストールAPIとStorageGRID Webscaleアプライアンス インストーラAPIの2つが用意されています。

どちらのAPIも、Swaggerオープン ソースAPIプラットフォームを使用してAPIのドキュメントを提供しています。Swaggerでは、ユーザ インターフェイスを使用してパラメータやオプションを変更した場合のAPIの動作を確認しながら、APIの開発を進めることができます。Swaggerのドキュメントは、標準的なWebテクノロジとJavaScript Object Notation(JSON)データ形式について十分理解していることを前提としています。

注意:Swaggerユーザ インターフェイスを使用して実行するAPI処理はすべてライブ処理です。設定やその他のデータを誤って作成、更新、または削除しないように注意してください。

各REST APIコマンドは、APIのURL、HTTPアクション、必須またはオプションのURLパラメータ、および想定されるAPI応答で構成されます。

StorageGRID WebscaleインストールAPI

StorageGRID WebscaleインストールAPIは、StorageGRID Webscaleシステムを最初に設定するとき、およびプライマリ管理ノードのリカバリを実行する必要がある場合にのみ使用できます。インストールAPIには、グリッド管理インターフェイスからHTTPS経由でアクセスできます。

APIのドキュメントにアクセスするには、プライマリ管理ノードでインストールWebページに移動し、メニュー バーで[Help] > [API Docs]を選択します。

StorageGRID WebscaleインストールAPIには次のセクションがあります。

StorageGRID Webscaleアプライアンス インストーラAPI

StorageGRID Webscaleアプライアンス インストーラAPIには、Controller_IP:8080からHTTP経由でアクセスできます。

APIのドキュメントにアクセスするには、アプライアンスでStorageGRID Webscaleアプライアンス インストーラに移動し、メニュー バーで[Help] > [API Docs]を選択します。

StorageGRID Webscaleアプライアンス インストーラAPIには次のセクションがあります。