2.4. キャッシュマネージャーの操作

GET リクエストを使用して、キャッシュマネージャーに関する情報を取得します。

GET /rest/v2/container

Data Grid は、次の例のように、JSON 形式の情報で応答します。

{
    "version":"xx.x.x-FINAL",
    "name":"default",
    "coordinator":true,
    "cache_configuration_names":[
        "___protobuf_metadata",
        "cache2",
        "CacheManagerResourceTest",
        "cache1"
    ],
    "cluster_name":"ISPN",
    "physical_addresses":"[127.0.0.1:35770]",
    "coordinator_address":"CacheManagerResourceTest-NodeA-49696",
    "cache_manager_status":"RUNNING",
    "created_cache_count":"3",
    "running_cache_count":"3",
    "node_address":"CacheManagerResourceTest-NodeA-49696",
    "cluster_members":[
        "CacheManagerResourceTest-NodeA-49696",
        "CacheManagerResourceTest-NodeB-28120"
    ],
    "cluster_members_physical_addresses":[
        "127.0.0.1:35770",
        "127.0.0.1:60031"
    ],
    "cluster_size":2,
    "defined_caches":[
        {
            "name":"CacheManagerResourceTest",
            "started":true
        },
        {
            "name":"cache1",
            "started":true
        },
        {
            "name":"___protobuf_metadata",
            "started":true
        },
        {
            "name":"cache2",
            "started":true
        }
    ],
    "local_site": "LON",
    "relay_node": true,
    "relay_nodes_address": [
      "CacheManagerResourceTest-NodeA-49696"
    ],
    "sites_view": [
        "LON",
        "NYC"
    ],
    "rebalancing_enabled": true
}

GET リクエストを使用して Data Grid クラスターのヘルス情報を取得します。

GET /rest/v2/container/health

Data Grid は、次の例のように、JSON 形式のクラスターヘルス情報で応答します。

{
    "cluster_health":{
        "cluster_name":"ISPN",
        "health_status":"HEALTHY",
        "number_of_nodes":2,
        "node_names":[
            "NodeA-36229",
            "NodeB-28703"
        ]
    },
    "cache_health":[
        {
            "status":"HEALTHY",
            "cache_name":"___protobuf_metadata"
        },
        {
            "status":"HEALTHY",
            "cache_name":"cache2"
        },
        {
            "status":"HEALTHY",
            "cache_name":"mycache"
        },
        {
            "status":"HEALTHY",
            "cache_name":"cache1"
        }
    ]
}

認証を必要としない GET リクエストを使用して、Data Grid コンテナーの健全性ステータスを取得します。

GET /rest/v2/container/health/status

Data Grid は以下のいずれかを text/plain 形式で応答します。

HEAD リクエストを使用して Data Grid サーバーの REST エンドポイントの可用性を確認します。

HEAD /rest/v2/container/health

正常な応答コードを受信した場合、Data Grid REST サーバーが実行され、要求を処理しています。

、GET リクエストを使用して、データコンテナーのグローバル設定を取得します。

GET /rest/v2/container/config

GET リクエストを使用してすべてのキャッシュの設定を取得します。

GET /rest/v2/container/cache-configs

Data Grid は、以下の例のように、各キャッシュとキャッシュ設定を含む JSON 配列で応答します。

[
  {
      "name":"cache1",
      "configuration":{
          "distributed-cache":{
              "mode":"SYNC",
              "partition-handling":{
                  "when-split":"DENY_READ_WRITES"
              },
              "statistics":true
          }
      }
  },
  {
      "name":"cache2",
      "configuration":{
          "distributed-cache":{
              "mode":"SYNC",
              "transaction":{
                  "mode":"NONE"
              }
          }
      }
  }
]

GET リクエストで、利用可能なすべての Data Grid キャッシュテンプレートを取得します。

GET /rest/v2/cache-configs/templates

GET リクエストを使用して、コンテナーの統計情報を取得します。

GET /rest/v2/container/stats

Data Grid は、次の例のように、JSON 形式のキャッシュマネージャー統計で応答します。

{
    "statistics_enabled":true,
    "read_write_ratio":0.0,
    "time_since_start":1,
    "time_since_reset":1,
    "number_of_entries":0,
    "off_heap_memory_used":0,
    "data_memory_used":0,
    "misses":0,
    "remove_hits":0,
    "remove_misses":0,
    "evictions":0,
    "average_read_time":0,
    "average_read_time_nanos":0,
    "average_write_time":0,
    "average_write_time_nanos":0,
    "average_remove_time":0,
    "average_remove_time_nanos":0,
    "required_minimum_number_of_nodes":1,
    "hits":0,
    "stores":0,
    "current_number_of_entries_in_memory":0,
    "hit_ratio":0.0,
    "retrievals":0
}

POST リクエストで統計情報をリセットします。

POST /rest/v2/container/stats?action=reset

POST リクエストを使用して、サーバー上の Data Grid コンテナーをシャットダウンします。

POST /rest/v2/container?action=shutdown

Data Grid は 204 (No Content) と応答し、コンテナー内のすべてのキャッシュをシャットダウンします。サーバーはアクティブなエンドポイントとクラスタリングで実行されたままですが、コンテナーリソースへの REST 呼び出しは、503 Service Unavailable 応答になります。

すべてのキャッシュの自動リバランスをオンにします。

POST /rest/v2/container?action=enable-rebalancing

すべてのキャッシュの自動リバランスをオフにします。

POST /rest/v2/container?action=disable-rebalancing

