Skip to main content
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

StorageGRID インストール REST API について学ぶ

PDF

StorageGRID は、インストールタスクを実行するための StorageGRID インストール API を提供します。

このAPIは、オープンソースのAPIプラットフォームであるSwaggerを使用してAPIドキュメントを提供します。Swaggerを使用すると、開発者と非開発者の両方が、APIがパラメータやオプションにどのように応答するかを示すユーザーインターフェースを通じてAPIとやり取りできます。このドキュメントは、読者が標準的なウェブ技術とJSONデータ形式に精通していることを前提としています。

注意 APIドキュメントのウェブページを使用して実行するAPI操作はすべて、ライブ操作となります。設定データやその他のデータを誤って作成、更新、または削除しないように注意してください。

各 REST API コマンドには、API の URL、HTTP アクション、必須またはオプションの URL パラメータ、および期待される API レスポンスが含まれます。

StorageGRID インストール API

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

APIドキュメントにアクセスするには、プライマリ管理ノードのインストールWebページに移動し、メニューバーから「ヘルプ」>「APIドキュメント」を選択してください。

StorageGRID インストール API には、以下のセクションが含まれます。

  • config — 製品のリリースおよびAPIのバージョンに関連する操作。製品のリリースバージョンと、そのリリースでサポートされているAPIの主要バージョンを一覧表示できます。

  • grid — グリッドレベルの設定操作。グリッドの詳細、Grid Network のサブネット、グリッドのパスワード、NTP および DNS サーバーの IP アドレスなど、グリッドの設定を取得および更新できます。

  • nodes — ノードレベルの設定操作。グリッドノードの一覧を取得したり、グリッドノードを削除したり、グリッドノードを設定したり、グリッドノードを表示したり、グリッドノードの設定をリセットしたりできます。

  • provision — プロビジョニング操作。プロビジョニング操作を開始し、プロビジョニング操作のステータスを確認できます。

  • リカバリ — プライマリ管理ノードのリカバリ操作。情報のリセット、リカバリパッケージのアップロード、リカバリの開始、およびリカバリ操作のステータスの確認が可能です。

  • recovery-package — リカバリパッケージをダウンロードするための操作。

  • サイト — サイトレベルの設定操作。サイトの作成、表示、削除、変更が可能です。

  • temporary-password — インストール中に mgmt-api を保護するための一時パスワードに対する操作。