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

StorageGRIDテナント管理APIについて学ぶ

PDF

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

テナント管理API：

  • Swagger オープンソース API プラットフォームを使用します。Swagger は、開発者だけでなく非開発者も API とやり取りできる直感的なユーザーインターフェースを提供します。Swagger のユーザーインターフェースは、各 API 操作に関する詳細な情報とドキュメントを提供します。

  • "無停止アップグレードをサポートするためのバージョン管理"を使用します。

テナント管理APIのSwaggerドキュメントにアクセスするには：

  1. テナントマネージャーにサインインします。

  2. テナントマネージャーの上部にあるヘルプアイコンを選択し、*APIドキュメント*を選択します。

APIの処理

テナント管理APIは、利用可能なAPI操作を以下のセクションに分類しています：

  • アカウント：現在のテナントアカウントに対する操作。ストレージ使用状況情報の取得などが含まれます。

  • auth：ユーザーセッション認証を実行するための操作。

    テナント管理APIは、ベアラートークン認証方式をサポートしています。テナントログインには、ユーザー名、パスワード、および accountId を認証リクエストの JSON ボディ（つまり、 POST /api/v3/authorize）に指定します。ユーザー認証が成功すると、セキュリティトークンが返されます。このトークンは、以降のAPIリクエストのヘッダーに必ず含める必要があります（「Authorization: Bearer token」）。

    認証セキュリティの改善に関する情報については、"クロスサイトリクエストフォージェリ攻撃から保護する"を参照してください。

    メモ StorageGRID システムでシングル サインオン（SSO）が有効になっている場合は、認証のために異なる手順を実行する必要があります。"グリッド管理APIの使用方法に関する手順"を参照してください。

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

  • コンテナ：S3バケットに対する操作。

  • deactivated-features：無効化された可能性のある機能を表示するための操作。

  • エンドポイント：エンドポイントを管理するための操作。エンドポイントを使用すると、S3 バケットが外部サービスを使用して StorageGRID CloudMirror レプリケーション、通知、または検索統合を行うことができます。

  • grid-federation-connections：グリッドフェデレーション接続およびクロスグリッドレプリケーションに関する操作。

  • グループ：ローカルテナントグループを管理し、外部IDソースからフェデレーションテナントグループを取得するための操作。

  • identity-source： 外部IDソースを設定し、フェデレーションされたグループとユーザー情報を手動で同期するための操作。

  • ilm: 情報ライフサイクル管理（ILM）設定に対する操作。

  • regions：StorageGRID システムに設定されているリージョンを確認するための操作。

  • s3: テナントユーザーのS3アクセスキーを管理する操作。

  • s3-object-lock：規制遵守をサポートするために使用される、グローバルな S3 Object Lock 設定に対する操作。

  • ユーザー：テナントユーザーを表示および管理するための操作。

操作の詳細

各API操作を展開すると、そのHTTPアクション、エンドポイントURL、必須またはオプションのパラメータのリスト、リクエストボディの例（必要な場合）、および考えられるレスポンスが表示されます。

Swagger APIにおけるGETグループ操作を示す例

API リクエストを発行する

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

  1. リクエストの詳細を表示するには、HTTPアクションを選択してください。

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

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

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

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

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

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