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

StorageGRID Grid Management APIを使用する

PDF

グリッドマネージャのユーザインターフェイスの代わりに、グリッド管理 REST API を使用してシステム管理タスクを実行できます。たとえば、API を使用して操作を自動化したり、ユーザなどの複数のエンティティをより迅速に作成したりすることができます。

最上位のリソース

グリッド管理APIは、以下のトップレベルリソースを提供します。

  • /grid：Grid Managerユーザーへのアクセスに限定されており、設定されたグループ権限に基づいています。

  • /org：アクセスは、テナントアカウントのローカルまたはフェデレーションLDAPグループに属するユーザーに限定されます。詳細については、"テナントアカウントを使用する"を参照してください。

  • /private：アクセスはGrid Managerユーザーに限定されており、設定されたグループ権限に基づいています。プライベートAPIは予告なく変更される場合があります。StorageGRIDプライベートエンドポイントは、リクエストのAPIバージョンも無視します。

API リクエストを発行する

グリッド管理APIは、オープンソースAPIプラットフォームであるSwaggerを使用しています。Swaggerは、開発者と非開発者がAPIを使用してStorageGRIDでリアルタイム操作を実行できる直感的なユーザーインターフェースを提供します。

Swagger のユーザーインターフェイスは、各 API 操作に関する完全な詳細情報とドキュメントを提供します。

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

  1. グリッドマネージャーのヘッダーからヘルプアイコンを選択し、「API documentation」を選択します。

    ヘルプメニュー

  2. プライベート API で操作を実行するには、StorageGRID 管理 API ページで プライベート API ドキュメントへ移動 を選択します。

    プライベートAPIは予告なく変更される場合があります。StorageGRIDプライベートエンドポイントは、リクエストのAPIバージョンも無視します。

  3. 希望する操作を選択してください。

    API操作を展開すると、GET、PUT、UPDATE、DELETEなどの利用可能なHTTPアクションが表示されます。

  4. HTTPアクションを選択すると、エンドポイントURL、必須またはオプションのパラメータ一覧、リクエストボディの例（必要な場合）、および考えられるレスポンスなど、リクエストの詳細が表示されます。

    Swagger UI の例

  5. リクエストにグループIDやユーザーIDなどの追加パラメータが必要かどうかを判断します。次に、これらの値を取得します。必要な情報を取得するには、まず別のAPIリクエストを発行する必要がある場合があります。

  6. サンプルリクエストボディを修正する必要があるかどうかを判断してください。必要な場合は、*モデル*を選択して各フィールドの要件を確認できます。

  7. 「Try it out」を選択します。

  8. 必要なパラメータを指定するか、必要に応じてリクエスト本文を変更してください。

  9. 「実行」を選択します。

  10. リクエストが成功したかどうかを判断するには、レスポンスコードを確認してください。