グリッド管理APIの概要

グリッド管理APIのドキュメント

グリッド管理APIは、オープン ソースのAPIプラットフォームであるSwaggerを使用してAPIのドキュメントを提供しています。Swaggerでは、ユーザ インターフェイスを使用してパラメータやオプションを変更した場合のAPIの動作を確認しながら、APIの開発を進めることができます。Swaggerのドキュメントは、標準的なWebテクノロジとJavaScript Object Notation（JSON）データ形式について十分理解していることを前提としています。

グリッド管理APIのドキュメントにアクセスするには、グリッド管理インターフェイスにサインインし、Webアプリケーション ヘッダーで[Help] > [API Docs]を選択します。

API

各REST APIコマンドは、APIのURL、HTTPアクション、必須またはオプションのURLパラメータ、および想定されるAPI応答で構成されます。

SwaggerのUIには、次の例のように、各API処理の詳細と説明（ドキュメント）が表示されます。ローカルのグリッド管理者グループに関する情報を取得するには、そのグループの一意の名前をshortNameパラメータの値として入力し、[Try it out]をクリックします。

グリッド管理APIには次のセクションが含まれています。

• accounts – 新規アカウントの作成および特定のアカウントの使用状況の取得を含む、ストレージ テナント アカウントを管理するための処理。

• alarms – 現在のアラームをリストし、グリッドの健常性に関する情報を返す処理。

• audit – 監査構成をリストおよび更新する処理。

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

  グリッド管理APIは、Bearerトークン認証方式をサポートしています。サインインするには、認証要求（POST /api/v2/authorize）のJSONの本文でユーザ名とパスワードを指定します。ユーザが認証されると、セキュリティ トークンが返されます。このトークンを後続のAPI要求のヘッダーで指定する必要があります（「Authorization: Bearer token」）。

  認証のセキュリティ強化については、「クロスサイト リクエスト フォージェリ（CSRF）の防止方法」を参照してください。

• config – 製品リリースとグリッド管理APIのバージョンに関連する処理。製品のリリース バージョンおよびそのリリースでサポートされているグリッド管理APIのメジャー バージョンをリストし、廃止されたバージョンのAPIを無効にすることができます。

• deactivated-features – 非アクティブ化された可能性がある機能を表示する処理。

• dns-servers – 設定済みの外部DNSサーバをリストおよび変更する処理。

• endpoint-domain-names – エンドポイントのドメイン名をリストおよび変更する処理。

• erasure-coding – イレイジャー コーディング プロファイルに対する処理。

• expansion – 拡張の処理（プロシージャ レベル）。

• expansion-nodes – 拡張の処理（ノードレベル）。

• expansion-sites – 拡張の処理（サイトレベル）。

• grid-networks – グリッド ネットワーク リストをリストおよび変更する処理。

• groups – ローカルのグリッド管理者グループを管理する処理、およびフェデレーテッド グリッド管理者グループを外部のLDAPサーバから取得する処理。

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

• ilm – 情報ライフサイクル管理（ILM）での処理。

• license – StorageGRID Webscaleライセンスを取得および更新する処理。

• logs – ログ ファイルを収集してダウンロードする処理。

• metrics – StorageGRID Webscaleの指標に対する処理。ある時点のみの指標クエリ、および一定期間にわたる指標クエリを含みます。

  注:グリッド管理APIは、バックエンドのデータ ソースとしてPrometheusシステム監視ツールを使用します。Prometheusクエリの構築については、PrometheusのWebサイトを参照してください。

• ntp-servers – 外部のNetwork Time Protocol（NTP;ネットワーク タイム プロトコル）サーバをリストまたは更新する処理。

• objects – オブジェクトおよびオブジェクト メタデータに対する処理。

• recovery – リカバリに使用可能なグリッド ノードをリストする処理。

• recovery-package – リカバリ パッケージをダウンロードする処理。

• regions – リージョンを表示および作成する処理。

• server-certificates – グリッド管理インターフェイスのサーバ証明書を表示および更新する処理。

• users – グリッド管理者ユーザを表示および管理する処理。

最上位のリソース

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

• /grid：グリッド管理者ユーザだけがアクセスできます。
• /org：テナント アカウントのローカルまたはフェデレーテッドLDAPグループに所属するユーザだけがアクセスできます。詳細については、『テナント管理者ガイド』を参照してください。
• /private：StorageGRID Webscaleシステムへの内部アクセスに制限されます。このリソース パスはドキュメント化されていません。