第2章 Data Grid REST API との連携

2.1.1. キャッシュの作成
リンクのコピー

XML または JSON 設定をペイロードに含む POST リクエストで、Data Grid クラスター全体に名前付きキャッシュを作成します。

POST /rest/v2/caches/{cacheName}

POST /rest/v2/caches/{cacheName}

Copy to Clipboard

Toggle word wrap

Expand

表2.1 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Content-Type`	必須	Data Grid 設定のペイロードの MediaType を設定します ( `application/xml` または `application/json` のいずれか)。
`Flags`	オプション	AdminFlags を設定するために使用されます

2.1.1.1. キャッシュ設定
リンクのコピー

キャッシュ設定は、XML または JSON 形式で提供できます。

XML

<distributed-cache name="myCache" mode="SYNC">
  <encoding media-type="application/x-protostream"/>
  <memory max-count="1000000" when-full="REMOVE"/>
</distributed-cache>

<distributed-cache name="myCache" mode="SYNC">
  <encoding media-type="application/x-protostream"/>
  <memory max-count="1000000" when-full="REMOVE"/>
</distributed-cache>

Copy to Clipboard

Toggle word wrap

JSON

{
  "distributed-cache": {
    "name": "myCache",
    "mode": "SYNC",
    "encoding": {
      "media-type": "application/x-protostream"
      },
    "memory": {
      "max-count": 1000000,
      "when-full": "REMOVE"
    }
  }
}

{
  "distributed-cache": {
    "name": "myCache",
    "mode": "SYNC",
    "encoding": {
      "media-type": "application/x-protostream"
      },
    "memory": {
      "max-count": 1000000,
      "when-full": "REMOVE"
    }
  }
}

Copy to Clipboard

Toggle word wrap

JSON 形式

JSON 形式のキャッシュ設定は、XML 設定の構造に従う必要があります。* XML 要素が JSON オブジェクトになります。* XML 属性は JSON フィールドになります。

2.1.2. キャッシュの検証
リンクのコピー

HEAD リクエストで Data Grid クラスターでキャッシュが利用可能かどうかを確認します。

HEAD /rest/v2/caches/{cacheName}

HEAD /rest/v2/caches/{cacheName}

Copy to Clipboard

Toggle word wrap

2.1.3. テンプレートを使用したキャッシュの作成
リンクのコピー

POST リクエストと ?template= パラメーターを使用して、Data Grid テンプレートからキャッシュを作成します。

POST /rest/v2/caches/{cacheName}?template={templateName}

POST /rest/v2/caches/{cacheName}?template={templateName}

Copy to Clipboard

Toggle word wrap

ヒント

使用可能なキャッシュテンプレートを一覧表示するを参照してください。

2.1.4. キャッシュ設定の取得
リンクのコピー

GET リクエストで Data Grid のキャッシュ設定を取得します。

GET /rest/v2/caches/{name}?action=config

GET /rest/v2/caches/{name}?action=config

Copy to Clipboard

Toggle word wrap

Expand

表2.2 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Accept`	オプション	コンテンツを返すために必要な形式を設定します。対応フォーマットは、`application/xml` と `application/json` です。デフォルトは `application/json` です。詳細については、 Accept を参照してください。

2.1.5. キャッシュ設定を JSON に変換する
リンクのコピー

有効な XML 設定と ?action=toJSON パラメーターを使用して POST 要求を呼び出します。Data Grid は、設定の同等の JSON 表現で応答します。

POST /rest/v2/caches?action=toJSON

POST /rest/v2/caches?action=toJSON

Copy to Clipboard

Toggle word wrap

2.1.6. すべてのキャッシュの詳細を取得する
リンクのコピー

GET リクエストを呼び出し、Data Grid キャッシュのすべての詳細を取得します。

GET /rest/v2/caches/{name}

GET /rest/v2/caches/{name}

Copy to Clipboard

Toggle word wrap

Data Grid は、以下のような JSON レスポンスを提供します。

{
  "stats": {
    "time_since_start": -1,
    "time_since_reset": -1,
    "hits": -1,
    "current_number_of_entries": -1,
    "current_number_of_entries_in_memory": -1,
    "total_number_of_entries": -1,
    "stores": -1,
    "off_heap_memory_used": -1,
    "data_memory_used": -1,
    "retrievals": -1,
    "misses": -1,
    "remove_hits": -1,
    "remove_misses": -1,
    "evictions": -1,
    "average_read_time": -1,
    "average_read_time_nanos": -1,
    "average_write_time": -1,
    "average_write_time_nanos": -1,
    "average_remove_time": -1,
    "average_remove_time_nanos": -1,
    "required_minimum_number_of_nodes": -1
  },
  "size": 0,
  "configuration": {
    "distributed-cache": {
      "mode": "SYNC",
      "transaction": {
        "stop-timeout": 0,
        "mode": "NONE"
      }
    }
  },
  "rehash_in_progress": false,
  "bounded": false,
  "indexed": false,
  "persistent": false,
  "transactional": false,
  "secured": false,
  "has_remote_backup": false,
  "indexing_in_progress": false,
  "statistics": false
}

