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

グリッド管理APIを使用する

PDF

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

トップレベルのリソース

グリッド管理 API は、次の最上位リソースを提供します。

  • /grid: アクセスは Grid Manager ユーザーに制限され、構成されたグループ権限に基づいて行われます。

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

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

APIリクエストを発行する

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

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

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

  1. グリッド マネージャー ヘッダーからヘルプ アイコンを選択し、API ドキュメント を選択します。

    ヘルプメニュー

  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. *試してみる*を選択します。

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

  9. *実行*を選択します。

  10. 応答コードを確認して、リクエストが成功したかどうかを確認します。