グリッド管理 API を使用します
-
このドキュメント ページのPDF
- アプライアンスハードウェアを設置して保守します
- ソフトウェアをインストールしてアップグレードする
- システム管理を実行する
PDF版ドキュメントのセット
Creating your file...
Grid Manager のユーザインターフェイスの代わりにグリッド管理 REST API を使用して、システム管理タスクを実行できます。たとえば、 API を使用して処理を自動化したり、ユーザなどの複数のエンティティを迅速に作成したりできます。
トップレベルのリソース
グリッド管理 API で使用可能な最上位のリソースは次のとおりです。
-
/grid
:アクセスは Grid Manager ユーザに制限され、設定されたグループ権限に基づいています。 -
/org
: テナントアカウントのローカル LDAP グループまたはフェデレーション LDAP グループに属しているユーザにのみアクセスが許可されます詳細については、を参照してください テナントアカウントを使用する。 -
「 /private 」:アクセスは Grid Manager ユーザに制限され、設定されたグループ権限に基づいて行われます。プライベート API は予告なく変更される場合があります。StorageGRID プライベートエンドポイントは、要求の API バージョンも無視します。
問題 API 要求
グリッド管理 API では、 Swagger オープンソース API プラットフォームを使用します。Swagger のわかりやすいユーザインターフェイスを使用して、開発者および一般のユーザは StorageGRID で API を使用してリアルタイムの処理を実行できます。
Swagger のユーザインターフェイスでは、各 API 処理に関する詳細情報とドキュメントを参照できます。
-
を使用して Grid Manager にサインインします サポートされている Web ブラウザ。
-
特定のアクセス権限が必要です。
API Docs Web ページを使用して実行する API 処理はすべてその場で実行されます。設定データやその他のデータを誤って作成、更新、または削除しないように注意してください。 |
-
Grid Manager ヘッダーでヘルプアイコンを選択し、 * API ドキュメント * を選択します。
-
プライベート API を使用して操作を実行するには、 StorageGRID 管理 API ページで * プライベート API ドキュメントへ移動 * を選択します。
プライベート API は予告なく変更される場合があります。StorageGRID プライベートエンドポイントは、要求の API バージョンも無視します。
-
目的の処理を選択します。
API 処理を拡張すると、 GET 、 PUT 、 UPDATE 、 DELETE など、使用可能な HTTP アクションを確認できます。
-
HTTP アクションを選択して、要求の詳細を確認します。これには、エンドポイント URL 、必須またはオプションのパラメータのリスト、要求の本文の例(必要な場合)、想定される応答が含まれます。
-
グループやユーザの ID など、要求で追加のパラメータが必要かどうかを確認します。次に、これらの値を取得します。必要な情報を取得するために、先に別の API 要求の問題 が必要になることがあります。
-
要求の本文の例を変更する必要があるかどうかを判断します。その場合は、 * Model * を選択して各フィールドの要件を確認できます。
-
[* 試してみてください * ] を選択します。
-
必要なパラメータを指定するか、必要に応じて要求の本文を変更します。
-
[* Execute] を選択します。
-
応答コードを確認し、要求が成功したかどうかを判断します。