{
  "stats": {
    "time_since_start": -1,
    "time_since_reset": -1,
    "hits": -1,
    "current_number_of_entries": -1,
    "current_number_of_entries_in_memory": -1,
    "total_number_of_entries": -1,
    "stores": -1,
    "off_heap_memory_used": -1,
    "data_memory_used": -1,
    "retrievals": -1,
    "misses": -1,
    "remove_hits": -1,
    "remove_misses": -1,
    "evictions": -1,
    "average_read_time": -1,
    "average_read_time_nanos": -1,
    "average_write_time": -1,
    "average_write_time_nanos": -1,
    "average_remove_time": -1,
    "average_remove_time_nanos": -1,
    "required_minimum_number_of_nodes": -1
  },
  "size": 0,
  "configuration": {
    "distributed-cache": {
      "mode": "SYNC",
      "transaction": {
        "stop-timeout": 0,
        "mode": "NONE"
      }
    }
  },
  "rehash_in_progress": false,
  "bounded": false,
  "indexed": false,
  "persistent": false,
  "transactional": false,
  "secured": false,
  "has_remote_backup": false,
  "indexing_in_progress": false,
  "statistics": false
}

Copy to Clipboard

Toggle word wrap

stats キャッシュの現在の状態を表示します。
size キャッシュの推定サイズ。
configuration キャッシュ設定。
rehash_in_progress リハッシュが進行中の場合は true。
indexing_in_progress インデックス作成中の場合は true。
bounded 有効期限が有効になっている。
indexed キャッシュがインデックス化されている場合は true。
persistent キャッシュが永続化されている場合は true。
transactional キャッシュがトランザクショナルである場合は true。
secured キャッシュが保護されている場合は true。
has_remote_backup キャッシュがリモートバックアップを持っている場合は true。

2.1.7. エントリーの追加
リンクのコピー

POST リクエストでキャッシュにエントリーを追加します。

POST /rest/v2/caches/{cacheName}/{cacheKey}

POST /rest/v2/caches/{cacheName}/{cacheKey}

Copy to Clipboard

Toggle word wrap

前述の要求は cacheKey キーで cacheName を指定のキャッシュに、ペイロード、またはリクエストボディを配置します。リクエストは、既存のデータを置き換え、適用可能であれば、Time-To-Live と Last-Modified の値を更新します。

エントリーが正常に作成されると、サービスは 204 (No Content) を返します。

指定されたキーに既に値が存在する場合、POST リクエストは 409 (Conflict) を返し、値の変更は行いません。値を更新するには、PUT リクエストを使用する必要があります。エントリーの入れ替えをご覧ください。

Expand

表2.3 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Key-Content-Type`	オプション	リクエストのキーのコンテンツタイプを設定します。詳細は、Key-Content-Type を参照してください。
`Content-Type`	オプション	キーの値の MediaType を設定します。
`timeToLiveSeconds`	オプション	エントリーが自動的に削除されるまでの秒数を設定します。このパラメーターを設定しない場合、DataGrid は設定のデフォルト値を使用します。負の値を設定すると、エントリーが削除されることはありません。
`maxIdleTimeSeconds`	オプション	エントリーがアイドル状態になることができる秒数を設定します。最大アイドル時間が経過してもエントリーの読み取りまたは書き込み操作が発生しない場合、エントリーは自動的に削除されます。このパラメーターを設定しない場合、DataGrid は設定のデフォルト値を使用します。負の値を設定すると、エントリーが削除されることはありません。
`flags`	オプション	エントリーの追加に使用されるフラグ。詳細については、フラグを参照してください。

注記

flags ヘッダーは、キャッシュでのデータ操作を含む他のすべての操作にも適用されます。

注記

timeToLiveSeconds と maxIdleTimeSeconds の両方の値が 0 の場合、Data Grid は設定のデフォルトの lifespan と maxIdle の値を使用します。

only maxIdleTimeSeconds のみ値が 0 の場合、Data Grid が使用します。

コンフィグレーションのデフォルトの maxIdle 値を使用します。
リクエストパラメーターとして渡した timeToLiveSeconds の値、または値を渡さなかった場合は -1 の値です。

timeToLiveSeconds の値だけが 0 の場合、Data Grid は

設定のデフォルトの lifespan 値を使用。
リクエストパラメーターとして渡された maxIdle の値、または値を渡さない場合は -1 の値を使用。

2.1.8. エントリーの置き換え
リンクのコピー

キャッシュ内のエントリーを PUT リクエストに置き換えます。

PUT /rest/v2/caches/{cacheName}/{cacheKey}

PUT /rest/v2/caches/{cacheName}/{cacheKey}

Copy to Clipboard

Toggle word wrap

指定されたキーの値がすでに存在する場合、 PUT 要求は値を更新します。既存の値を変更したくない場合は、値を変更する代わりに、409 (Conflict) を返す POST リクエストを使用してください。値の追加を参照してください。

2.1.9. キーによるデータの取得
リンクのコピー

GET リクエストを使用して特定のキーのデータを取得します。

GET /rest/v2/caches/{cacheName}/{cacheKey}

GET /rest/v2/caches/{cacheName}/{cacheKey}

Copy to Clipboard

Toggle word wrap

サーバーは、応答本文の指定されたキー cacheKey の下にある指定されたキャッシュ cacheName からデータを返します。応答には、MediaType ネゴシエーションに対応する Content-Type ヘッダーが含まれています。

注記

ブラウザーは、たとえばコンテンツ配信ネットワーク (CDN) として、キャッシュに直接アクセスすることもできます。Data Grid は、各エントリーに固有のETagを、Last-Modified および Expires ヘッダーフィールドとともに返します。

これらのフィールドは、リクエストで返されるデータの状態に関する情報を提供します。ETag を使用すると、ブラウザーやその他のクライアントは、変更されたデータのみを要求できるため、帯域幅が節約されます。

Expand

表2.4 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Key-Content-Type`	オプション	リクエストのキーのコンテンツタイプを設定します。デフォルトは `application/x-java-object; type=java.lang.String` です。詳細は、Key-Content-Type を参照してください。
`Accept`	オプション	コンテンツを返すために必要な形式を設定します。詳細については、 Accept を参照してください。

