Data Grid REST API

Red Hat Data Grid 8.2

Data Grid RESTAPI を設定して操作する

Red Hat Customer Content Services

法律上の通知

概要

データへのアクセス、クラスターの監視と保守、Data Grid RESTAPI を介した管理操作の実行。

Red Hat Data Grid
リンクのコピー

Data Grid は、高性能の分散型インメモリーデータストアです。

スキーマレスデータ構造: さまざまなオブジェクトをキーと値のペアとして格納する柔軟性があります。
グリッドベースのデータストレージ: クラスター間でデータを分散および複製するように設計されています。
エラスティックスケーリング: サービスを中断することなく、ノードの数を動的に調整して要件を満たします。
データの相互運用性: さまざまなエンドポイントからグリッド内のデータを保存、取得、およびクエリーします。

Data Grid のドキュメント
リンクのコピー

Data Grid のドキュメントは、Red Hat カスタマーポータルで入手できます。

Data Grid のダウンロード
リンクのコピー

Red Hat カスタマーポータルで Data Grid Software Downloads にアクセスします。

注記

Data Grid ソフトウェアにアクセスしてダウンロードするには、Red Hat アカウントが必要です。

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージをご覧ください。

第1章 Data Grid REST エンドポイント
リンクのコピー

Data Grid サーバーは、Netty 上に構築された REST エンドポイントを介してデータへの RESTful HTTP アクセスを提供します。

1.1. REST 認証
リンクのコピー

Data Grid コマンドラインインターフェイス (CLI) とuserコマンドを使用して、REST エンドポイントへの認証を設定します。CLI を使用すると、REST エンドポイントにアクセスするためのユーザー、パスワード、および承認ロールを作成および管理できます。

参照資料

1.2. サポートされているプロトコル
リンクのコピー

Data Grid REST エンドポイントは、HTTP/1.1 および HTTP/2 のプロトコルをサポートしています。

HTTP/2 を使用するには、以下のいずれかの方法があります。

HTTP /1.1 アップグレードを実行します。
TLS/ALPN 拡張を使用して通信プロトコルを交渉する。

注記

JDK8 を使用する TLS / ALPN には、追加のクライアント設定が必要です。REST クライアントの適切なドキュメントを参照してください。ほとんどの場合、Jetty ALPNAgent または OpenSSL バインディングのいずれかを使用する必要があります。

1.3. データ形式と RESTAPI
リンクのコピー

Data Grid キャッシュは、MediaType で定義できる形式でデータを保存します。

MediaTypes と Data Grid を使用したデータのエンコードの詳細については、キャッシュのエンコードとマーシャリングを参照してください。

次の例では、エントリーのストレージ形式を設定します。

<distributed-cache name="mycache">
   <encoding>
      <key media-type="application/x-java-object"/>
      <value media-type="application/xml; charset=UTF-8"/>
   </encoding>
</distributed-cache>

<distributed-cache name="mycache">
   <encoding>
      <key media-type="application/x-java-object"/>
      <value media-type="application/xml; charset=UTF-8"/>
   </encoding>
</distributed-cache>

Copy to Clipboard

Toggle word wrap

MediaType を設定しない場合、DataGrid はデフォルトでキーと値の両方に対して application/octet-stream になります。しかし、キャッシュがインデックス化されている場合、Data Grid のデフォルトは application/x-protostream です。

1.3.1. サポート対象の形式
リンクのコピー

さまざまな形式でデータの書き込みと読み取りを行うことができ、DataGrid は必要に応じてそれらの形式間で変換できます。

次の標準フォーマットは交換可能です。

application/x-java-object
application/octet-stream
application/x-www-form-urlencoded
text/plain

上記のデータ形式を次の形式に変換することもできます。

application/xml
application/json
application/x-jboss-marshalling
application/x-protostream
application/x-java-serialized

Data Grid では、application/x-protostream と application/json の間で変換することもできます。

REST API へのすべての呼び出しは、書き込まれたコンテンツまたは読み取るときに必要なコンテンツの形式を説明するヘッダーを提供できます。Data Grid は、値に適用される標準的な HTTP/1.1 ヘッダーの "Content-Type "と "Accept "に加えて、キーに同様の効果を持つ "Key-Content-Type "をサポートしています。

1.3.2. ヘッダーを受け入れる
リンクのコピー

Data Grid REST エンドポイントは RFC-2616 Accept ヘッダーに準拠しており、サポートされている変換に基づいて正しい MediaType をネゴシエートします。

例えば、データ読み込み時に次のようなヘッダーを送信します。

Accept: text/plain;q=0.7, application/json;q=0.8, */*;q=0.6

Accept: text/plain;q=0.7, application/json;q=0.8, */*;q=0.6

Copy to Clipboard

Toggle word wrap

