インストールREST APIの概要

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

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

注意: API Docs Webページを使用して実行するAPI処理はすべてその場で実行されます。設定データやその他のデータを誤って作成、更新、または削除しないように注意してください。

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

StorageGRIDインストールAPI

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

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

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

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

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

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

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