ヒント

extended パラメーターをクエリー文字列に追加して、追加情報を取得します。

GET /rest/v2/caches/{cacheName}/{cacheKey}?extended

GET /rest/v2/caches/{cacheName}/{cacheKey}?extended

Copy to Clipboard

Toggle word wrap

上記のリクエストはカスタムヘッダーを返します:

Cluster-Primary-Owner は、キーのプライマリー所有者であるノード名を返します。
Cluster-Node-Name は、要求を処理したサーバーの JGroups ノード名を返します。
Cluster-Physical-Address は、要求を処理したサーバーの物理 JGroups アドレスを返します。

2.1.10. エントリーが存在するかどうかの確認
リンクのコピー

HEAD リクエストで特定のエントリーが存在することを確認します。

HEAD /rest/v2/caches/{cacheName}/{cacheKey}

HEAD /rest/v2/caches/{cacheName}/{cacheKey}

Copy to Clipboard

Toggle word wrap

上記のリクエストは、ヘッダーフィールドと、エントリーとともに保存したものと同じコンテンツのみを返します。たとえば、文字列を保存した場合、リクエストは文字列を返します。バイナリー、base64 エンコード、blob、またはシリアル化された Java オブジェクトを保存した場合、DataGrid はリクエストのコンテンツを逆シリアル化しません。

注記

HEAD リクエストは、extended パラメーターもサポートしています。

Expand

表2.5 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Key-Content-Type`	オプション	リクエストのキーのコンテンツタイプを設定します。デフォルトは `application/x-java-object; type=java.lang.String` です。詳細は、Key-Content-Type を参照してください。

2.1.11. エントリーの削除
リンクのコピー

DELETE リクエストを使用してキャッシュからエントリーを 削除 します。

DELETE /rest/v2/caches/{cacheName}/{cacheKey}

DELETE /rest/v2/caches/{cacheName}/{cacheKey}

Copy to Clipboard

Toggle word wrap

Expand

表2.6 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Key-Content-Type`	オプション	リクエストのキーのコンテンツタイプを設定します。デフォルトは `application/x-java-object; type=java.lang.String` です。詳細は、Key-Content-Type を参照してください。

2.1.12. キャッシュの削除
リンクのコピー

DELETE リクエストを使用して Data Grid クラスターからキャッシュを DELETE 削除します。

DELETE /rest/v2/caches/{cacheName}

DELETE /rest/v2/caches/{cacheName}

Copy to Clipboard

Toggle word wrap

2.1.13. キャッシュからのすべてのキーの取得
リンクのコピー

GET リクエストを呼び出して、キャッシュ内のすべてのキーを JSON 形式で取得します。

GET /rest/v2/caches/{cacheName}?action=keys

GET /rest/v2/caches/{cacheName}?action=keys

Copy to Clipboard

Toggle word wrap

Expand

表2.7 リクエストパラメーター
パラメーター	必須またはオプション	値
`limit`	オプション	InputStream を使用して取得するキーの最大数を指定します。負の値はすべてのキーを取得します。デフォルト値は `-1` です。
`batch`	オプション	キーを取得するときの内部バッチサイズを指定します。デフォルト値は `1000` です。

2.1.14. キャッシュからのすべてのエントリーの取得
リンクのコピー

GET リクエストを呼び出し、キャッシュ内のすべてのエントリーを JSON 形式で取得します。

GET /rest/v2/caches/{cacheName}?action=entries

GET /rest/v2/caches/{cacheName}?action=entries

Copy to Clipboard

Toggle word wrap

Expand

表2.8 リクエストパラメーター
パラメーター	必須またはオプション	値
`metadata`	オプション	応答の各エントリーのメタデータが含まれます。デフォルト値は `false` です。
`limit`	オプション	応答に含めるキーの最大数を指定します。負の値はすべてのキーを取得します。デフォルト値は `-1` です。
`batch`	オプション	キーを取得するときの内部バッチサイズを指定します。デフォルト値は `1000` です。

Data Grid は、以下のような JSON レスポンスを提供します。

[
    {
        "key":1,
        "value":"value1",
        "timeToLiveSeconds":-1,
        "maxIdleTimeSeconds":-1,
        "created":-1,
        "lastUsed":-1,
        "expireTime":-1
    },
    {
        "key":2,
        "value":"value2",
        "timeToLiveSeconds":10,
        "maxIdleTimeSeconds":45,
        "created":1607966017944,
        "lastUsed": 1607966017944,
        "expireTime":1607966027944
    }
]

[
    {
        "key":1,
        "value":"value1",
        "timeToLiveSeconds":-1,
        "maxIdleTimeSeconds":-1,
        "created":-1,
        "lastUsed":-1,
        "expireTime":-1
    },
    {
        "key":2,
        "value":"value2",
        "timeToLiveSeconds":10,
        "maxIdleTimeSeconds":45,
        "created":1607966017944,
        "lastUsed": 1607966017944,
        "expireTime":1607966027944
    }
]

Copy to Clipboard

Toggle word wrap

