2.4. キャッシュマネージャーの操作
Data Grid キャッシュマネージャーと対話して、クラスターと使用状況の統計を取得します。
2.4.1. 基本的なキャッシュマネージャー情報の取得 リンクのコピーリンクがクリップボードにコピーされました!
GET リクエストで Cache Manager の情報を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}
GET /rest/v2/cache-managers/{cacheManagerName}
Data Grid は、次の例のように、JSON 形式の情報で応答します。
-
versionは、 Data Grid バージョンが含まれています -
nameには、コンフィギュレーションで定義されたキャッシュマネージャーの名前が含まれます。 -
coordinatorは、キャッシュ・マネージャーがクラスターのコーディネーターである場合には真となります。 -
cache_configuration_namesには、キャッシュマネージャーで定義されたすべてのキャッシュ設定の配列が含まれます -
cluster_nameには、設定で定義されたクラスターの名前が含まれます。 -
physical_addressesは、キャッシュマネージャーに関連する物理ネットワークアドレスを含みます。 -
coordinator_addressには、クラスターのコーディネーターの物理ネットワークアドレスが含まれます -
cache_manager_statusキャッシュマネージャーのライフサイクルの状態です。可能な値については、org.infinispan.lifecycle.ComponentStatusドキュメントを確認してください -
created_cache_count作成されたキャッシュの数、すべての内部およびプライベートキャッシュを除く -
running_cache_count実行中の作成されたキャッシュの数 -
node_addressには、キャッシュマネージャーの論理アドレスが含まれます -
cluster_membersおよびcluster_members_physical_addressesは、クラスターのメンバーの論理アドレスと物理アドレスの配列です。 -
cluster_sizeクラスター内のメンバーの数 -
defined_cachesキャッシュマネージャーで定義されているすべてのキャッシュのリスト。プライベートキャッシュは除きますが、アクセス可能な内部キャッシュは含まれます。 -
local_siteローカルサイトの名前。
クロスサイトレプリケーションが設定されていない場合、Data Grid は "local "を返します。 -
sites_viewクロスサイトレプリケーションに参加しているサイトのリスト。
クロスサイトレプリケーションが設定されていない場合、 Data Grid は空のリストを返します。
2.4.2. クラスターヘルスの取得 リンクのコピーリンクがクリップボードにコピーされました!
GET リクエストを使用して Data Grid クラスターのヘルス情報を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/health
GET /rest/v2/cache-managers/{cacheManagerName}/health
Data Grid は、次の例のように、JSON 形式のクラスターヘルス情報で応答します。
cluster_healthには、クラスターのヘルスが含まれます-
cluster_nameは、設定で定義されているクラスターの名前を指定します。 health_statusは、次のいずれかを提供します。-
DEGRADEDは、キャッシュの少なくとも 1 つが劣化モードにあることを示します。 -
HEALTHY_REBALANCINGは、少なくとも 1 つのキャッシュがリバランス状態にあることを示します。 -
HEALTHYは、クラスター内のすべてのキャッシュインスタンスが期待どおりに動作していることを示します。 -
FAILEDは、指定された設定でキャッシュを開始できなかったことを示します。
-
-
number_of_nodesは、クラスターメンバーの総数を表示します。非クラスター化 (スタンドアロン) サーバーの場合は値0を返します。 -
node_namesは、すべてのクラスターメンバーの配列です。スタンドアロンサーバーの場合は空です。
-
cache_healthには、キャッシュごとのヘルス情報が含まれています-
statusは HEALTHY、DEGRADED、HEALTHY_REBALANCING または FAILED です。 -
cache_name設定で定義されているキャッシュの名前。
-
2.4.3. キャッシュマネージャーのヘルスステータスの取得 リンクのコピーリンクがクリップボードにコピーされました!
認証を必要としない GET リクエストを使用してキャッシュマネージャーのヘルスステータスを取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/health/status
GET /rest/v2/cache-managers/{cacheManagerName}/health/status
Data Grid は以下のいずれかを text/plain 形式で応答します。
-
HEALTHY -
HEALTHY_REBALANCING -
DEGRADED -
FAILED
2.4.4. REST エンドポイントの可用性の確認 リンクのコピーリンクがクリップボードにコピーされました!
HEAD リクエストを使用して Data Grid サーバーの REST エンドポイントの可用性を確認します。
HEAD /rest/v2/cache-managers/{cacheManagerName}/health
HEAD /rest/v2/cache-managers/{cacheManagerName}/health
正常な応答コードを受信した場合、Data Grid REST サーバーが実行され、要求を処理しています。
2.4.5. キャッシュマネージャーのグローバル設定の取得 リンクのコピーリンクがクリップボードにコピーされました!
GET 要求を使用してキャッシュマネージャーのグローバル設定を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/config
GET /rest/v2/cache-managers/{cacheManagerName}/config
| ヘッダー | 必須またはオプション | パラメーター |
|---|---|---|
| オプション | コンテンツを返すために必要なフォーマットです。対応フォーマットは、application/jsonとapplication/xmlです。ヘッダーが指定されていない場合、JSON が想定されます。 |
参照資料
2.4.6. すべてのキャッシュの設定を取得する リンクのコピーリンクがクリップボードにコピーされました!
GET リクエストを使用してすべてのキャッシュの設定を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs
GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs
Data Grid は、以下の例のように、各キャッシュとキャッシュ設定を含む JSON 配列で応答します。
2.4.7. 利用可能なキャッシュテンプレートの一覧表示 リンクのコピーリンクがクリップボードにコピーされました!
GET リクエストで、利用可能なすべての Data Grid キャッシュテンプレートを取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs/templates
GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs/templates
テンプレートを使用したキャッシュの作成 を参照してください。
2.4.8. (実験的) キャッシュのステータスと情報の取得 リンクのコピーリンクがクリップボードにコピーされました!
Cache Manager で利用可能なすべてのキャッシュのリストを、キャッシュ・ステータスおよび詳細とともに、GET 要求で取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/caches
GET /rest/v2/cache-managers/{cacheManagerName}/caches
Data Grid は、次の例のように、使用可能な各キャッシュを一覧表示して説明する JSON 配列で応答します。
2.4.9. キャッシュマネージャー統計の取得 リンクのコピーリンクがクリップボードにコピーされました!
GET リクエストを使用してキャッシュマネージャーの統計を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/stats
GET /rest/v2/cache-managers/{cacheManagerName}/stats
Data Grid は、次の例のように、JSON 形式のキャッシュマネージャー統計で応答します。
-
statistics_enabledは、Cache Manager で統計情報の収集が有効になっている場合にtrueになります。 -
read_write_ratioは、すべてのキャッシュにわたる読み取り/書き込み比率を表示します。 -
time_since_startは、キャッシュマネージャーが開始されてからの時間を秒単位で示します。 -
time_since_resetは、キャッシュマネージャーの統計が最後にリセットされてからの秒数を示します。 -
number_of_entriesは、キャッシュマネージャーから現在すべてのキャッシュにあるエントリーの総数を示します。この統計は、ローカルキャッシュインスタンスのエントリーのみを返します。 -
total_number_of_entriesは、キャッシュマネージャーのすべてのキャッシュで実行されたストア操作の数を示します。 -
off_heap_memory_usedは、このキャッシュコンテナーが使用しているオフヒープメモリーの量をbytes[]単位で示します。 -
data_memory_usedは、現在の退避アルゴリズムが全キャッシュのデータに使用されていると推定している量をbytes[]単位で示します。エヴィクションが有効になっていない場合は0を返します。 -
missesは、すべてのキャッシュにおけるget()のミスの数を示しています。 -
remove_hitsは、すべてのキャッシュにわたる削除ヒットの数を示します。 -
remove_missesは、すべてのキャッシュにわたる削除ミスの数を示します。 -
evictionsは、すべてのキャッシュにおける エヴィクション の数を示しています。 -
average_read_timeは、すべてのキャッシュでget()操作にかかったミリ秒数の平均値を示します。 -
average_read_time_nanosはaverage_read_timeと同じですが、単位はナノ秒です。 -
average_remove_timeは、すべてのキャッシュにおけるremove()操作の平均ミリ秒数を示します。 -
average_remove_time_nanosはaverage_remove_timeと同じですが、単位はナノ秒です。 -
required_minimum_number_of_nodesは、データの一貫性を保証するために必要な最小のノード数を示します。 -
hitsは、すべてのキャッシュにおけるget()のヒット数を示します。 -
storesは、すべてのキャッシュにおけるput()操作の回数を提供します。 -
current_number_of_entries_in_memoryは、パッシベーションされたエントリーを除く、現在すべてのキャッシュにあるエントリーの総数を示します。 -
hit_ratioは、すべてのキャッシュの合計ヒット率/(ヒット+ミス) 比率を提供します。 -
retrievalsは、get()操作の総数を示しています。
2.4.10. Data Grid キャッシュマネージャーのバックアップ リンクのコピーリンクがクリップボードにコピーされました!
現在キャッシュマネージャーに保存されているリソース (キャッシュ、キャッシュテンプレート、カウンター、Protobuf スキーマ、サーバータスクなど) を含むバックアップアーカイブ (application/zip) を作成します。
POST /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
POST /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
同じ名前のバックアップがすでに存在する場合、サービスは 409 (Conflict) 応答します。directory パラメーターが無効な場合、サービスは 400 (Bad Request) 返します。202 応答は、バックアップ要求が処理のために受け入れられたことを示します。
オプションで、次のように、バックアップ操作のパラメーターを含む JSON ペイロードをリクエストに含めます。
| キー | 必須またはオプション | 値 |
|---|---|---|
|
| オプション | バックアップアーカイブを作成および保存するサーバー上の場所を指定します。 |
|
| オプション | バックアップするリソースを JSON 形式で指定します。デフォルトでは、すべてのリソースがバックアップされます。1 つまたは複数のリソースを指定した場合、Data Grid はそれらのリソースのみをバックアップします。詳細については、リソースパラメーターの表を参照してください。 |
| キー | 必須またはオプション | 値 |
|---|---|---|
|
| オプション |
バックアップするキャッシュ名の配列を指定するか、すべてのキャッシュを対象とする |
|
| オプション |
バックアップするキャッシュテンプレートの配列、またはすべてのテンプレートの |
|
| オプション |
バックアップするカウンター名の配列、またはすべてのカウンターの |
|
| オプション |
バックアップする Protobuf スキーマ名の配列、またはすべてのスキーマの |
|
| オプション |
バックアップするサーバータスクの配列、またはすべてのタスクの |
次の例では、指定されたディレクトリーに [cache1,cache2] という名前のすべてのカウンターとキャッシュを含むバックアップアーカイブを作成します。
2.4.11. バックアップの一覧表示 リンクのコピーリンクがクリップボードにコピーされました!
進行中、完了、または失敗したすべてのバックアップ操作の名前を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/backups
GET /rest/v2/cache-managers/{cacheManagerName}/backups
Data Grid は、以下の例のように、すべてのバックアップ名の配列で応答します。
["backup1", "backup2"]
["backup1", "backup2"]
2.4.12. バックアップの可用性の確認 リンクのコピーリンクがクリップボードにコピーされました!
バックアップ操作が完了していることを確認します。
HEAD /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
HEAD /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
200 のレスポンスは、バックアップアーカイブが利用可能であることを示します。202 の応答は、バックアップ操作が進行中であることを示します。
2.4.13. バックアップアーカイブのダウンロード リンクのコピーリンクがクリップボードにコピーされました!
サーバーからバックアップアーカイブをダウンロードします。
GET /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
GET /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
200 のレスポンスは、バックアップアーカイブが利用可能であることを示します。202 の応答は、バックアップ操作が進行中であることを示します。
2.4.14. バックアップアーカイブの削除 リンクのコピーリンクがクリップボードにコピーされました!
サーバーからバックアップアーカイブを削除します。
DELETE /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
DELETE /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
204 応答は、バックアップアーカイブが削除されたことを示します。202 応答は、バックアップ操作が進行中であるが、操作が完了すると削除されることを示します。
2.4.15. バックアップアーカイブからの Data Grid リソースの復元 リンクのコピーリンクがクリップボードにコピーされました!
バックアップアーカイブから Data Grid リソースを復元します。提供されている {restoreName} は、復元の進行状況を追跡するためのものであり、復元されるバックアップファイルの名前とは無関係です。
バックアップアーカイブ内のコンテナー名が {cacheManagerName} と一致する場合にのみ、リソースを復元できます。
POST /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
POST /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
202 応答は、復元要求が処理のために受け入れられたことを示します。
2.4.15.1. Data Grid サーバー上のバックアップアーカイブからの復元 リンクのコピーリンクがクリップボードにコピーされました!
サーバー上のアーカイブからバックアップする場合は、POST リクエストに application/json コンテンツタイプを使用します。
| キー | 必須またはオプション | 値 |
|---|---|---|
|
| 必須 | 復元するバックアップアーカイブのパスを指定します。 |
|
| オプション | 復元するリソースを JSON 形式で指定します。デフォルトでは、すべてのリソースを復元します。1 つまたは複数のリソースを指定した場合、Data Grid はそれらのリソースのみをリストアします。詳細については、リソースパラメーターの表を参照してください。 |
| キー | 必須またはオプション | 値 |
|---|---|---|
|
| オプション |
バックアップするキャッシュ名の配列を指定するか、すべてのキャッシュを対象とする |
|
| オプション |
バックアップするキャッシュテンプレートの配列、またはすべてのテンプレートの |
|
| オプション |
バックアップするカウンター名の配列、またはすべてのカウンターの |
|
| オプション |
バックアップする Protobuf スキーマ名の配列、またはすべてのスキーマの |
|
| オプション |
バックアップするサーバータスクの配列、またはすべてのタスクの |
次の例では、サーバー上のバックアップアーカイブからすべてのカウンターを復元します。
2.4.15.2. ローカルバックアップアーカイブからの復元 リンクのコピーリンクがクリップボードにコピーされました!
ローカルのバックアップアーカイブをサーバーにアップロードするには、POST リクエストに multipart/form-data コンテンツタイプを使用します。
| パラメーター | Content-Type | 必須またはオプション | 値 |
|---|---|---|---|
|
|
| 必須 | 復元するバックアップアーカイブのバイトを指定します。 |
|
|
| オプション | リクエストパラメーターの JSON オブジェクトを定義します。 |
要求の例
2.4.16. リストの復元 リンクのコピーリンクがクリップボードにコピーされました!
進行中、完了、または失敗したすべての復元要求の名前を取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/restores
GET /rest/v2/cache-managers/{cacheManagerName}/restores
Data Grid は、次の例のように、すべての復元名の配列で応答します。
["restore1", "restore2"]
["restore1", "restore2"]
2.4.17. 復元の進行状況を確認する リンクのコピーリンクがクリップボードにコピーされました!
復元操作が完了したことを確認します。
HEAD /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
HEAD /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
201 (Created) 応答は、リストア操作が完了したことを示します。202 (Accepted) 応答は、バックアップ操作が進行中であることを示します。
2.4.18. 復元メタデータの削除 リンクのコピーリンクがクリップボードにコピーされました!
サーバーから復元要求のメタデータを削除します。このアクションにより、復元要求に関連付けられているすべてのメタデータが削除されますが、復元されたコンテンツは削除されません。リクエストのメタデータを削除すると、リクエスト名を使用して後続の復元操作を実行できます。
DELETE /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
DELETE /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
204 (No Content) 応答は、復元メタデータが削除されたことを示します。202 (Accepted) 応答は、復元操作が進行中であり、操作が完了すると削除されることを示します。
2.4.19. キャッシュ・マネージャーによるクロスサイト操作 リンクのコピーリンクがクリップボードにコピーされました!
Cache Managers でクロスサイト操作を行うと、すべてのキャッシュに操作が適用されます。
2.4.19.1. バックアップ場所のステータスの取得 リンクのコピーリンクがクリップボードにコピーされました!
GET 要求により、キャッシュ・マネージャーからすべてのバックアップ・ロケーションのステータスを取得します。
GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/
GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/
Data Grid は、以下の例のように JSON 形式でステータスを応答します。
| 値 | 説明 |
|---|---|
|
| ローカルクラスター内のすべてのノードには、バックアップの場所を含むクロスサイトビューがあります。 |
|
| ローカルクラスター内のノードには、バックアップの場所とのクロスサイトビューがありません。 |
|
| ローカルクラスター内の一部のノードにはバックアップの場所を含むクロスサイトビューがあり、ローカルクラスター内の他のノードにはクロスサイトビューがありません。応答は、各ノードのステータスを示します。 |
2.4.19.2. バックアップ先をオフラインにする リンクのコピーリンクがクリップボードにコピーされました!
?action=take-offline パラメーターで、バックアップロケーションをオフラインにします。
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=take-offline
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=take-offline
2.4.19.3. バックアップ場所をオンラインにする リンクのコピーリンクがクリップボードにコピーされました!
?action=bring-online パラメーターを使用してバックアップ場所をオンラインにします。
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=bring-online
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=bring-online
2.4.19.4. 状態転送モードの取得 リンクのコピーリンクがクリップボードにコピーされました!
GET リクエストで状態転送モードを確認してください。
GET /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode
GET /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode
2.4.19.5. 状態転送モードの設定 リンクのコピーリンクがクリップボードにコピーされました!
?action=set パラメーターを使用して状態転送モードを設定します。
POST /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode?action=set&mode={mode}
POST /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode?action=set&mode={mode}
2.4.19.6. 状態転送の開始 リンクのコピーリンクがクリップボードにコピーされました!
?action=start-push-state パラメーターを使用して、すべてのキャッシュの状態をリモートサイトにプッシュします。
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=start-push-state
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=start-push-state
2.4.19.7. 状態転送のキャンセル リンクのコピーリンクがクリップボードにコピーされました!
?action=cancel-push-state パラメーターを使用して、進行中の状態転送操作をキャンセルします。
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=cancel-push-state
POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=cancel-push-state