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ページに移動し、メニュー バーでを選択します。
StorageGRID WebscaleインストールAPIには次のセクションがあります。
- config – 製品リリースとAPIのバージョンに関連する処理です。製品リリース バージョンおよびそのリリースでサポートされるAPIのメジャー バージョンを一覧表示できます。
- grid – グリッドレベルの設定に関する処理です。グリッドの設定を取得し、更新することができます（グリッドの詳細、グリッド ネットワークのサブネット、グリッドのパスワード、NTPサーバとDNSサーバのIPアドレスなど）。
- nodes – ノードレベルの設定に関する処理です。グリッド ノードのリストを取得できるほか、グリッド ノードの削除、設定、表示、およびグリッド ノードの設定のリセットを行うことができます。
- provision – プロビジョニングに関する処理です。プロビジョニング処理を開始し、プロビジョニング処理のステータスを表示できます。
- recovery – プライマリ管理ノードのリカバリに関する処理です。情報のリセット、リカバリ パッケージのアップロード、リカバリの開始、およびリカバリ処理のステータスの表示を行うことができます。
- recovery-package – リカバリ パッケージをダウンロードする処理。
- sites – サイトレベルの設定に関する処理です。サイトの作成、表示、削除、および変更を行うことができます。
StorageGRID Webscaleアプライアンス インストーラAPI
StorageGRID Webscaleアプライアンス インストーラAPIには、Controller_IP:8080からHTTP経由でアクセスできます。
APIのドキュメントにアクセスするには、アプライアンスでStorageGRID Webscaleアプライアンス インストーラに移動し、メニュー バーでを選択します。
StorageGRID Webscaleアプライアンス インストーラAPIには次のセクションがあります。
- installation – アプライアンスのインストールを開始する処理と、インストールのステータスを監視する処理です。
- networking – StorageGRID Webscaleアプライアンスのグリッド ネットワーク、管理ネットワーク、クライアント ネットワークの設定、およびアプライアンスのポート設定に関連する処理です。
- setup – アプライアンス インストールの初期セットアップを支援する処理です（システムに関する情報を取得する要求やプライマリ管理ノードIPを更新する要求など）。
- support – コントローラをリブートする処理と、ログを取得する処理です。
- upgrade – アプライアンス ファームウェアのアップグレードに関連する処理です。