key エントリーのキー。
value エントリーの値。
timeToLiveSeconds エントリーの有効期間に基づきますが、秒単位です。エントリーが期限切れにならない場合は -1 です。metadata = "true"を設定しない限り、返されません。
maxIdleTimeSeconds 最大アイドル時間 (秒単位)。エントリーが期限切れにならない場合は -1。metadata = "true"を設定しない限り、返されません。
作成済みエントリーが created された時刻、または不滅のエントリーの場合は -1。metadata = "true"を設定しない限り、返されません。
lastUsed エントリーに対して操作が行われた最後の時刻、または不滅のエントリーでは -1。metadata = "true"を設定しない限り、返されません。
expireTime エントリーが期限切れになる時間、または不死身のエントリーの場合は -1。metadata = "true"を設定しない限り、返されません。

2.1.15. キャッシュのクリア
リンクのコピー

キャッシュからすべてのデータを削除するには、POST リクエストに ?action=clear パラメーターを付けて実行します。

POST /rest/v2/caches/{cacheName}?action=clear

POST /rest/v2/caches/{cacheName}?action=clear

Copy to Clipboard

Toggle word wrap

操作が正常に完了すると、サービスは 204 (No Content) を返します。

2.1.16. キャッシュサイズの取得
リンクのコピー

GET リクエストと ?action=size パラメーターを使用して、クラスター全体のキャッシュのサイズを取得します。

GET /rest/v2/caches/{cacheName}?action=size

GET /rest/v2/caches/{cacheName}?action=size

Copy to Clipboard

Toggle word wrap

2.1.17. キャッシュ統計の取得
リンクのコピー

GET リクエストを使用してキャッシュの実行時統計を取得します。

GET /rest/v2/caches/{cacheName}?action=stats

GET /rest/v2/caches/{cacheName}?action=stats

Copy to Clipboard

Toggle word wrap

2.1.18. キャッシュのクエリー
リンクのコピー

GET リクエストと ?action=search&query パラメーターを使用して、キャッシュに対して Ickle クエリーを実行します。

GET /rest/v2/caches/{cacheName}?action=search&query={ickle query}

GET /rest/v2/caches/{cacheName}?action=search&query={ickle query}

Copy to Clipboard

Toggle word wrap

Data Grid は、次のようなクエリーヒットで応答します。

{
  "total_results" : 150,
  "hits" : [ {
    "hit" : {
      "name" : "user1",
      "age" : 35
    }
  }, {
    "hit" : {
       "name" : "user2",
       "age" : 42
    }
  }, {
    "hit" : {
       "name" : "user3",
       "age" : 12
    }
  } ]
}

{
  "total_results" : 150,
  "hits" : [ {
    "hit" : {
      "name" : "user1",
      "age" : 35
    }
  }, {
    "hit" : {
       "name" : "user2",
       "age" : 42
    }
  }, {
    "hit" : {
       "name" : "user3",
       "age" : 12
    }
  } ]
}

Copy to Clipboard

Toggle word wrap

total_results は、クエリーの結果の合計数を表示します。
hits は、クエリーからのマッチの配列です。
hit は、クエリーにマッチするオブジェクトです。
ヒント
ヒットにはすべてのフィールドを含めることができますが、Select 句を使用するとフィールドのサブセットを含めることができます。

Expand

表2.9 リクエストパラメーター
パラメーター	必須またはオプション	値
`query`	必須	クエリー文字列を指定します。
`max_results`	オプション	返す結果の数を設定します。デフォルトは `10` です。
`offset`	オプション	返される最初の結果のインデックスを指定します。デフォルトは `0` です。
`query_mode`	オプション	Data Grid サーバーがクエリーを実行する方法を指定します。値は `FETCH` および `BROADCAST` です。デフォルトは `FETCH` です。

クエリーパラメーターを指定せずにリクエストの本文を使用するには、以下のように POST リクエストを呼び出します。

POST /rest/v2/caches/{cacheName}?action=search

POST /rest/v2/caches/{cacheName}?action=search

Copy to Clipboard

Toggle word wrap

次の例は、リクエスト本文のクエリーを示しています。

{
 "query":"from Entity where name:\"user1\"",
 "max_results":20,
 "offset":10
}

{
 "query":"from Entity where name:\"user1\"",
 "max_results":20,
 "offset":10
}

Copy to Clipboard

Toggle word wrap

2.1.19. データのインデックスの再作成
リンクのコピー

POST リクエストと ?action=mass-index&mode={mode} パラメーターを使用して、キャッシュ内のすべてのデータのインデックスを再作成します。

POST  /v2/caches/{cacheName}/search/indexes?action=mass-index&mode={mode}

POST  /v2/caches/{cacheName}/search/indexes?action=mass-index&mode={mode}

Copy to Clipboard

Toggle word wrap

mode パラメーターの値は以下の通りです。

sync は、インデックス再作成の操作が完了した後にのみ、204 (No Content) を返します。
async はすぐに 204 (No Content) を返し、再インデックス化処理はクラスター内で継続して実行されます。Index StatisticsREST コールで状態を確認できます。

2.1.20. インデックスのパージ
リンクのコピー

POST リクエストと ?action=clear パラメーターを使用して、キャッシュからすべてのインデックスを削除します。

POST  /v2/caches/{cacheName}/search/indexes?action=clear

POST  /v2/caches/{cacheName}/search/indexes?action=clear

Copy to Clipboard

Toggle word wrap

操作が正常に完了すると、サービスは 204 (No Content) を返します。

2.1.21. クエリーおよびインデックス統計の取得
リンクのコピー

GET 要求を使用して、キャッシュでクエリーとインデックスに関する情報を取得します。

注記

キャッシュで統計を有効にする必要があります。そうしないと、結果が空になります。