上記のヘッダーにより、Data Grid は最初にコンテンツを JSON 形式 (優先度 0.8) で返します。保存形式を JSON に変換できない場合、Data Grid は次の形式である text/plain を試みます (2 番目に高い優先度 0.7)。最後に、Data Grid は*/*にフォールバックし、キャッシュの設定に基づいて適切なフォーマットを選択します。

1.3.3. 特殊文字を含む名前
リンクのコピー

REST リソースの作成には、URL の一部となる名前が必要です。この名前に RFC 3986 仕様のセクション 2.2 で定義されている特殊文字が含まれている場合には、Percent encoding メカニズムでエンコードする必要があります。

1.3.4. Key-Content-Type ヘッダー
リンクのコピー

ほとんどの REST API コールでは、URL に Key が含まれています。Data Grid は、これらの呼び出しを処理する際に、Key がjava.lang.Stringであることを前提としていますが、異なるフォーマットのキーに対しては、特定のヘッダーKey-Content-Typeを使用することができます。

Key-Content-Type ヘッダーの例

byte[] Key を Base64 文字列で指定する

API 呼び出し:

`PUT /my-cache/AQIDBDM=`

`PUT /my-cache/AQIDBDM=`

Copy to Clipboard

Toggle word wrap

ヘッダー:

Key-Content-Type: application/octet-stream

byte[] Key を 16 進数の文字列で指定する。

API 呼び出し:

GET /my-cache/0x01CA03042F

ヘッダー:

Key-Content-Type: application/octet-stream; encoding=hex

Key-Content-Type: application/octet-stream; encoding=hex

Copy to Clipboard

Toggle word wrap

ダブルキーの指定:

API 呼び出し:

POST /my-cache/3.141456

ヘッダー:

Key-Content-Type: application/x-java-object;type=java.lang.Double

Key-Content-Type: application/x-java-object;type=java.lang.Double

Copy to Clipboard

Toggle word wrap

application / x-java-object の type パラメーターは次のように制限されています。

Primitive wrapper types
java.lang.String
バイトで、application/x-java-object;type=Bytes が application/octet-stream;encoding=hex と同等になります。

1.3.5. JSON /プロトストリーム変換
リンクのコピー

キャッシュがインデックス化されている場合や、_application/x-protostream`を保存するように特別に設定されている場合、Protobuf との間で自動的に変換された JSON ドキュメントを送受信することができます。

変換を機能させるには、Protobuf スキーマを登録する必要があります。

REST 経由で protobuf スキーマを登録するには、次の例のように、POST または PUT を起動して ___protobuf_metadata キャッシュを起動します。

curl -u user:password -X POST --data-binary @./schema.proto http://127.0.0.1:11222/rest/v2/caches/___protobuf_metadata/schema.proto

curl -u user:password -X POST --data-binary @./schema.proto http://127.0.0.1:11222/rest/v2/caches/___protobuf_metadata/schema.proto

Copy to Clipboard

Toggle word wrap

JSON ドキュメントを記述する際には、ドキュメントに対応する Protobuf Message を識別するための特別なフィールド _type は、ドキュメントに対応する Protobuf Messageを識別するために、ドキュメント内に存在する必要があります。

Person.proto

message Person  {
  required string name = 1;
  required int32 age = 2;
}

message Person  {
  required string name = 1;
  required int32 age = 2;
}

Copy to Clipboard

Toggle word wrap

Person.json

{
   "_type": "Person",
   "name": "user1",
   "age": 32
}

{
   "_type": "Person",
   "name": "user1",
   "age": 32
}

Copy to Clipboard

Toggle word wrap

1.4. クロスオリジンリソースシェアリング (CORS) リクエスト
リンクのコピー

Data Grid REST コネクターは、プリフライトやリクエストの発信元に基づくルールなど、 CORS をサポートします。

以下に、CORS ルールを使用した REST コネクター設定の例を示します。

<rest-connector name="rest1" socket-binding="rest" cache-container="default">
   <cors-rules>
      <cors-rule name="restrict host1"
                 allow-credentials="false">
         <allowed-origins>http://host1,https://host1</allowed-origins>
         <allowed-methods>GET</allowed-methods>
      </cors-rule>
      <cors-rule name="allow ALL"
                 allow-credentials="true"
                 max-age-seconds="2000">
         <allowed-origins>*</allowed-origins>
         <allowed-methods>GET,OPTIONS,POST,PUT,DELETE</allowed-methods>
         <allowed-headers>Key-Content-Type</allowed-headers>
      </cors-rule>
   </cors-rules>
</rest-connector>

<rest-connector name="rest1" socket-binding="rest" cache-container="default">
   <cors-rules>
      <cors-rule name="restrict host1"
                 allow-credentials="false">
         <allowed-origins>http://host1,https://host1</allowed-origins>
         <allowed-methods>GET</allowed-methods>
      </cors-rule>
      <cors-rule name="allow ALL"
                 allow-credentials="true"
                 max-age-seconds="2000">
         <allowed-origins>*</allowed-origins>
         <allowed-methods>GET,OPTIONS,POST,PUT,DELETE</allowed-methods>
         <allowed-headers>Key-Content-Type</allowed-headers>
      </cors-rule>
   </cors-rules>
</rest-connector>

Copy to Clipboard

Toggle word wrap

Data Grid は、ブラウザーが設定した "Origin "ヘッダに基づいて CORS ルールを順次評価します。

前述の例では、オリジンが http://host1 または https://host1 のいずれかであれば、ルール restrict host1 が適用されます。オリジンが異なる場合は、次のルールがテストされます。

"allow ALL"ルールはすべてのオリジンを許可するため、"http://host1" または"https://host1" 以外のオリジンを持つスクリプトは、許可されたメソッドを実行し、提供されたヘッダーを使用することができます。

CORS ルールの設定については、Data Grid サーバー設定スキーマを参照してください。

1.4.1. 一部のオリジンに対してすべての CORS パーミッションを許可する
リンクのコピー

VM プロパティーの infinispan.server.rest.cors-allow は、サーバーの起動時に使用して、1 つまたは複数のオリジンにすべてのパーミッションを許可することができます。以下に例を示します。

./bin/server.sh -Dinfinispan.server.rest.cors-allow=http://192.168.1.78:11222,http://host.mydomain.com

./bin/server.sh -Dinfinispan.server.rest.cors-allow=http://192.168.1.78:11222,http://host.mydomain.com

Copy to Clipboard

Toggle word wrap

この方法を使用して指定されたすべてのオリジンは、設定されたルールよりも優先されます。

第2章 Data Grid REST API との連携
リンクのコピー

Data Grid REST API は、Data Grid の展開を監視、維持、管理し、データへのアクセスを提供します。

注記

デフォルトでは、Data Grid REST API の操作は、成功すると 200 (OK) を返します。ただし、一部の操作が正常に処理されると、 200 ではなく 204 や 202 などの HTTP ステータスコードが返されます。

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

Data Grid のキャッシュを作成・管理し、データに対する操作を行うことができます。

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.2. カウンターの作成と管理
リンクのコピー

REST API を使用してカウンターの作成、削除、修正ができます。

2.2.1. カウンターの作成
リンクのコピー

ペイロードに設定が含まれる POST リクエストでカウンターを作成します。

POST /rest/v2/counters/{counterName}

POST /rest/v2/counters/{counterName}

Copy to Clipboard

Toggle word wrap

弱いカウンターの例

{
    "weak-counter":{
        "initial-value":5,
        "storage":"PERSISTENT",
        "concurrency-level":1
    }
}

{
    "weak-counter":{
        "initial-value":5,
        "storage":"PERSISTENT",
        "concurrency-level":1
    }
}

Copy to Clipboard

Toggle word wrap

強力なカウンターの例

{
    "strong-counter":{
        "initial-value":3,
        "storage":"PERSISTENT",
        "upper-bound":5
    }
}

{
    "strong-counter":{
        "initial-value":3,
        "storage":"PERSISTENT",
        "upper-bound":5
    }
}

Copy to Clipboard

Toggle word wrap

2.2.2. カウンターの削除
リンクのコピー

DELETE リクエストで特定のカウンターを削除します。

DELETE /rest/v2/counters/{counterName}

DELETE /rest/v2/counters/{counterName}

Copy to Clipboard

Toggle word wrap

2.2.3. カウンター設定の取得
リンクのコピー

GET リクエストで特定のカウンターの設定を取得します。

GET /rest/v2/counters/{counterName}/config

GET /rest/v2/counters/{counterName}/config

Copy to Clipboard

Toggle word wrap

Data Grid は、JSON 形式でカウンターの設定を応答します。

2.2.4. カウンター値の取得
リンクのコピー

GET リクエストでカウンターの値を取得します。

GET /rest/v2/counters/{counterName}

GET /rest/v2/counters/{counterName}

Copy to Clipboard

Toggle word wrap

Expand

表2.14 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Accept`	オプション	コンテンツを返すために必要なフォーマットです。対応フォーマットは、application/jsonとtext/plainです。ヘッダーが指定されていない場合、JSON が想定されます。

2.2.5. カウンターのリセット
リンクのコピー

POST リクエストと ?action=reset パラメーターを使用せずに、カウンターの初期値を復元することができます。

POST /rest/v2/counters/{counterName}?action=reset

POST /rest/v2/counters/{counterName}?action=reset

Copy to Clipboard

Toggle word wrap

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

2.2.6. カウンターのインクリメント
リンクのコピー

POST リクエストに ?action=increment パラメーターを指定して、カウンターの値を増加させます。

POST /rest/v2/counters/{counterName}?action=increment

POST /rest/v2/counters/{counterName}?action=increment

Copy to Clipboard

Toggle word wrap

注記

WEAK カウンターは操作後に応答せず、204 (No Content) を返します。

STRONG カウンターは、各操作後に 200 (OK) と現在値を返します。

2.2.7. カウンターへのデルタの追加
リンクのコピー

?action=add および delta パラメーターを含む POST リクエストで、カウンターに任意の値を追加します。

POST /rest/v2/counters/{counterName}?action=add&delta={delta}

POST /rest/v2/counters/{counterName}?action=add&delta={delta}

Copy to Clipboard

Toggle word wrap

注記

WEAK カウンターは操作後に応答せず、204 (No Content) を返します。

STRONG カウンターは、各操作後に 200 (OK) と現在値を返します。

2.2.8. カウンター値のデクリメント
リンクのコピー

カウンターの値を減少させるには、POST リクエストと ?action=decrement パラメーターを使用します。

POST /rest/v2/counters/{counterName}?action=decrement

POST /rest/v2/counters/{counterName}?action=decrement

Copy to Clipboard

Toggle word wrap

注記

WEAK カウンターは操作後に応答せず、204 (No Content) を返します。

STRONG カウンターは、各操作後に 200 (OK) と現在値を返します。

2.2.9. ストロングカウンターでの compareAndSet オペレーションの実行
リンクのコピー

GET リクエストと compareAndSet パラメーターを使用して、強力なカウンターの値をアトミックに設定します。

POST /rest/v2/counters/{counterName}?action=compareAndSet&expect={expect}&update={update}

POST /rest/v2/counters/{counterName}?action=compareAndSet&expect={expect}&update={update}

Copy to Clipboard

Toggle word wrap

Data Grid は、現在の値が {expect} の場合、{update} にアトミックに値を設定します。操作が成功した場合、Data Grid は true.

2.2.10. 強力なカウンターでの compareAndSwap 操作の実行
リンクのコピー

GET リクエストと compareAndSwap パラメーターで強力なカウンターの値をアトミックに設定します。

POST /rest/v2/counters/{counterName}?action=compareAndSwap&expect={expect}&update={update}

POST /rest/v2/counters/{counterName}?action=compareAndSwap&expect={expect}&update={update}

Copy to Clipboard

Toggle word wrap

Data Grid は、現在の値が {expect} の場合、{update} にアトミックに値を設定します。操作が成功すると、 Data Grid はペイロードの前の値を返します。

2.2.11. カウンターの一覧表示
リンクのコピー

GET リクエストで Data Grid クラスターのカウンターのリストを取得します。

GET /rest/v2/counters/

GET /rest/v2/counters/

Copy to Clipboard

Toggle word wrap

2.3. Protobuf スキーマの操作
リンクのコピー

Data Grid REST API を利用して、Protobuf スキーマ .proto を作成・管理することができます。

2.3.1. Protobuf スキーマの作成
リンクのコピー

ペイロードに protobuf ファイルのコンテンツを含む POST リクエストで、Data Grid クラスター全体に Protobuf スキーマを作成します。

POST /rest/v2/schemas/{schemaName}

POST /rest/v2/schemas/{schemaName}

Copy to Clipboard

Toggle word wrap

スキーマが既に存在する場合、Data Grid は HTTP409 (Conflict) を返します。構文エラーのため、またはその依存関係の一部が欠落しているためにスキーマが有効でない場合、Data Grid はスキーマを格納し、応答本文にエラーを返します。

Data Grid は、スキーマ名とエラーで応答します。

{
  "name" : "users.proto",
  "error" : {
    "message": "Schema users.proto has errors",
    "cause": "java.lang.IllegalStateException:Syntax error in error.proto at 3:8: unexpected label: messoge"
  }
}

{
  "name" : "users.proto",
  "error" : {
    "message": "Schema users.proto has errors",
    "cause": "java.lang.IllegalStateException:Syntax error in error.proto at 3:8: unexpected label: messoge"
  }
}

Copy to Clipboard

Toggle word wrap

name は Protobuf スキーマの名前です。
error は、有効な Protobuf スキーマでは null です。Data Grid がスキーマを正常に検証できない場合、エラーを返します。

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

2.3.2. Protobuf スキーマの読み取り
リンクのコピー

GET リクエストで Data Grid から Protobuf スキーマを取得します。

GET /rest/v2/schemas/{schemaName}

GET /rest/v2/schemas/{schemaName}

Copy to Clipboard

Toggle word wrap

2.3.3. Protobuf スキーマの更新
リンクのコピー

ペイロードに protobuf ファイルのコンテンツを含む PUT リクエストで Protobuf スキーマを変更する。

PUT /rest/v2/schemas/{schemaName}

PUT /rest/v2/schemas/{schemaName}

Copy to Clipboard

Toggle word wrap

構文エラーのため、またはその依存関係の一部が欠落しているためにスキーマが有効でない場合、Data Grid はスキーマを更新し、応答本文にエラーを返します。

{
  "name" : "users.proto",
  "error" : {
    "message": "Schema users.proto has errors",
    "cause": "java.lang.IllegalStateException:Syntax error in error.proto at 3:8: unexpected label: messoge"
  }
}

{
  "name" : "users.proto",
  "error" : {
    "message": "Schema users.proto has errors",
    "cause": "java.lang.IllegalStateException:Syntax error in error.proto at 3:8: unexpected label: messoge"
  }
}

Copy to Clipboard

Toggle word wrap

name は Protobuf スキーマの名前です。
error は、有効な Protobuf スキーマでは null です。Data Grid がスキーマを正常に検証できない場合、エラーを返します。

2.3.4. Protobuf スキーマの削除
リンクのコピー

DELETE リクエストで Data Grid クラスターから Protobuf スキーマを削除します。

DELETE /rest/v2/schemas/{schemaName}

DELETE /rest/v2/schemas/{schemaName}

Copy to Clipboard

Toggle word wrap

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

2.3.5. Protobuf スキーマの一覧表示
リンクのコピー

GET リクエストで利用可能なすべての Protobuf スキーマをリストアップします。

GET /rest/v2/schemas/

GET /rest/v2/schemas/

Copy to Clipboard

Toggle word wrap

Data Grid は、クラスターで使用可能なすべてのスキーマのリストで応答します。

[ {
  "name" : "users.proto",
  "error" : {
    "message": "Schema users.proto has errors",
    "cause": "java.lang.IllegalStateException:Syntax error in error.proto at 3:8: unexpected label: messoge"
  }
}, {
  "name" : "people.proto",
  "error" : null
}]

[ {
  "name" : "users.proto",
  "error" : {
    "message": "Schema users.proto has errors",
    "cause": "java.lang.IllegalStateException:Syntax error in error.proto at 3:8: unexpected label: messoge"
  }
}, {
  "name" : "people.proto",
  "error" : null
}]

Copy to Clipboard

Toggle word wrap

name は Protobuf スキーマの名前です。
error は、有効な Protobuf スキーマでは null です。Data Grid がスキーマを正常に検証できない場合、エラーを返します。

2.4. キャッシュマネージャーの操作
リンクのコピー

Data Grid キャッシュマネージャーと対話して、クラスターと使用状況の統計を取得します。

2.4.1. 基本的なキャッシュマネージャー情報の取得
リンクのコピー

GET リクエストで Cache Manager の情報を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}

GET /rest/v2/cache-managers/{cacheManagerName}

Copy to Clipboard

Toggle word wrap

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",
    "sites_view": [
        "LON",
        "NYC"
    ]
}

{
    "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",
    "sites_view": [
        "LON",
        "NYC"
    ]
}

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

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"
        }
    ]

}

{
    "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"
        }
    ]

}

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

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

2.4.5. キャッシュマネージャーのグローバル設定の取得
リンクのコピー

GET 要求を使用してキャッシュマネージャーのグローバル設定を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/config

GET /rest/v2/cache-managers/{cacheManagerName}/config

Copy to Clipboard

Toggle word wrap

Expand

表2.15 ヘッダー
ヘッダー	必須またはオプション	パラメーター
`Accept`	オプション	コンテンツを返すために必要なフォーマットです。対応フォーマットは、application/jsonとapplication/xmlです。ヘッダーが指定されていない場合、JSON が想定されます。

参照資料

GlobalConfiguration

2.4.6. すべてのキャッシュの設定を取得する
リンクのコピー

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

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs

Copy to Clipboard

Toggle word wrap

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"
              }
          }
      }
  }
]

[
  {
      "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"
              }
          }
      }
  }
]

Copy to Clipboard

Toggle word wrap

2.4.7. 利用可能なキャッシュテンプレートの一覧表示
リンクのコピー

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

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs/templates

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs/templates

Copy to Clipboard

Toggle word wrap

ヒント

テンプレートを使用したキャッシュの作成を参照してください。

2.4.8. (実験的) キャッシュのステータスと情報の取得
リンクのコピー

Cache Manager で利用可能なすべてのキャッシュのリストを、キャッシュ・ステータスおよび詳細とともに、GET 要求で取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/caches

GET /rest/v2/cache-managers/{cacheManagerName}/caches

Copy to Clipboard

Toggle word wrap

Data Grid は、次の例のように、使用可能な各キャッシュを一覧表示して説明する JSON 配列で応答します。

[ {
  "status" : "RUNNING",
  "name" : "cache1",
  "type" : "local-cache",
  "simple_cache" : false,
  "transactional" : false,
  "persistent" : false,
  "bounded": false,
  "secured": false,
  "indexed": true,
  "has_remote_backup": true,
  "health":"HEALTHY"
}, {
  "status" : "RUNNING",
  "name" : "cache2",
  "type" : "distributed-cache",
  "simple_cache" : false,
  "transactional" : true,
  "persistent" : false,
  "bounded": false,
  "secured": false,
  "indexed": true,
  "has_remote_backup": true,
  "health":"HEALTHY"
}]

[ {
  "status" : "RUNNING",
  "name" : "cache1",
  "type" : "local-cache",
  "simple_cache" : false,
  "transactional" : false,
  "persistent" : false,
  "bounded": false,
  "secured": false,
  "indexed": true,
  "has_remote_backup": true,
  "health":"HEALTHY"
}, {
  "status" : "RUNNING",
  "name" : "cache2",
  "type" : "distributed-cache",
  "simple_cache" : false,
  "transactional" : true,
  "persistent" : false,
  "bounded": false,
  "secured": false,
  "indexed": true,
  "has_remote_backup": true,
  "health":"HEALTHY"
}]

Copy to Clipboard

Toggle word wrap

2.4.9. キャッシュマネージャー統計の取得
リンクのコピー

GET リクエストを使用してキャッシュマネージャーの統計を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/stats

GET /rest/v2/cache-managers/{cacheManagerName}/stats

Copy to Clipboard

Toggle word wrap

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

{
    "statistics_enabled":true,
    "read_write_ratio":0.0,
    "time_since_start":1,
    "time_since_reset":1,
    "number_of_entries":0,
    "total_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
}

{
    "statistics_enabled":true,
    "read_write_ratio":0.0,
    "time_since_start":1,
    "time_since_reset":1,
    "number_of_entries":0,
    "total_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
}

Copy to Clipboard

Toggle word wrap

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}

Copy to Clipboard

Toggle word wrap

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

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

Expand

表2.16 JSON パラメーター
キー	必須またはオプション	値
`directory`	オプション	バックアップアーカイブを作成および保存するサーバー上の場所を指定します。
`resources`	オプション	バックアップするリソースを JSON 形式で指定します。デフォルトでは、すべてのリソースがバックアップされます。1 つまたは複数のリソースを指定した場合、Data Grid はそれらのリソースのみをバックアップします。詳細については、リソースパラメーターの表を参照してください。

Expand

表2.17 リソースパラメーター
キー	必須またはオプション	値
`caches`	オプション	バックアップするキャッシュ名の配列を指定するか、すべてのキャッシュを対象とする `*` を指定します。
`cache-configs`	オプション	バックアップするキャッシュテンプレートの配列、またはすべてのテンプレートの `*` を指定します。
`counters`	オプション	バックアップするカウンター名の配列、またはすべてのカウンターの `*` を定義します。
`proto-schemas`	オプション	バックアップする Protobuf スキーマ名の配列、またはすべてのスキーマの `*` を定義します。
`tasks`	オプション	バックアップするサーバータスクの配列、またはすべてのタスクの `*` を指定します。

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

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

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

Copy to Clipboard

Toggle word wrap

2.4.11. バックアップの一覧表示
リンクのコピー

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

GET /rest/v2/cache-managers/{cacheManagerName}/backups

GET /rest/v2/cache-managers/{cacheManagerName}/backups

Copy to Clipboard

Toggle word wrap

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

["backup1", "backup2"]

["backup1", "backup2"]

Copy to Clipboard

Toggle word wrap

2.4.12. バックアップの可用性の確認
リンクのコピー

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

HEAD /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}

HEAD /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}

Copy to Clipboard

Toggle word wrap

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

2.4.13. バックアップアーカイブのダウンロード
リンクのコピー

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

GET /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}

GET /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}

Copy to Clipboard

Toggle word wrap

2.4.14. バックアップアーカイブの削除
リンクのコピー

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

DELETE /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}

DELETE /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}

Copy to Clipboard

Toggle word wrap

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}

Copy to Clipboard

Toggle word wrap

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

2.4.15.1. Data Grid サーバー上のバックアップアーカイブからの復元
リンクのコピー

サーバー上のアーカイブからバックアップする場合は、POST リクエストに application/json コンテンツタイプを使用します。

Expand

表2.18 JSON パラメーター
キー	必須またはオプション	値
`location`	必須	復元するバックアップアーカイブのパスを指定します。
`resources`	オプション	復元するリソースを JSON 形式で指定します。デフォルトでは、すべてのリソースを復元します。1 つまたは複数のリソースを指定した場合、Data Grid はそれらのリソースのみをリストアします。詳細については、リソースパラメーターの表を参照してください。

Expand

表2.19 リソースパラメーター
キー	必須またはオプション	値
`caches`	オプション	バックアップするキャッシュ名の配列を指定するか、すべてのキャッシュを対象とする `*` を指定します。
`cache-configs`	オプション	バックアップするキャッシュテンプレートの配列、またはすべてのテンプレートの `*` を指定します。
`counters`	オプション	バックアップするカウンター名の配列、またはすべてのカウンターの `*` を定義します。
`proto-schemas`	オプション	バックアップする Protobuf スキーマ名の配列、またはすべてのスキーマの `*` を定義します。
`tasks`	オプション	バックアップするサーバータスクの配列、またはすべてのタスクの `*` を指定します。

次の例では、サーバー上のバックアップアーカイブからすべてのカウンターを復元します。

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

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

Copy to Clipboard

Toggle word wrap

2.4.15.2. ローカルバックアップアーカイブからの復元
リンクのコピー

ローカルのバックアップアーカイブをサーバーにアップロードするには、POST リクエストに multipart/form-data コンテンツタイプを使用します。

Expand

表2.20 フォームデータ
パラメーター	Content-Type	必須またはオプション	値
`backup`	`application/zip`	必須	復元するバックアップアーカイブのバイトを指定します。
`resources`	`application/json`, `text/plain`	オプション	リクエストパラメーターの JSON オブジェクトを定義します。

要求の例

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--

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--

Copy to Clipboard

Toggle word wrap

2.4.16. リストの復元
リンクのコピー

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

GET /rest/v2/cache-managers/{cacheManagerName}/restores

GET /rest/v2/cache-managers/{cacheManagerName}/restores

Copy to Clipboard

Toggle word wrap

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

["restore1", "restore2"]

["restore1", "restore2"]

Copy to Clipboard

Toggle word wrap

2.4.17. 復元の進行状況を確認する
リンクのコピー

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

HEAD /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}

HEAD /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}

Copy to Clipboard

Toggle word wrap

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

2.4.18. 復元メタデータの削除
リンクのコピー

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

DELETE /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}

DELETE /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}

Copy to Clipboard

Toggle word wrap

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/

Copy to Clipboard

Toggle word wrap

Data Grid は、以下の例のように JSON 形式でステータスを応答します。

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

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

Copy to Clipboard

Toggle word wrap

Expand

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

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

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

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}

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

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

Copy to Clipboard

Toggle word wrap

2.5. Data Grid サーバーの操作
リンクのコピー

Data Grid サーバーインスタンスを監視および管理します。

2.5.1. 基本的なサーバー情報の取得
リンクのコピー

GET リクエストを使用して Data Grid サーバーに関する基本情報を表示します。

GET /rest/v2/server

GET /rest/v2/server

Copy to Clipboard

Toggle word wrap

Data Grid は、次の例のように、サーバー名、コードネーム、およびバージョンを JSON 形式で応答します。

{
  "version":"Infinispan 'Codename' xx.x.x.Final"
}

{
  "version":"Infinispan 'Codename' xx.x.x.Final"
}

Copy to Clipboard

Toggle word wrap

2.5.2. キャッシュマネージャーの取得
リンクのコピー

GET リクエストで Data Grid サーバーのキャッシュマネージャーのリストを取得します。

GET /rest/v2/server/cache-managers

GET /rest/v2/server/cache-managers

Copy to Clipboard

Toggle word wrap

Data Grid は、サーバー用に設定されたキャッシュマネージャー名の配列で応答します。

注記

Data Grid は現在、サーバーごとに 1 つのキャッシュマネージャーのみをサポートしています。

2.5.3. 無視リストへのキャッシュの追加
リンクのコピー

特定のキャッシュをクライアントの要求から一時的に除外するように Data Grid を設定します。キャッシュマネージャー名とキャッシュの名前を含む POST リクエストを送信します。

POST /v2/server/ignored-caches/{cache-manager}/{cache}

POST /v2/server/ignored-caches/{cache-manager}/{cache}

Copy to Clipboard

Toggle word wrap

Data Grid は、キャッシュが無視リストに正常に追加された場合は 204 (No Content)、キャッシュやキャッシュマネージャーが見つからない場合は 404 (Not Found) で応答します。

注記

Data Grid は現在、サーバーごとに 1 つのキャッシュマネージャーのみをサポートしています。将来の互換性のために、リクエストでキャッシュマネージャー名を指定する必要があります。

2.5.4. 無視リストからのキャッシュの削除
リンクのコピー

DELETE リクエストでキャッシュを無視リストから削除します。

DELETE /v2/server/ignored-caches/{cache-manager}/{cache}

DELETE /v2/server/ignored-caches/{cache-manager}/{cache}

Copy to Clipboard

Toggle word wrap

Data Grid は、キャッシュが無視リストから正常に削除された場合は 204 (No Content)、キャッシュやキャッシュマネージャーが見つからない場合は 404 (Not Found) で応答します。

2.5.5. 無視されたキャッシュの確認
リンクのコピー

GET リクエストでキャッシュが無視されることを確認します。

GET /v2/server/ignored-caches/{cache-manager}

GET /v2/server/ignored-caches/{cache-manager}

Copy to Clipboard

Toggle word wrap

2.5.6. サーバー設定の取得
リンクのコピー

GET リクエストで Data Grid サーバーの設定を取得します。

GET /rest/v2/server/config

GET /rest/v2/server/config

Copy to Clipboard

Toggle word wrap

Data Grid は、以下のように JSON 形式で設定を応答します。

{
    "server":{
        "interfaces":{
            "interface":{
                "name":"public",
                "inet-address":{
                    "value":"127.0.0.1"
                }
            }
        },
        "socket-bindings":{
            "port-offset":0,
            "default-interface":"public",
            "socket-binding":[
                {
                    "name":"memcached",
                    "port":11221,
                    "interface":"memcached"
                }
            ]
        },
        "security":{
            "security-realms":{
                "security-realm":{
                    "name":"default"
                }
            }
        },
        "endpoints":{
            "socket-binding":"default",
            "security-realm":"default",
            "hotrod-connector":{
                "name":"hotrod"
            },
            "rest-connector":{
                "name":"rest"
            }
        }
    }
}

{
    "server":{
        "interfaces":{
            "interface":{
                "name":"public",
                "inet-address":{
                    "value":"127.0.0.1"
                }
            }
        },
        "socket-bindings":{
            "port-offset":0,
            "default-interface":"public",
            "socket-binding":[
                {
                    "name":"memcached",
                    "port":11221,
                    "interface":"memcached"
                }
            ]
        },
        "security":{
            "security-realms":{
                "security-realm":{
                    "name":"default"
                }
            }
        },
        "endpoints":{
            "socket-binding":"default",
            "security-realm":"default",
            "hotrod-connector":{
                "name":"hotrod"
            },
            "rest-connector":{
                "name":"rest"
            }
        }
    }
}

Copy to Clipboard

Toggle word wrap

2.5.7. 環境変数の取得
リンクのコピー

GET リクエストで Data Grid サーバーのすべての環境変数を取得します。

GET /rest/v2/server/env

GET /rest/v2/server/env

Copy to Clipboard

Toggle word wrap

2.5.8. JVM メモリーの詳細の取得
リンクのコピー

GET リクエストで Data Grid サーバーの JVM メモリー使用量情報を取得します。

GET /rest/v2/server/memory

GET /rest/v2/server/memory

Copy to Clipboard

Toggle word wrap

Data Grid は、ヒープと非ヒープのメモリー統計、直接のメモリー使用量、メモリープールとガベージコレクションに関する情報を JSON 形式で応答します。

2.5.9. JVM スレッドダンプの取得
リンクのコピー

GET リクエストで、JVM の現在のスレッドダンプを取得します。

GET /rest/v2/server/threads

GET /rest/v2/server/threads

Copy to Clipboard

Toggle word wrap

Data Grid は現在のスレッドダンプを text/plain 形式で応答します。

2.5.10. Data Grid Server の診断レポートの取得
リンクのコピー

GET リクエストで Data Grid サーバーの集約されたレポートを取得します。

GET /rest/v2/server/report

GET /rest/v2/server/report

Copy to Clipboard

Toggle word wrap

Data Grid は、Data Grid サーバーとホストの両方に関する診断情報を含む集約されたレポートを含む tar.gz アーカイブで応答します。レポートは、設定ファイルやログファイルに加えて、CPU、メモリー、オープンファイル、ネットワークソケットとルーティング、スレッドに関する詳細を提供します。

2.5.11. Data Grid サーバーの停止
リンクのコピー

POST リクエストで Data Grid サーバーを停止する。

POST /rest/v2/server?action=stop

POST /rest/v2/server?action=stop

Copy to Clipboard

Toggle word wrap

Data Grid は 204 (No Content) と応答し、実行を停止します。

2.6. Data Grid クラスターの操作
リンクのコピー

Data Grid クラスターの管理タスクを監視および実行します。

2.6.1. Data Grid クラスターの停止
リンクのコピー

POST 要求を使用して Data Grid クラスター全体をシャットダウンします。

POST /rest/v2/cluster?action=stop

POST /rest/v2/cluster?action=stop

Copy to Clipboard

Toggle word wrap

Data Grid は 204 (No Content) と応答し、クラスター全体の秩序あるシャットダウンを実行します。

2.6.2. クラスター内の特定の Data Grid サーバーの停止
リンクのコピー

GET リクエストに ?action=stop&server パラメーターを指定して、Data Grid クラスター内の 1 つまたは複数の特定のサーバーをシャットダウンすることができます。

POST /rest/v2/cluster?action=stop&server={server1_host}&server={server2_host}

POST /rest/v2/cluster?action=stop&server={server1_host}&server={server2_host}

Copy to Clipboard

Toggle word wrap

Data Grid は 204 (No Content) と応答します。

2.6.3. Data Grid クラスターのバックアップ
リンクのコピー

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

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

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

Copy to Clipboard

Toggle word wrap

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

Expand

表2.22 JSON パラメーター
キー	必須またはオプション	値
`directory`	オプション	バックアップアーカイブを作成および保存するサーバー上の場所を指定します。

バックアップ操作が正常に完了すると、サービスは 202 (Accepted) を返します。同じ名前のバックアップがすでに存在する場合、サービスは 409 (Conflict) 返します。directory パラメーターが無効な場合、サービスは 400 (Bad Request) 返します。

2.6.4. バックアップの一覧表示
リンクのコピー

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

GET /rest/v2/cluster/backups

GET /rest/v2/cluster/backups

Copy to Clipboard

Toggle word wrap

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

["backup1", "backup2"]

["backup1", "backup2"]

Copy to Clipboard

Toggle word wrap

2.6.5. バックアップの可用性の確認
リンクのコピー

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

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

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

Copy to Clipboard

Toggle word wrap

2.6.6. バックアップアーカイブのダウンロード
リンクのコピー

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

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

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

Copy to Clipboard

Toggle word wrap

2.6.7. バックアップアーカイブの削除
リンクのコピー

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

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

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

Copy to Clipboard

Toggle word wrap

2.6.8. Data Grid クラスターリソースの復元
リンクのコピー

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

重要

バックアップアーカイブ内のコンテナー名がクラスターのコンテナー名と一致する場合にのみ、リソースを復元できます。

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

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

Copy to Clipboard

Toggle word wrap

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

2.6.8.1. Data Grid サーバー上のバックアップアーカイブからの復元
リンクのコピー

サーバー上のアーカイブからバックアップする場合は、POST リクエストに application/json コンテンツタイプを使用します。

Expand

表2.23 JSON パラメーター
キー	必須またはオプション	値
`location`	必須	復元するバックアップアーカイブのパスを指定します。
`resources`	オプション	復元するリソースを JSON 形式で指定します。デフォルトでは、すべてのリソースを復元します。1 つまたは複数のリソースを指定した場合、Data Grid はそれらのリソースのみをリストアします。詳細については、リソースパラメーターの表を参照してください。

Expand

表2.24 リソースパラメーター
キー	必須またはオプション	値
`caches`	オプション	バックアップするキャッシュ名の配列を指定するか、すべてのキャッシュを対象とする `*` を指定します。
`cache-configs`	オプション	バックアップするキャッシュテンプレートの配列、またはすべてのテンプレートの `*` を指定します。
`counters`	オプション	バックアップするカウンター名の配列、またはすべてのカウンターの `*` を定義します。
`proto-schemas`	オプション	バックアップする Protobuf スキーマ名の配列、またはすべてのスキーマの `*` を定義します。
`tasks`	オプション	バックアップするサーバータスクの配列、またはすべてのタスクの `*` を指定します。

次の例では、サーバー上のバックアップアーカイブからすべてのカウンターを復元します。

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

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

Copy to Clipboard

Toggle word wrap

2.6.8.2. ローカルバックアップアーカイブからの復元
リンクのコピー

ローカルのバックアップアーカイブをサーバーにアップロードするには、POST リクエストに multipart/form-data コンテンツタイプを使用します。

Expand

表2.25 フォームデータ
パラメーター	Content-Type	必須またはオプション	値
`backup`	`application/zip`	必須	復元するバックアップアーカイブのバイトを指定します。

要求の例

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

--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--

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

--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--

Copy to Clipboard

Toggle word wrap

2.6.9. リストの復元
リンクのコピー

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

GET /rest/v2/cluster/restores

GET /rest/v2/cluster/restores

Copy to Clipboard

Toggle word wrap

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

["restore1", "restore2"]

["restore1", "restore2"]

Copy to Clipboard

Toggle word wrap

2.6.10. 復元の進行状況を確認する
リンクのコピー

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

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

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

Copy to Clipboard

Toggle word wrap

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

2.6.11. 復元メタデータの削除
リンクのコピー

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

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

Copy to Clipboard

Toggle word wrap

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

2.7. Data Grid サーバーのログ設定
リンクのコピー

実行時に Data Grid クラスターのログ設定を表示および変更します。

2.7.1. ロギングアペンダーの一覧表示
リンクのコピー

GET リクエストで設定されたすべてのアペンダーのリストを表示します。

GET /rest/v2/logging/appenders

GET /rest/v2/logging/appenders

Copy to Clipboard

Toggle word wrap

Data Grid は、次の例のように、JSON 形式のアペンダーのリストで応答します。

{
  "STDOUT" : {
    "name" : "STDOUT"
  },
  "JSON-FILE" : {
    "name" : "JSON-FILE"
  },
  "HR-ACCESS-FILE" : {
    "name" : "HR-ACCESS-FILE"
  },
  "FILE" : {
    "name" : "FILE"
  },
  "REST-ACCESS-FILE" : {
    "name" : "REST-ACCESS-FILE"
  }
}

{
  "STDOUT" : {
    "name" : "STDOUT"
  },
  "JSON-FILE" : {
    "name" : "JSON-FILE"
  },
  "HR-ACCESS-FILE" : {
    "name" : "HR-ACCESS-FILE"
  },
  "FILE" : {
    "name" : "FILE"
  },
  "REST-ACCESS-FILE" : {
    "name" : "REST-ACCESS-FILE"
  }
}

Copy to Clipboard

Toggle word wrap

2.7.2. ロガーの一覧表示
リンクのコピー

GET リクエストで設定されたすべてのロガーのリストを表示します。

GET /rest/v2/logging/loggers

GET /rest/v2/logging/loggers

Copy to Clipboard

Toggle word wrap

Data Grid は、次の例のように、JSON 形式のロガーのリストで応答します。

[ {
  "name" : "",
  "level" : "INFO",
  "appenders" : [ "STDOUT", "FILE" ]
}, {
  "name" : "org.infinispan.HOTROD_ACCESS_LOG",
  "level" : "INFO",
  "appenders" : [ "HR-ACCESS-FILE" ]
}, {
  "name" : "com.arjuna",
  "level" : "WARN",
  "appenders" : [ ]
}, {
  "name" : "org.infinispan.REST_ACCESS_LOG",
  "level" : "INFO",
  "appenders" : [ "REST-ACCESS-FILE" ]
} ]

[ {
  "name" : "",
  "level" : "INFO",
  "appenders" : [ "STDOUT", "FILE" ]
}, {
  "name" : "org.infinispan.HOTROD_ACCESS_LOG",
  "level" : "INFO",
  "appenders" : [ "HR-ACCESS-FILE" ]
}, {
  "name" : "com.arjuna",
  "level" : "WARN",
  "appenders" : [ ]
}, {
  "name" : "org.infinispan.REST_ACCESS_LOG",
  "level" : "INFO",
  "appenders" : [ "REST-ACCESS-FILE" ]
} ]

Copy to Clipboard

Toggle word wrap

2.7.3. ロガーの作成/変更
リンクのコピー

新しいロガーを作成するか、 PUT リクエストで既存のロガーを変更します。

PUT /rest/v2/logging/loggers/{loggerName}?level={level}&appender={appender}&appender={appender}...

PUT /rest/v2/logging/loggers/{loggerName}?level={level}&appender={appender}&appender={appender}...

Copy to Clipboard

Toggle word wrap

Data Grid は、{loggerName} で識別されるロガーのレベルを {level} に設定します。オプションで、ロガーに 1 つ以上のアペンダーを設定できます。アペンダーが指定されていない場合は、ルートロガーで指定されたアペンダーが使用されます。

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

2.7.4. ロガーの削除
リンクのコピー

DELETE リクエストで既存のロガーを削除します。

DELETE /rest/v2/logging/loggers/{loggerName}

DELETE /rest/v2/logging/loggers/{loggerName}

Copy to Clipboard

Toggle word wrap

Data Grid は、{loggerName} で識別されるロガーを削除し、root ロガー設定の使用に効果的に戻します。

操作が正常に処理された場合、サービスは応答コード 204 (No Content) を返します。

2.8. サーバータスクの使用
リンクのコピー

Data Grid サーバータスクを取得、実行、およびアップロードします。

2.8.1. サーバータスク情報の取得
リンクのコピー

GET リクエストで利用可能なサーバータスクに関する情報を表示します。

GET /rest/v2/tasks

GET /rest/v2/tasks

Copy to Clipboard

Toggle word wrap

Expand

表2.26 リクエストパラメーター
パラメーター	必須またはオプション	値
`type`	オプション	`user`: 内部 (管理者) のタスクを結果から除外します。

Data Grid は、利用可能なタスクのリストで応答します。リストには、次の例のように、タスクの名前、タスクを処理するエンジン、タスクの名前付きパラメーター、タスクの実行モード (ONE_NODE または ALL_NODES)、許可されるセキュリティーロールが JSON 形式で記載されています。

[
  {
    "name": "SimpleTask",
    "type": "TaskEngine",
    "parameters": [
      "p1",
      "p2"
    ],
    "execution_mode": "ONE_NODE",
    "allowed_role": null
  },
  {
    "name": "RunOnAllNodesTask",
    "type": "TaskEngine",
    "parameters": [
      "p1"
    ],
    "execution_mode": "ALL_NODES",
    "allowed_role": null
  },
  {
    "name": "SecurityAwareTask",
    "type": "TaskEngine",
    "parameters": [],
    "execution_mode": "ONE_NODE",
    "allowed_role": "MyRole"
  }
]

[
  {
    "name": "SimpleTask",
    "type": "TaskEngine",
    "parameters": [
      "p1",
      "p2"
    ],
    "execution_mode": "ONE_NODE",
    "allowed_role": null
  },
  {
    "name": "RunOnAllNodesTask",
    "type": "TaskEngine",
    "parameters": [
      "p1"
    ],
    "execution_mode": "ALL_NODES",
    "allowed_role": null
  },
  {
    "name": "SecurityAwareTask",
    "type": "TaskEngine",
    "parameters": [],
    "execution_mode": "ONE_NODE",
    "allowed_role": "MyRole"
  }
]

Copy to Clipboard

Toggle word wrap

2.8.2. タスクの実行
リンクのコピー

タスクの実行は、タスク名と param を先頭につけた必須パラメーターを含む POST リクエストで行います。

POST /rest/v2/tasks/SimpleTask?action=exec&param.p1=v1&param.p2=v2

POST /rest/v2/tasks/SimpleTask?action=exec&param.p1=v1&param.p2=v2

Copy to Clipboard

Toggle word wrap

Data Grid はタスクの結果で応答します。

2.8.3. スクリプトタスクのアップロード
リンクのコピー

PUT または POST リクエストでスクリプトタスクをアップロードします。

リクエストのコンテンツペイロードとしてスクリプトを提供します。Data Grid がスクリプトをアップロードした後、GET リクエストでスクリプトを実行することができます。

POST /rest/v2/tasks/taskName

POST /rest/v2/tasks/taskName

Copy to Clipboard

Toggle word wrap

2.9. Data Grid セキュリティーの操作
リンクのコピー

セキュリティー情報を表示および変更します。

2.9.1. ユーザーの ACL の取得
リンクのコピー

ユーザーのプリンシパルとアクセス制御リストに関する情報を表示します。

GET /rest/v2/security/user/acl

GET /rest/v2/security/user/acl

Copy to Clipboard

Toggle word wrap

Data Grid は、リクエストを実行したユーザーに関する情報で応答します。このリストには、ユーザーのプリンシパル、リソースのリストとユーザーがアクセスする際のパーミッションが含まれています。

{
  "subject": [
    {
      "name": "deployer",
      "type": "NamePrincipal"
    }
  ],
  "global": [
    "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"  ],
  "caches": {
    "___protobuf_metadata": [
      "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"
    ],
    "mycache": [
      "LIFECYCLE", "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "ADMIN", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"
    ],
    "___script_cache": [
      "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"
    ]
  }
}

{
  "subject": [
    {
      "name": "deployer",
      "type": "NamePrincipal"
    }
  ],
  "global": [
    "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"  ],
  "caches": {
    "___protobuf_metadata": [
      "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"
    ],
    "mycache": [
      "LIFECYCLE", "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "ADMIN", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"
    ],
    "___script_cache": [
      "READ", "WRITE", "EXEC", "LISTEN", "BULK_READ", "BULK_WRITE", "CREATE", "MONITOR", "ALL_READ", "ALL_WRITE"
    ]
  }
}

Copy to Clipboard

Toggle word wrap

2.9.2. ACL キャッシュのフラッシュ
リンクのコピー

クラスター全体のアクセスコントロールリストキャッシュをフラッシュします。

POST /rest/v2/security/cache?action=flush

POST /rest/v2/security/cache?action=flush

Copy to Clipboard

Toggle word wrap

2.9.3. 利用可能なロールの取得
リンクのコピー

サーバーに定義されている利用可能なすべてのロールを表示します。

GET /rest/v2/security/roles

GET /rest/v2/security/roles

Copy to Clipboard

Toggle word wrap

Data Grid は、利用可能なロールのリストで応答します。認証が有効な場合、ADMIN 権限を持つユーザーのみがこの API を呼び出すことができます。

["observer","application","admin","monitor","deployer"]

["observer","application","admin","monitor","deployer"]

Copy to Clipboard

Toggle word wrap

2.9.4. プリンシパルのロールの取得
リンクのコピー

プリンシパルにマップするすべてのロールを表示します。

GET /rest/v2/security/roles/some_principal

GET /rest/v2/security/roles/some_principal

Copy to Clipboard

Toggle word wrap

Data Grid は、指定されたプリンシパルで使用可能なロールのリストで応答します。プリンシパルは、使用中の領域に存在する必要はありません。

["observer"]

["observer"]

Copy to Clipboard

Toggle word wrap

2.9.5. プリンシパルにロールを付与する
リンクのコピー

プリンシパルに 1 つ以上の新しいロールを付与します。

PUT /v2/security/roles/some_principal?action=grant&role=role1&role=role2

PUT /v2/security/roles/some_principal?action=grant&role=role1&role=role2

Copy to Clipboard

Toggle word wrap

Expand

表2.27 リクエストパラメーター
パラメーター	必須またはオプション	値
`role`	必須	ロールの名前

2.9.6. 校長へのロールの拒否
リンクのコピー

以前にプリンシパルに付与された 1 つ以上のロールを削除します。

PUT /v2/security/roles/some_principal?action=deny&role=role1&role=role2

PUT /v2/security/roles/some_principal?action=deny&role=role1&role=role2

Copy to Clipboard

Toggle word wrap

Expand

表2.28 リクエストパラメーター
パラメーター	必須またはオプション	値
`role`	必須	ロールの名前

法律上の通知
リンクのコピー

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

トップに戻る

Data Grid REST API