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

テナント管理 API について理解する

共同作成者
PDF

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

テナント管理 API ：

  • Swagger オープンソース API プラットフォームを使用します。Swagger では、開発者でもそうでないユーザでも、わかりやすいユーザインターフェイスを利用して API を操作できます。Swagger のユーザインターフェイスでは、各 API 処理に関する詳細情報とドキュメントを参照できます。

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

Swagger のテナント管理 API のドキュメントにアクセスするには、次の手順を実行します。

  1. Tenant Manager にサインインします。

  2. Tenant Managerの上部で、ヘルプアイコンを選択し、*[API documentation]*を選択します。

API 処理

テナント管理 API では、使用可能な API 処理が次のセクションに分類されます。

  • * account *：現在のテナントアカウントに対する処理（ストレージの使用状況情報の取得など）。

  • auth：ユーザセッション認証を実行する処理。

    テナント管理 API では、 Bearer トークン認証方式がサポートされています。テナントにログインするには、認証要求（つまり、 POST /api/v3/authorize）。ユーザが認証されると、セキュリティトークンが返されます。このトークンは、後続の API 要求（「 Authorization ： Bearer トークン」）のヘッダーで指定する必要があります。

    認証セキュリティの向上については、を参照してください "クロスサイトリクエストフォージェリから保護"。

    メモ StorageGRID システムでシングルサインオン（ SSO ）が有効になっている場合は、別の手順による認証が必要です。を参照してください "Grid 管理 API の使用手順"。

  • * config *：製品リリースおよびテナント管理APIのバージョンに関連する処理。製品リリースバージョンおよびそのリリースでサポートされる API のメジャーバージョンを一覧表示できます。

  • * containers *：S3バケットまたはSwiftコンテナに対する処理。

  • * deactivated-features *：非アクティブ化された可能性がある機能を表示する操作。

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

  • * grid-federation-connections *：グリッドフェデレーション接続およびグリッド間レプリケーションに対する処理。

  • * groups *：ローカルテナントグループを管理する処理、およびフェデレーテッドテナントグループを外部のアイデンティティソースから取得する処理。

  • *identity-source *：外部のアイデンティティソースを設定する処理、およびフェデレーテッドグループとユーザ情報を手動で同期する処理。

  • * regions *：StorageGRID システムに設定されているリージョンを特定する処理。

  • * s3 *：テナントユーザのS3アクセスキーを管理する処理。

  • * s3-object-lock *：グローバルS3オブジェクトロック設定に対する処理。法規制への準拠をサポートするために使用されます。

  • * users *：テナントユーザを表示および管理する処理。

処理の詳細

各 API 処理を展開表示すると、 HTTP アクション、エンドポイント URL 、必須またはオプションのパラメータのリスト、要求の本文の例（必要な場合）、想定される応答を確認できます。

Swagger API での GET groups 処理を示す例

問題 API 要求

注意 API Docs Web ページを使用して実行する API 処理はすべてその場で実行されます。設定データやその他のデータを誤って作成、更新、または削除しないように注意してください。
手順

  1. HTTP アクションを選択して、要求の詳細を表示します。

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

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

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

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

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

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