GET /v2/caches/{cacheName}/search/stats

GET /v2/caches/{cacheName}/search/stats

Copy to Clipboard

Toggle word wrap

Expand

表2.10 リクエストパラメーター
パラメーター	必須またはオプション	値
`scope`	オプション	クラスターの全メンバーの連結統計情報を取得するには、`cluster` を使用します。省略すると、Data Grid はローカルのクエリーとインデックスの統計情報を返します。

Data Grid は、以下のような JSON レスポンスを提供します。

{
  "query": {
    "indexed_local": {
      "count": 1,
      "average": 12344.2,
      "max": 122324,
      "slowest": "FROM Entity WHERE field > 4"
    },
    "indexed_distributed": {
      "count": 0,
      "average": 0.0,
      "max": -1,
      "slowest": "FROM Entity WHERE field > 4"
    },
    "hybrid": {
      "count": 0,
      "average": 0.0,
      "max": -1,
      "slowest": "FROM Entity WHERE field > 4 AND desc = 'value'"
    },
    "non_indexed": {
      "count": 0,
      "average": 0.0,
      "max": -1,
      "slowest": "FROM Entity WHERE desc = 'value'"
    },
    "entity_load": {
      "count": 123,
      "average": 10.0,
      "max": 120
    }
  },
  "index": {
    "types": {
      "org.infinispan.same.test.Entity": {
        "count": 5660001,
        "size": 0
      },
      "org.infinispan.same.test.AnotherEntity": {
        "count": 40,
        "size": 345560
      }
    },
    "reindexing": false
  }
}

{
  "query": {
    "indexed_local": {
      "count": 1,
      "average": 12344.2,
      "max": 122324,
      "slowest": "FROM Entity WHERE field > 4"
    },
    "indexed_distributed": {
      "count": 0,
      "average": 0.0,
      "max": -1,
      "slowest": "FROM Entity WHERE field > 4"
    },
    "hybrid": {
      "count": 0,
      "average": 0.0,
      "max": -1,
      "slowest": "FROM Entity WHERE field > 4 AND desc = 'value'"
    },
    "non_indexed": {
      "count": 0,
      "average": 0.0,
      "max": -1,
      "slowest": "FROM Entity WHERE desc = 'value'"
    },
    "entity_load": {
      "count": 123,
      "average": 10.0,
      "max": 120
    }
  },
  "index": {
    "types": {
      "org.infinispan.same.test.Entity": {
        "count": 5660001,
        "size": 0
      },
      "org.infinispan.same.test.AnotherEntity": {
        "count": 40,
        "size": 345560
      }
    },
    "reindexing": false
  }
}

Copy to Clipboard

Toggle word wrap

query のセクション

indexed_local インデックス付きのクエリーの詳細を提供します。
indexed_distributed 分散したインデックス付きクエリーの詳細を提供します。
hybrid インデックスを部分的にしか使用していないクエリーの詳細を提供します。
non_indexed インデックスを使用しなかったクエリーの詳細を提供します。
entity_load インデックス付きクエリーの実行後にオブジェクトをフェッチするためのキャッシュ操作に関する詳細を提供します。

注記

時間関連の統計はすべてナノ秒単位です。

index のセクション

types キャッシュに設定されている各インデックスタイプ (クラス名や protobuf メッセージ) の詳細を提供する。
- count そのタイプにインデックスされているエンティティーの数。
- size 型の使用量 (バイト)。
reindexing 値が true の場合、Indexer はキャッシュで動作しています。

2.1.22. 検索統計の消去
リンクのコピー

POST リクエストと ?action=clear パラメーターを使用して、ランタイムの統計情報をリセットすることができます。

POST /v2/caches/{cacheName}/search/stats?action=clear

POST /v2/caches/{cacheName}/search/stats?action=clear

Copy to Clipboard

Toggle word wrap

インデックス統計はクリアされませんが、クエリーの実行時間のみがクリアされます。Data Grid は、ローカルノードのみのクエリー統計をクリアします。

2.1.23. インデックス統計の取得 (非推奨)
リンクのコピー

GET リクエストでキャッシュ内のインデックスの情報を取得します。

GET /v2/caches/{cacheName}/search/indexes/stats

GET /v2/caches/{cacheName}/search/indexes/stats

Copy to Clipboard

Toggle word wrap

Data Grid は、以下のような JSON レスポンスを提供します。

{
    "indexed_class_names": ["org.infinispan.sample.User"],
    "indexed_entities_count": {
        "org.infinispan.sample.User": 4
    },
    "index_sizes": {
        "cacheName_protobuf": 14551
    },
    "reindexing": false
}

{
    "indexed_class_names": ["org.infinispan.sample.User"],
    "indexed_entities_count": {
        "org.infinispan.sample.User": 4
    },
    "index_sizes": {
        "cacheName_protobuf": 14551
    },
    "reindexing": false
}

Copy to Clipboard

Toggle word wrap

indexed_class_names キャッシュに存在するインデックスのクラス名を提供します。Protobuf の場合、値は常に org.infinispan.query.remote.impl.indexing.ProtobufValueWrapper です。
indexed_entities_count クラスごとにインデックスされているエンティティーの数を提供します。
index_sizes キャッシュ内の各インデックスのサイズをバイト単位で指定します。
reindexing キャッシュに対してインデックス変更操作が行われたかどうかを示す。この値が true の場合、MassIndexer はキャッシュで起動したことになります。

2.1.24. クエリー統計の取得 (非推奨)
リンクのコピー

