グリッド管理APIの使用

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

グリッド管理APIでは、SwaggerオープンソースAPIプラットフォームを使用します。Swaggerのわかりやすいユーザインターフェイスを使用して、開発者および一般のユーザはStorageGRIDのリアルタイム処理をAPIで実行できます。Swaggerのユーザインターフェイスでは、各API処理に関する詳細情報とドキュメントを参照できます。

注意:API Docs（Swagger）ユーザインターフェイスを使用して実行するAPI処理はすべてその場で実行されます。設定やその他のデータを誤って作成、更新、または削除しないように注意してください。

Swaggerのグリッド管理APIに関するドキュメントにアクセスする手順は次のとおりです。

Grid Managerにサインインします。
Webアプリケーションヘッダーで[Help] > [API Docs]を選択します。。

API処理

グリッド管理APIでは、使用できるAPI処理が次のセクションに分類されます。

accounts – 新規アカウントの作成および特定のアカウントの使用状況の取得を含む、ストレージテナントアカウントを管理するための処理。
alarms – 現在のアラームをリストし、グリッドの健全性に関する情報を返す処理。
audit – 監査構成をリストおよび更新する処理。
auth – ユーザセッション認証を実行する処理。

グリッド管理APIは、Bearerトークン認証方式をサポートしています。サインインするには、認証要求（POST /api/v2/authorize）のJSONの本文でユーザ名とパスワードを指定します。ユーザが認証されると、セキュリティトークンが返されます。このトークンを後続のAPI要求のヘッダーで指定する必要があります（「Authorization: Bearer token」）。
注:StorageGRIDシステムでシングルサインオンが有効になっている場合は、別の手順による認証が必要です。「シングルサインオンが有効な場合のAPIへのサインイン」を参照してください。

認証セキュリティの強化に関する情報については、「クロスサイトリクエストフォージェリ（CSRF）の防止」を参照してください。
compliance – StorageGRIDシステムのグローバル準拠設定を管理する処理。
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ライセンスを取得および更新する処理。
logs – ログファイルを収集してダウンロードする処理。
metrics – StorageGRIDの指標に対する処理。ある時点のみの指標クエリ、および一定期間にわたる指標クエリを含みます。グリッド管理APIは、バックエンドのデータソースとしてPrometheusシステム監視ツールを使用します。Prometheusクエリの構築については、PrometheusのWebサイトを参照してください。

注:名前に_private_が含まれる指標は内部専用です。これらの指標は、StorageGRIDのリリース間で予告なく変更される可能性があります。
ntp-servers – 外部のネットワークタイムプロトコル（NTP）サーバをリストまたは更新する処理。
objects – オブジェクトおよびオブジェクトメタデータに対する処理。
recovery – リカバリに使用可能なグリッドノードをリストする処理。
recovery-package – リカバリパッケージをダウンロードする処理。
regions – リージョンを表示および作成する処理。
server-certificates – Grid Managerのサーバ証明書を表示および更新する処理。
snmp – 現在のSNMP設定に対する処理。
users – グリッド管理者ユーザを表示および管理する処理。

処理の詳細

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

API要求の実行

HTTPアクションをクリックし、要求の詳細を表示します。
グループやユーザのIDなど、要求で追加のパラメータが必要かどうかを確認します。次に、それらの値を取得します。必要な情報を取得するために、先に別のAPI要求の実行が必要な場合もあります。
要求の本文の例を変更する必要があるかどうかを確認します。変更する場合は、[Model]をクリックすると各フィールドの要件を確認できます。
[Try it out]をクリックします。
必須パラメータを指定するか、必要に応じて要求の本文を変更します。
[Execute]をクリックします。
応答コードをチェックし、要求が正常に完了したかどうかを確認します。

最上位のリソース

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

/grid：グリッド管理者ユーザだけがアクセスできます。
/org：テナントアカウントのローカルまたはフェデレーテッドLDAPグループに所属するユーザだけがアクセスできます。詳細については、テナントアカウントの使用に関する情報を参照してください。
/private：グリッド管理者ユーザだけがアクセスできます。これらのAPIは内部使用のみを目的としており、正式にドキュメント化されていません。また、これらのAPIは予告なく変更される場合があります。