Skip to main content
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

グリッド管理 API を使用します

共同作成者
PDF

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

トップレベルのリソース

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

  • /grid：Grid Managerユーザのみがアクセスでき、設定されているグループ権限に基づいてアクセスできます。

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

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

問題 API 要求

グリッド管理 API では、 Swagger オープンソース API プラットフォームを使用します。Swagger のわかりやすいユーザインターフェイスを使用して、開発者および一般のユーザは StorageGRID で API を使用してリアルタイムの処理を実行できます。

Swagger のユーザインターフェイスでは、各 API 処理に関する詳細情報とドキュメントを参照できます。

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

  1. Grid Managerのヘッダーでヘルプアイコンを選択し、*[API documentation]*を選択します。

    ヘルプメニュー

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

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

  3. 目的の処理を選択します。

    API 処理を拡張すると、 GET 、 PUT 、 UPDATE 、 DELETE など、使用可能な HTTP アクションを確認できます。

  4. HTTP アクションを選択して、要求の詳細を確認します。これには、エンドポイント URL 、必須またはオプションのパラメータのリスト、要求の本文の例（必要な場合）、想定される応答が含まれます。

    Swagger UI の例

  5. グループやユーザの ID など、要求で追加のパラメータが必要かどうかを確認します。次に、これらの値を取得します。必要な情報を取得するために、先に別の API 要求の問題 が必要になることがあります。

  6. 要求の本文の例を変更する必要があるかどうかを判断します。その場合は、 * Model * を選択して各フィールドの要件を確認できます。

  7. [* 試してみてください * ] を選択します。

  8. 必要なパラメータを指定するか、必要に応じて要求の本文を変更します。

  9. [* Execute] を選択します。

  10. 応答コードを確認し、要求が成功したかどうかを判断します。