GET リクエストでキャッシュに実行されたクエリーの情報を取得します。

GET /v2/caches/{cacheName}/search/query/stats

GET /v2/caches/{cacheName}/search/query/stats

Copy to Clipboard

Toggle word wrap

Data Grid は、以下のような JSON レスポンスを提供します。

{
    "search_query_execution_count":20,
    "search_query_total_time":5,
    "search_query_execution_max_time":154,
    "search_query_execution_avg_time":2,
    "object_loading_total_time":1,
    "object_loading_execution_max_time":1,
    "object_loading_execution_avg_time":1,
    "objects_loaded_count":20,
    "search_query_execution_max_time_query_string": "FROM entity"
}

{
    "search_query_execution_count":20,
    "search_query_total_time":5,
    "search_query_execution_max_time":154,
    "search_query_execution_avg_time":2,
    "object_loading_total_time":1,
    "object_loading_execution_max_time":1,
    "object_loading_execution_avg_time":1,
    "objects_loaded_count":20,
    "search_query_execution_max_time_query_string": "FROM entity"
}

Copy to Clipboard

Toggle word wrap

search_query_execution_count 実行されたクエリーの数を提供します。
search_query_total_time クエリーに費やされた総時間を提供します。
search_query_execution_max_time クエリーにかかる最大時間を指定します。
search_query_execution_avg_time クエリーの平均実行時間を提供します。
object_loading_total_time クエリー実行後にキャッシュからオブジェクトをロードするのにかかった時間の合計を提供します。
object_loading_execution_max_time オブジェクトのロード実行にかかる最大時間を提供します。
object_loading_execution_avg_time オブジェクトのロード実行にかかる最大時間を提供します。
objects_loaded_count ロードされたオブジェクトの数を提供します。
search_query_execution_max_time_query_string 実行された最も遅いクエリーを提供します。

2.1.25. クエリー統計情報のクリア (非推奨)
リンクのコピー

POST リクエストと ?action=clear パラメーターを使用して、ランタイムの統計情報をリセットすることができます。

POST /v2/caches/{cacheName}/search/query/stats?action=clear

POST /v2/caches/{cacheName}/search/query/stats?action=clear

Copy to Clipboard

Toggle word wrap

2.1.26. キャッシュの一覧表示
リンクのコピー

GET リクエストを使用して、 Data Grid クラスターで使用可能なすべてのキャッシュを一覧表示します。

GET /rest/v2/caches/

GET /rest/v2/caches/

Copy to Clipboard

Toggle word wrap

2.1.27. キャッシュを利用したクロスサイト・オペレーション
リンクのコピー

Data Grid REST API を使用して、クロスサイトレプリケーション操作を行います。

2.1.27.1. すべてのバックアップロケーションのステータス取得
リンクのコピー

GET リクエストですべてのバックアップロケーションのステータスを取得します。

GET /v2/caches/{cacheName}/x-site/backups/

GET /v2/caches/{cacheName}/x-site/backups/

Copy to Clipboard

Toggle word wrap

Data Grid は、以下の例のように、各バックアップロケーションのステータスを JSON 形式で応答します。

{
  "NYC": "online",
  "LON": "offline"
}

{
  "NYC": "online",
  "LON": "offline"
}

Copy to Clipboard

Toggle word wrap

Expand

表2.11 リターンステータス
値	説明
`online`	ローカルクラスター内のすべてのノードには、バックアップの場所を含むクロスサイトビューがあります。
`offline`	ローカルクラスター内のノードには、バックアップの場所とのクロスサイトビューがありません。
`mixed`	ローカルクラスター内の一部のノードにはバックアップの場所を含むクロスサイトビューがあり、ローカルクラスター内の他のノードにはクロスサイトビューがありません。応答は、各ノードのステータスを示します。

2.1.27.2. 特定のバックアップ場所のステータスの取得
リンクのコピー

GET リクエストでバックアップロケーションのステータスを取得する。

GET /v2/caches/{cacheName}/x-site/backups/{siteName}

GET /v2/caches/{cacheName}/x-site/backups/{siteName}

Copy to Clipboard

Toggle word wrap

Data Grid は、以下の例のように、サイト内の各ノードのステータスを JSON 形式で応答します。

{
  "NodeA":"offline",
  "NodeB":"online"
}

{
  "NodeA":"offline",
  "NodeB":"online"
}

Copy to Clipboard

Toggle word wrap

Expand

表2.12 リターンステータス
値	説明
`online`	ノードはオンラインです。
`offline`	ノードはオフラインです。
`failed`	ステータスを取得できません。リモートキャッシュがシャットダウンしているか、リクエスト中にネットワークエラーが発生した可能性があります。

2.1.27.3. バックアップ先をオフラインにする
リンクのコピー

POST リクエストと ?action=take-offline パラメーターを使用して、バックアップの場所をオフラインにします。

POST /v2/caches/{cacheName}/x-site/backups/{siteName}?action=take-offline

POST /v2/caches/{cacheName}/x-site/backups/{siteName}?action=take-offline

Copy to Clipboard

Toggle word wrap

2.1.27.4. バックアップ場所をオンラインにする
リンクのコピー

?action=bring-online パラメーターを使用してバックアップ場所をオンラインにします。

POST /v2/caches/{cacheName}/x-site/backups/{siteName}?action=bring-online

POST /v2/caches/{cacheName}/x-site/backups/{siteName}?action=bring-online

Copy to Clipboard

Toggle word wrap

2.1.27.5. バックアップ場所への状態のプッシュ
リンクのコピー

