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

テナント管理APIを理解する

PDF

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

テナント管理 API:

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

  1. テナント マネージャーにSign in。

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

APIの処理

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

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

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

    テナント管理 API は、ベアラー トークン認証スキームをサポートしています。テナントログインの場合、認証リクエストのJSON本文にユーザー名、パスワード、アカウントIDを指定します（つまり、 POST /api/v3/authorize ）。ユーザーが正常に認証されると、セキュリティ トークンが返されます。このトークンは、後続の API リクエストのヘッダー (「Authorization: Bearer token」) で提供する必要があります。

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

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

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

  • コンテナ: S3 バケットまたは Swift コンテナに対する操作。

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

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

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

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

  • identity-source: 外部 ID ソースを構成し、フェデレーション グループとユーザー情報を手動で同期する操作。

  • ilm: 情報ライフサイクル管理 (ILM) 設定に関する操作。

  • regions: StorageGRIDシステムに設定されているリージョンを判別する操作。

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

  • s3-object-lock: 規制コンプライアンスをサポートするために使用される、グローバル S3 オブジェクトロック設定に対する操作。

  • users: テナント ユーザーを表示および管理する操作。

操作の詳細

各 API 操作を展開すると、HTTP アクション、エンドポイント URL、必須またはオプションのパラメータのリスト、リクエスト本文の例 (必要な場合)、および可能な応答が表示されます。

Swagger API での GET groups 操作を示す例

APIリクエストを発行する

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

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

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

  3. サンプルのリクエスト本文を変更する必要があるかどうかを判断します。その場合は、「モデル」を選択して、各フィールドの要件を確認することができます。

  4. *試してみる*を選択します。

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

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

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