Grid Managerのユーザ インターフェイスの代わりにグリッド管理REST APIを使用して、システム管理タスクを実行できます。たとえば、このAPIを使用して処理を自動化したり、ユーザなどの複数のエンティティを迅速に作成したりできます。
グリッド管理APIでは、Swaggerオープン ソースAPIプラットフォームを使用します。Swaggerのわかりやすいユーザ インターフェイスを使用して、開発者および一般のユーザはStorageGRIDのリアルタイム処理をAPIで実行できます。Swaggerのユーザ インターフェイスでは、各API処理に関する詳細情報とドキュメントを参照できます。
グリッド管理APIでは、使用できるAPI処理が次のセクションに分類されます。
accounts – 新規アカウントの作成および特定のアカウントの使用状況の取得を含む、ストレージ テナント アカウントを管理するための処理。
alarms – 現在のアラームをリストし、グリッドの健全性に関する情報を返す処理。
audit – 監査構成をリストおよび更新する処理。
auth – ユーザ セッション認証を実行する処理。
認証セキュリティの強化に関する情報については、「クロスサイト リクエスト フォージェリ(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サイトを参照してください。
ntp-servers – 外部のネットワーク タイム プロトコル(NTP)サーバをリストまたは更新する処理。
objects – オブジェクトおよびオブジェクト メタデータに対する処理。
recovery – リカバリに使用可能なグリッド ノードをリストする処理。
recovery-package – リカバリ パッケージをダウンロードする処理。
regions – リージョンを表示および作成する処理。
server-certificates – Grid Managerのサーバ証明書を表示および更新する処理。
snmp – 現在のSNMP設定に対する処理。
users – グリッド管理者ユーザを表示および管理する処理。
各API処理を展開表示すると、HTTPアクション、エンドポイントURL、必須またはオプションのパラメータのリスト、要求の本文の例(必要な場合)、想定される応答を確認できます。
グリッド管理APIで使用可能な最上位のリソースは次のとおりです。