?action=start-push-state パラメーターを使用して、キャッシュ状態をバックアップ場所にプッシュします。

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

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

Copy to Clipboard

Toggle word wrap

2.1.27.6. 状態転送のキャンセル
リンクのコピー

?action=cancel-push-state パラメーターを使用して状態転送操作をキャンセルします。

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

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

Copy to Clipboard

Toggle word wrap

2.1.27.7. 状態転送ステータスの取得
リンクのコピー

?action=push-state-status パラメーターを使用して状態転送操作のステータスを取得します。

GET /v2/caches/{cacheName}/x-site/backups?action=push-state-status

GET /v2/caches/{cacheName}/x-site/backups?action=push-state-status

Copy to Clipboard

Toggle word wrap

Data Grid は、以下の例のように、各バックアップ拠点の状態移行の状況を JSON 形式で応答します。

{
   "NYC":"CANCELED",
   "LON":"OK"
}

{
   "NYC":"CANCELED",
   "LON":"OK"
}

Copy to Clipboard

Toggle word wrap

Expand

表2.13 リターンステータス
値	説明
`SENDING`	バックアップ場所への状態転送が進行中です。
`OK`	状態の転送が正常に完了しました。
`ERROR`	状態転送でエラーが発生しました。ログファイルを確認してください。
`CANCELLING`	状態移行のキャンセルが進行中です。

2.1.27.8. 状態転送ステータスのクリア
リンクのコピー

?action=clear-push-state-status パラメーターを使用して送信サイトの状態転送ステータスをクリアします。

POST /v2/caches/{cacheName}/x-site/local?action=clear-push-state-status

POST /v2/caches/{cacheName}/x-site/local?action=clear-push-state-status

Copy to Clipboard

Toggle word wrap

2.1.27.9. オフラインテイク条件の変更
リンクのコピー

特定の条件が満たされると、サイトはオフラインになります。オフラインにするパラメーターを変更して、バックアップロケーションが自動的にオフラインになるタイミングを制御します。

手順

GET リクエストと take-offline-config パラメーターで設定されたテイクオフラインパラメーターを確認します。
```
GET /v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
```
```
GET /v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
```
Copy to Clipboard Toggle word wrap
Data Grid のレスポンスには、以下のように after_failures と min_wait フィールドがあります。
```
{
  "after_failures": 2,
  "min_wait": 1000
}
```
```
{
  "after_failures": 2,
  "min_wait": 1000
}
```
Copy to Clipboard Toggle word wrap
PUT リクエストの本文のオフライン取得パラメーターを変更します。
```
PUT /v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
```
```
PUT /v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
```
Copy to Clipboard Toggle word wrap
操作が正常に完了すると、サービスは 204 (No Content) を返します。

2.1.27.10. 受信サイトからの状態転送のキャンセル
リンクのコピー

2 つのバックアップ場所間の接続が切断された場合、プッシュを受信しているサイトでの状態転送をキャンセルできます。

?action=cancel-receive-state パラメーターで、リモートサイトからの状態転送をキャンセルし、ローカルキャッシュの現在の状態を維持する。

POST /v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-receive-state

POST /v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-receive-state

Copy to Clipboard

Toggle word wrap

2.1.28. ローリングアップグレード
リンクのコピー

Data Grid クラスター間でキャッシュデータのローリングアップグレードを実行します

2.1.28.1. データの同期
リンクのコピー

ソースクラスターからターゲットクラスターへのデータの同期には、POST リクエストと ?action=sync-data パラメーターを使用します。

POST /v2/caches/{cacheName}?action=sync-data

POST /v2/caches/{cacheName}?action=sync-data

Copy to Clipboard

Toggle word wrap

操作が完了すると、Data Grid はターゲットクラスターにコピーされたエントリーの合計数で応答します。

2.1.28.2. ソースクラスターの接続
リンクのコピー

データをターゲットクラスターに同期した後、POST 要求と ?action=disconnect-source パラメーターを使用してソースクラスターから切断します。

POST /v2/caches/{cacheName}?action=disconnect-source

POST /v2/caches/{cacheName}?action=disconnect-source

Copy to Clipboard

Toggle word wrap

操作が正常に完了すると、サービスは 204 (No Content) を返します。

2.1. キャッシュの作成と管理リンクのコピーリンクがクリップボードにコピーされました!

2.1.1. キャッシュの作成リンクのコピーリンクがクリップボードにコピーされました!

2.1.1.1. キャッシュ設定リンクのコピーリンクがクリップボードにコピーされました!

JSON 形式

2.1.2. キャッシュの検証リンクのコピーリンクがクリップボードにコピーされました!

2.1.3. テンプレートを使用したキャッシュの作成リンクのコピーリンクがクリップボードにコピーされました!

2.1.4. キャッシュ設定の取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.5. キャッシュ設定を JSON に変換するリンクのコピーリンクがクリップボードにコピーされました!

2.1.6. すべてのキャッシュの詳細を取得するリンクのコピーリンクがクリップボードにコピーされました!

2.1.7. エントリーの追加リンクのコピーリンクがクリップボードにコピーされました!

2.1.8. エントリーの置き換えリンクのコピーリンクがクリップボードにコピーされました!

2.1.9. キーによるデータの取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.10. エントリーが存在するかどうかの確認リンクのコピーリンクがクリップボードにコピーされました!

2.1.11. エントリーの削除リンクのコピーリンクがクリップボードにコピーされました!

2.1.12. キャッシュの削除リンクのコピーリンクがクリップボードにコピーされました!

