グリッド管理APIの概要

StorageGRID Webscaleには、システム管理タスクを実行するためのREST APIが用意されています。

グリッド管理APIにはHTTPS経由でアクセスします。グリッド管理インターフェイスからグリッド管理APIにアクセスできます。

グリッド管理APIのドキュメント

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

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

グリッド管理APIのドキュメントにアクセスするには、グリッド管理インターフェイスにサインインし、Webアプリケーション ヘッダーで[Help] > [API Docs]を選択します。

API

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

SwaggerのUIには、次の例のように、各API処理の詳細と説明(ドキュメント)が表示されます。ローカルのグリッド管理者グループに関する情報を取得するには、そのグループの一意の名前をshortNameパラメータの値として入力し、[Try it out]をクリックします。


Swagger UIの例

グリッド管理APIには次のセクションが含まれています。

最上位のリソース

グリッド管理APIで使用可能な最上位のリソースは次のとおりです。