現在 Data Grid に保存されているリソース (キャッシュ、キャッシュテンプレート、カウンター、Protobuf スキーマ、サーバータスクなど) を含むバックアップアーカイブ application/zip を作成します。

POST /rest/v2/container/backups/{backupName}

同じ名前のバックアップがすでに存在する場合、サービスは 409 (Conflict) 応答します。directory パラメーターが無効な場合、サービスは 400 (Bad Request) 返します。202 応答は、バックアップ要求が処理のために受け入れられたことを示します。

オプションで、次のように、バックアップ操作のパラメーターを含む JSON ペイロードをリクエストに含めます。

次の例では、指定されたディレクトリーに [cache1,cache2] という名前のすべてのカウンターとキャッシュを含むバックアップアーカイブを作成します。

{
  "directory": "/path/accessible/to/the/server",
  "resources": {
    "caches": ["cache1", "cache2"],
    "counters": ["*"]
  }
}

進行中、完了、または失敗したすべてのバックアップ操作の名前を取得します。

GET /rest/v2/container/backups

Data Grid は、以下の例のように、すべてのバックアップ名の配列で応答します。

["backup1", "backup2"]

バックアップ操作が完了していることを確認します。

HEAD /rest/v2/container/backups/{backupName}

200 のレスポンスは、バックアップアーカイブが利用可能であることを示します。202 の応答は、バックアップ操作が進行中であることを示します。

サーバーからバックアップアーカイブをダウンロードします。

GET /rest/v2/container/backups/{backupName}

200 のレスポンスは、バックアップアーカイブが利用可能であることを示します。202 の応答は、バックアップ操作が進行中であることを示します。

サーバーからバックアップアーカイブを削除します。

DELETE /rest/v2/container/backups/{backupName}

204 応答は、バックアップアーカイブが削除されたことを示します。202 応答は、バックアップ操作が進行中であるが、操作が完了すると削除されることを示します。

バックアップアーカイブから Data Grid リソースを復元します。提供されている {restoreName} は、復元の進行状況を追跡するためのものであり、復元されるバックアップファイルの名前とは無関係です。

POST /rest/v2/container/restores/{restoreName}

202 応答は、復元要求が処理のために受け入れられたことを示します。

{
  "location": "/path/accessible/to/the/server/backup-to-restore.zip",
  "resources": {
    "counters": ["*"]
  }
}

Content-Type: multipart/form-data; boundary=5ec9bc07-f069-4662-a535-46069afeda32
Content-Length: 7721

--5ec9bc07-f069-4662-a535-46069afeda32
Content-Disposition: form-data; name="resources"
Content-Length: 23

{"scripts":["test.js"]}
--5ec9bc07-f069-4662-a535-46069afeda32
Content-Disposition: form-data; name="backup"; filename="testManagerRestoreParameters.zip"
Content-Type: application/zip
Content-Length: 7353

<zip-bytes>
--5ec9bc07-f069-4662-a535-46069afeda32--

進行中、完了、または失敗したすべての復元要求の名前を取得します。

GET /rest/v2/container/restores

Data Grid は、次の例のように、すべての復元名の配列で応答します。

["restore1", "restore2"]

復元操作が完了したことを確認します。

HEAD /rest/v2/container/restores/{restoreName}

201 (Created) 応答は、リストア操作が完了したことを示します。202 (Accepted) 応答は、バックアップ操作が進行中であることを示します。

サーバーから復元要求のメタデータを削除します。このアクションにより、復元要求に関連付けられているすべてのメタデータが削除されますが、復元されたコンテンツは削除されません。リクエストのメタデータを削除すると、リクエスト名を使用して後続の復元操作を実行できます。

DELETE /rest/v2/container/restores/{restoreName}

204 (No Content) 応答は、復元メタデータが削除されたことを示します。202 (Accepted) 応答は、復元操作が進行中であり、操作が完了すると削除されることを示します。

Server-Sent Events を使用して、設定変更に関するイベントを受信します。event 値は、create-cache、remove-cache、update-cache、create-template、remove-template、または update- template のいずれかになります。data 値には、作成されたエンティティーの宣言型設定が含まれます。削除イベントには、削除されたエンティティーの名前のみが含まれます。

GET /rest/v2/container/config?action=listen

Server-Sent Events を使用してコンテナーからイベントを受け取ります。発行されたイベントはログに記録された情報に基づいているため、各イベントにはメッセージに関連付けられた識別子が含まれています。event 値は lifecycle-event になります。data には、message、category、level、timestamp、owner、context、および scope を含む、ログに記録された情報があり、その一部は空である可能性があります。現在、LIFECYCLE イベントのみを公開しています。

GET /rest/v2/container?action=listen

Cache Managers でクロスサイト操作を行うと、すべてのキャッシュに操作が適用されます。

GET /rest/v2/container/x-site/backups/

{
   "SFO-3":{
      "status":"online"
   },
   "NYC-2":{
      "status":"mixed",
      "online":[
         "CACHE_1"
      ],
      "offline":[
         "CACHE_2"
      ],
      "mixed": [
         "CACHE_3"
      ]
   }
}

GET /rest/v2/container/x-site/backups/{site}

POST /rest/v2/container/x-site/backups/{siteName}?action=take-offline

POST /rest/v2/container/x-site/backups/{siteName}?action=bring-online

GET /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode

POST /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode?action=set&mode={mode}

POST /rest/v2/container/x-site/backups/{siteName}?action=start-push-state

POST /rest/v2/container/x-site/backups/{siteName}?action=cancel-push-state