2.1.13. キャッシュからのすべてのキーの取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.14. キャッシュからのすべてのエントリーの取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.15. キャッシュのクリアリンクのコピーリンクがクリップボードにコピーされました!

2.1.16. キャッシュサイズの取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.17. キャッシュ統計の取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.18. キャッシュのクエリーリンクのコピーリンクがクリップボードにコピーされました!

2.1.19. データのインデックスの再作成リンクのコピーリンクがクリップボードにコピーされました!

2.1.20. インデックスのパージリンクのコピーリンクがクリップボードにコピーされました!

2.1.21. クエリーおよびインデックス統計の取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.22. 検索統計の消去リンクのコピーリンクがクリップボードにコピーされました!

2.1.23. インデックス統計の取得 (非推奨)リンクのコピーリンクがクリップボードにコピーされました!

2.1.24. クエリー統計の取得 (非推奨)リンクのコピーリンクがクリップボードにコピーされました!

2.1.25. クエリー統計情報のクリア (非推奨)リンクのコピーリンクがクリップボードにコピーされました!

2.1.26. キャッシュの一覧表示リンクのコピーリンクがクリップボードにコピーされました!

2.1.27. キャッシュを利用したクロスサイト・オペレーションリンクのコピーリンクがクリップボードにコピーされました!

2.1.27.1. すべてのバックアップロケーションのステータス取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.27.2. 特定のバックアップ場所のステータスの取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.27.3. バックアップ先をオフラインにするリンクのコピーリンクがクリップボードにコピーされました!

2.1.27.4. バックアップ場所をオンラインにするリンクのコピーリンクがクリップボードにコピーされました!

2.1.27.5. バックアップ場所への状態のプッシュリンクのコピーリンクがクリップボードにコピーされました!

2.1.27.6. 状態転送のキャンセルリンクのコピーリンクがクリップボードにコピーされました!

2.1.27.7. 状態転送ステータスの取得リンクのコピーリンクがクリップボードにコピーされました!

2.1.27.8. 状態転送ステータスのクリアリンクのコピーリンクがクリップボードにコピーされました!

2.1.27.9. オフラインテイク条件の変更リンクのコピーリンクがクリップボードにコピーされました!

2.1.27.10. 受信サイトからの状態転送のキャンセルリンクのコピーリンクがクリップボードにコピーされました!

2.1.28. ローリングアップグレードリンクのコピーリンクがクリップボードにコピーされました!

2.1.28.1. データの同期リンクのコピーリンクがクリップボードにコピーされました!

2.1.28.2. ソースクラスターの接続リンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

2.1. キャッシュの作成と管理
リンクのコピー

2.1.1. キャッシュの作成
リンクのコピー

2.1.1.1. キャッシュ設定
リンクのコピー

2.1.2. キャッシュの検証
リンクのコピー

2.1.3. テンプレートを使用したキャッシュの作成
リンクのコピー

2.1.4. キャッシュ設定の取得
リンクのコピー

2.1.5. キャッシュ設定を JSON に変換する
リンクのコピー

2.1.6. すべてのキャッシュの詳細を取得する
リンクのコピー

2.1.7. エントリーの追加
リンクのコピー

2.1.8. エントリーの置き換え
リンクのコピー

2.1.9. キーによるデータの取得
リンクのコピー

2.1.10. エントリーが存在するかどうかの確認
リンクのコピー

2.1.11. エントリーの削除
リンクのコピー

2.1.12. キャッシュの削除
リンクのコピー

2.1.13. キャッシュからのすべてのキーの取得
リンクのコピー

2.1.14. キャッシュからのすべてのエントリーの取得
リンクのコピー

2.1.15. キャッシュのクリア
リンクのコピー

2.1.16. キャッシュサイズの取得
リンクのコピー

2.1.17. キャッシュ統計の取得
リンクのコピー

2.1.18. キャッシュのクエリー
リンクのコピー

2.1.19. データのインデックスの再作成
リンクのコピー

2.1.20. インデックスのパージ
リンクのコピー

2.1.21. クエリーおよびインデックス統計の取得
リンクのコピー

2.1.22. 検索統計の消去
リンクのコピー

2.1.23. インデックス統計の取得 (非推奨)
リンクのコピー

2.1.24. クエリー統計の取得 (非推奨)
リンクのコピー

2.1.25. クエリー統計情報のクリア (非推奨)
リンクのコピー

2.1.26. キャッシュの一覧表示
リンクのコピー

2.1.27. キャッシュを利用したクロスサイト・オペレーション
リンクのコピー

2.1.27.1. すべてのバックアップロケーションのステータス取得
リンクのコピー

2.1.27.2. 特定のバックアップ場所のステータスの取得
リンクのコピー

2.1.27.3. バックアップ先をオフラインにする
リンクのコピー

2.1.27.4. バックアップ場所をオンラインにする
リンクのコピー

2.1.27.5. バックアップ場所への状態のプッシュ
リンクのコピー

2.1.27.6. 状態転送のキャンセル
リンクのコピー

2.1.27.7. 状態転送ステータスの取得
リンクのコピー

2.1.27.8. 状態転送ステータスのクリア
リンクのコピー

2.1.27.9. オフラインテイク条件の変更
リンクのコピー

2.1.27.10. 受信サイトからの状態転送のキャンセル
リンクのコピー

2.1.28. ローリングアップグレード
リンクのコピー

2.1.28.1. データの同期
リンクのコピー

2.1.28.2. ソースクラスターの接続
リンクのコピー