Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

Data Grid REST API

Red Hat Data Grid 8.3

配置并与 Data Grid REST API 交互

Red Hat Customer Content Services

摘要

访问数据、监控和维护集群，通过 Data Grid REST API 执行管理操作。

Red Hat Data Grid
复制链接

Data Grid 是一个高性能分布式内存数据存储。

无架构数据结构
以键值对的形式存储不同对象的灵活性。
基于网格的数据存储
用于在集群间分布和复制数据。
Elastic 扩展
动态调整节点数量，以便在不中断服务的情况下满足需求。
数据互操作性
在来自不同端点的网格中存储、检索和查询数据。

Data Grid 文档
复制链接

红帽客户门户网站上提供了有关 Data Grid 的文档。

Data Grid 下载
复制链接

访问 红帽客户门户上的 Data Grid 软件下载。

注意

您必须有一个红帽帐户才能访问和下载 Data Grid 软件。

使开源包含更多
复制链接

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始：master、slave、黑名单和白名单。由于此项工作十分艰巨，这些更改将在即将推出的几个发行版本中逐步实施。详情请查看 CTO Chris Wright 的信息。

第 1 章 Data Grid REST 端点
复制链接

数据网格服务器通过基于 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 ：

注意

带有 JDK8 的 TLS/ALPN 需要额外的客户端配置。有关您的 REST 客户端，请参阅相应的文档。在大多数情况下，您需要使用 Jetty ALPN Agent 或 OpenSSL 绑定。

1.3. 数据格式和 REST API
复制链接

Data Grid 缓存以格式存储数据，您可以使用 MediaType 定义。

有关 MediaTypes 和使用 Data Grid 的编码数据的更多信息，请参阅 Cache Encoding 和 Marshalling。

以下示例为条目配置存储格式： 

<distributed-cache>
   <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，则 Data Grid 默认为 application/octet-stream 用于键和值。但是，如果对缓存进行索引，Data Grid 默认为 application/x-protostream。

1.3.1. 支持的格式
复制链接

您可以根据不同格式写入和读取数据，在需要时可以在这些格式之间转换数据。

以下"标准"格式是可交换的：

  • 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. 接受 Headers
复制链接

Data Grid REST 端点与 RFC-2616 Accept 标头兼容，并根据支持的转换来协商正确的 MediaType。

例如，在读取数据时发送以下标头： 

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 会尝试下一个 文本/纯文本格式（以秒 为 0.7））。最后，Data Grid 会退回到是是的，它根据缓存配置选择合适的格式。

1.3.3. 使用特殊字符的名称
复制链接

创建任何 REST 资源都需要一个作为 URL 一部分的名称，如果此名称包含 RFC 3986 spec 第 2.2 节 中定义的特殊字符，则需要使用 Percent 的编码 机制对其进行编码。

1.3.4. key-Content-Type Headers
复制链接

大多数 REST API 调用中都包含在 URL 中的 Key。Data Grid 在处理这些调用时假设 Key 是 java.lang.String，但您可以使用特定的标头 Key-Content-Type 作为不同的格式的键。

key-Content-Type Header 示例

  • 将 byte[] 键指定为 Base64 字符串：

API 调用： 

`PUT /my-cache/AQIDBDM=`
Copy to Clipboard Toggle word wrap

headers:

key-Content-Type: application/octet-stream

  • 将 byte[] 键指定为十六进制字符串：

API 调用：

GET /my-cache/0x01CA03042F

headers: 

Key-Content-Type: application/octet-stream; encoding=hex
Copy to Clipboard Toggle word wrap
  • 指定双键：

API 调用：

POST /my-cache/3.141456

headers: 

Key-Content-Type: application/x-java-object;type=java.lang.Double
Copy to Clipboard Toggle word wrap

application/x-java-object 的 type 参数仅限于：

  • 原语打包程序类型
  • java.lang.String
  • 字节，使 application/x-java-object;type=Bytes 等同于 application/octet-stream;encoding=hex。

1.3.5. JSON/Protostream Conversion
复制链接

当缓存被索引时，或者配置为存储 application/x-protostream 时，您可以发送和接收自动从 Protobuf 转换的 JSON 文档。

您必须注册 Protobuf 模式，才能进行转换。

要通过 REST 注册 protobuf 模式，请在 protobufprotobuf_metadata 缓存中调用 POST 或 PUT，如下例所示： 

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 文档时，文档中必须存在一个特殊字段 _type，以标识与文档对应的 Protobuf 消息。

person.proto

message Person  {
  required string name = 1;
  required int32 age = 2;
}
Copy to Clipboard Toggle word wrap

Person.json

{
   "_type": "Person",
   "name": "user1",
   "age": 32
}
Copy to Clipboard Toggle word wrap

1.4. 跨形资源共享(CORS)请求
复制链接

Data Grid REST 连接器支持 CORS，包括基于请求来源的 preflight 和规则。

下面显示了一个使用 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>
Copy to Clipboard Toggle word wrap

Data Grid 根据浏览器设置的 "Origin" 标头来按顺序评估 CORS 规则。

在上例中，如果 origin 是 "http://host1" 或 "https://host1"，则应用规则 "restrict host1"。如果原始卷不同，则下一个规则会被测试。

因为 "allow ALL" 规则允许所有原始卷，所以具有 "http://host1" 或 "https://host1" 以外的任何原始脚本都可以执行允许的方法，并使用提供的标头。

有关配置 CORS 规则的详情，请参考 Data Grid Server Configuration Schema。

1.4.1. 允许对某些原始卷允许所有 CORS 权限
复制链接

在启动服务器时，可以使用 VM 属性 infinispan.server.rest.cors-allow，以允许对一个或多个来源的所有权限。例如： 

./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 REST API 操作在成功时返回 200 (OK)。但是，当某些操作被成功处理时，它们会返回 HTTP 状态代码，如 204 或 202，而不是 200。

2.1. 创建和管理缓存
复制链接

创建和管理 Data Grid 缓存，并对数据执行操作。

2.1.1. 创建缓存
复制链接

使用 POST 请求在有效负载中包含 XML 或 JSON 配置，在 Data Grid 集群间创建命名缓存。 

POST /rest/v2/caches/{cacheName}
Copy to Clipboard Toggle word wrap
Expand
表 2.1. Headers
标头必需/可选参数

Content-Type

必需

为 Data Grid 配置有效负载设置 MediaType ； application/xml 或 application/json。

标记

OPTIONAL

用于设置 AdminFlags

2.1.1.1. 缓存配置
复制链接

您可以使用 XML、JSON 和 YAML 格式创建声明性缓存配置。

所有声明性缓存都必须符合 Data Grid 模式。JSON 格式的配置必须遵循 XML 配置的结构，元素对应于对象和属性对应于字段。

重要

Data Grid 将字符限制为缓存名称或缓存模板名称的最大 255 个。如果您超过这个字符限制，Data Grid 服务器可能会立即停止，而不会发出异常消息。编写 succinct 缓存名称和缓存模板名称。

重要

文件系统可能会对文件名的长度设置限制，因此请确保缓存的名称不会超过这个限制。如果缓存名称超过文件系统的命名限制，则常规操作或对该缓存的初始操作可能会失败。编写 succinct 缓存名称和缓存模板名称。

分布式缓存

XML

<distributed-cache owners="2"
                   segments="256"
                   capacity-factor="1.0"
                   l1-lifespan="5000"
                   mode="SYNC"
                   statistics="true">
  <encoding media-type="application/x-protostream"/>
  <locking isolation="REPEATABLE_READ"/>
  <transaction mode="FULL_XA"
               locking="OPTIMISTIC"/>
  <expiration lifespan="5000"
              max-idle="1000" />
  <memory max-count="1000000"
          when-full="REMOVE"/>
  <indexing enabled="true"
            storage="local-heap">
    <index-reader refresh-interval="1000"/>
  </indexing>
  <partition-handling when-split="ALLOW_READ_WRITES"
                      merge-policy="PREFERRED_NON_NULL"/>
  <persistence passivation="false">
    <!-- Persistent storage configuration. -->
  </persistence>
</distributed-cache>
Copy to Clipboard Toggle word wrap

JSON

{
  "distributed-cache": {
    "mode": "SYNC",
    "owners": "2",
    "segments": "256",
    "capacity-factor": "1.0",
    "l1-lifespan": "5000",
    "statistics": "true",
    "encoding": {
      "media-type": "application/x-protostream"
    },
    "locking": {
      "isolation": "REPEATABLE_READ"
    },
    "transaction": {
      "mode": "FULL_XA",
      "locking": "OPTIMISTIC"
    },
    "expiration" : {
      "lifespan" : "5000",
      "max-idle" : "1000"
    },
    "memory": {
      "max-count": "1000000",
      "when-full": "REMOVE"
    },
    "indexing" : {
      "enabled" : true,
      "storage" : "local-heap",
      "index-reader" : {
        "refresh-interval" : "1000"
      }
    },
    "partition-handling" : {
      "when-split" : "ALLOW_READ_WRITES",
      "merge-policy" : "PREFERRED_NON_NULL"
    },
    "persistence" : {
      "passivation" : false
    }
  }
}
Copy to Clipboard Toggle word wrap

YAML

distributedCache:
  mode: "SYNC"
  owners: "2"
  segments: "256"
  capacityFactor: "1.0"
  l1Lifespan: "5000"
  statistics: "true"
  encoding:
    mediaType: "application/x-protostream"
  locking:
    isolation: "REPEATABLE_READ"
  transaction:
    mode: "FULL_XA"
    locking: "OPTIMISTIC"
  expiration:
    lifespan: "5000"
    maxIdle: "1000"
  memory:
    maxCount: "1000000"
    whenFull: "REMOVE"
  indexing:
    enabled: "true"
    storage: "local-heap"
    indexReader:
      refreshInterval: "1000"
  partitionHandling:
    whenSplit: "ALLOW_READ_WRITES"
    mergePolicy: "PREFERRED_NON_NULL"
  persistence:
    passivation: "false"
    # Persistent storage configuration.
Copy to Clipboard Toggle word wrap

复制缓存

XML

<replicated-cache segments="256"
                  mode="SYNC"
                  statistics="true">
  <encoding media-type="application/x-protostream"/>
  <locking isolation="REPEATABLE_READ"/>
  <transaction mode="FULL_XA"
               locking="OPTIMISTIC"/>
  <expiration lifespan="5000"
              max-idle="1000" />
  <memory max-count="1000000"
          when-full="REMOVE"/>
  <indexing enabled="true"
            storage="local-heap">
    <index-reader refresh-interval="1000"/>
  </indexing>
  <partition-handling when-split="ALLOW_READ_WRITES"
                      merge-policy="PREFERRED_NON_NULL"/>
  <persistence passivation="false">
    <!-- Persistent storage configuration. -->
  </persistence>
</replicated-cache>
Copy to Clipboard Toggle word wrap

JSON

{
  "replicated-cache": {
    "mode": "SYNC",
    "segments": "256",
    "statistics": "true",
    "encoding": {
      "media-type": "application/x-protostream"
    },
    "locking": {
      "isolation": "REPEATABLE_READ"
    },
    "transaction": {
      "mode": "FULL_XA",
      "locking": "OPTIMISTIC"
    },
    "expiration" : {
      "lifespan" : "5000",
      "max-idle" : "1000"
    },
    "memory": {
      "max-count": "1000000",
      "when-full": "REMOVE"
    },
    "indexing" : {
      "enabled" : true,
      "storage" : "local-heap",
      "index-reader" : {
        "refresh-interval" : "1000"
      }
    },
    "partition-handling" : {
      "when-split" : "ALLOW_READ_WRITES",
      "merge-policy" : "PREFERRED_NON_NULL"
    },
    "persistence" : {
      "passivation" : false
    }
  }
}
Copy to Clipboard Toggle word wrap

YAML

replicatedCache:
  mode: "SYNC"
  segments: "256"
  statistics: "true"
  encoding:
    mediaType: "application/x-protostream"
  locking:
    isolation: "REPEATABLE_READ"
  transaction:
    mode: "FULL_XA"
    locking: "OPTIMISTIC"
  expiration:
    lifespan: "5000"
    maxIdle: "1000"
  memory:
    maxCount: "1000000"
    whenFull: "REMOVE"
  indexing:
    enabled: "true"
    storage: "local-heap"
    indexReader:
      refreshInterval: "1000"
  partitionHandling:
    whenSplit: "ALLOW_READ_WRITES"
    mergePolicy: "PREFERRED_NON_NULL"
  persistence:
    passivation: "false"
    # Persistent storage configuration.
Copy to Clipboard Toggle word wrap

多个缓存

XML

<infinispan
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="urn:infinispan:config:13.0 https://infinispan.org/schemas/infinispan-config-13.0.xsd
                          urn:infinispan:server:13.0 https://infinispan.org/schemas/infinispan-server-13.0.xsd"
      xmlns="urn:infinispan:config:13.0"
      xmlns:server="urn:infinispan:server:13.0">
  <cache-container name="default"
                   statistics="true">
    <distributed-cache name="mycacheone"
                       mode="ASYNC"
                       statistics="true">
      <encoding media-type="application/x-protostream"/>
      <expiration lifespan="300000"/>
      <memory max-size="400MB"
              when-full="REMOVE"/>
    </distributed-cache>
    <distributed-cache name="mycachetwo"
                       mode="SYNC"
                       statistics="true">
      <encoding media-type="application/x-protostream"/>
      <expiration lifespan="300000"/>
      <memory max-size="400MB"
              when-full="REMOVE"/>
    </distributed-cache>
  </cache-container>
</infinispan>
Copy to Clipboard Toggle word wrap

YAML

infinispan:
  cacheContainer:
    name: "default"
    statistics: "true"
    caches:
      mycacheone:
       distributedCache:
          mode: "ASYNC"
          statistics: "true"
          encoding:
            mediaType: "application/x-protostream"
          expiration:
            lifespan: "300000"
          memory:
            maxSize: "400MB"
            whenFull: "REMOVE"
      mycachetwo:
        distributedCache:
          mode: "SYNC"
          statistics: "true"
          encoding:
            mediaType: "application/x-protostream"
          expiration:
            lifespan: "300000"
          memory:
            maxSize: "400MB"
            whenFull: "REMOVE"
Copy to Clipboard Toggle word wrap

JSON

{
  "infinispan" : {
    "cache-container" : {
      "name" : "default",
      "statistics" : "true",
      "caches" : {
        "mycacheone" : {
          "distributed-cache" : {
            "mode": "ASYNC",
            "statistics": "true",
            "encoding": {
              "media-type": "application/x-protostream"
            },
            "expiration" : {
              "lifespan" : "300000"
            },
            "memory": {
              "max-size": "400MB",
              "when-full": "REMOVE"
            }
          }
        },
        "mycachetwo" : {
          "distributed-cache" : {
            "mode": "SYNC",
            "statistics": "true",
            "encoding": {
              "media-type": "application/x-protostream"
            },
            "expiration" : {
              "lifespan" : "300000"
            },
            "memory": {
              "max-size": "400MB",
              "when-full": "REMOVE"
            }
          }
        }
      }
    }
  }
}
Copy to Clipboard Toggle word wrap

2.1.2. 修改缓存
复制链接

通过 PUT 请求（在有效负载中包含 XML 或 JSON 配置）在 Data Grid 集群中对缓存配置进行更改。

注意

只有在更改与现有配置兼容时，才能修改缓存。

例如，您无法使用复制的缓存配置来修改分布式缓存。同样，如果您使用特定属性创建缓存配置，您无法修改配置以使用不同的属性。例如，通过为 max-count 属性指定一个值来尝试修改缓存配置，如果已经设置了 max-size，则会导致无效的配置。 

PUT /rest/v2/caches/{cacheName}
Copy to Clipboard Toggle word wrap
Expand
表 2.2. Headers
标头必需/可选参数

Content-Type

必需

为 Data Grid 配置有效负载设置 MediaType ； application/xml 或 application/json。

标记

OPTIONAL

用于设置 AdminFlags

2.1.3. 验证缓存
复制链接

检查带有 HEAD 请求的 Data Grid 集群中是否有缓存。 

HEAD /rest/v2/caches/{cacheName}
Copy to Clipboard Toggle word wrap

2.1.4. 使用模板创建缓存
复制链接

使用 POST 请求和 ?template= 参数从 Data Grid 模板创建缓存。 

POST /rest/v2/caches/{cacheName}?template={templateName}
Copy to Clipboard Toggle word wrap
提示

2.1.5. 检索缓存配置
复制链接

使用 GET 请求检索 Data Grid 缓存配置。 

GET /rest/v2/caches/{name}?action=config
Copy to Clipboard Toggle word wrap
Expand
表 2.3. Headers
标头必需/可选参数

accept

OPTIONAL

设置所需的格式以返回内容。支持的格式为 application/xml 和 application/json。默认为 application/json。如需更多信息，请参阅 Accept。

2.1.6. 在 XML、JSON 和 YAML 之间转换缓存配置
复制链接

使用有效配置和 ?action=convert 参数调用 POST 请求。Data Grid 使用 Accept 标头指定的类型中的配置的等效表示来进行响应。 

POST /rest/v2/caches?action=convert
Copy to Clipboard Toggle word wrap

要转换缓存配置，您必须使用 Content-Type 标头和所需的输出格式指定配置的输入格式。例如，以下命令将复制的缓存配置从 XML 转换为 YAML： 

curl localhost:11222/rest/v2/caches?action=convert \
--digest -u username:password \
-X POST -H "Accept: application/yaml" -H "Content-Type: application/xml" \
-d '<replicated-cache mode="SYNC" statistics="false"><encoding media-type="application/x-protostream"/><expiration lifespan="300000" /><memory max-size="400MB" when-full="REMOVE"/></replicated-cache>'
Copy to Clipboard Toggle word wrap

2.1.7. 检索所有缓存详情
复制链接

调用 GET 请求，以检索 Data Grid 缓存的所有详细信息。 

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,
  "rebalancing_enabled": true,
  "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
  • 统计 缓存的当前统计信息。
  • 调整缓存估计 的大小。
  • 配置 缓存配置。
  • 当重新哈希正在进行时，rehash_in_progress true。
  • 当 索引进行时，indexing_in_progress true。
  • 如果启用了重新平衡，则 rebalancing_enabled 为 true。获取此属性可能会在服务器中失败。在这种情况下，属性不会出现在有效负载中。
  • 在启用过期时 绑定。
  • 如果索引缓存，则 索引为 true。
  • 如果缓存 持久，则持久性为 true。
  • 如果缓存是 事务处理，则为事务处理。
  • 如果缓存 安全，则安全保护为 true。
  • 如果缓存有远程备份，则为 has_remote_backup true。
  • key_storage 缓存密钥的介质类型。
  • value_storage 缓存值的介质类型。
注意

key_storage 和 value_storage 匹配缓存的编码配置。对于没有编码的服务器缓存，Data Grid 会假定在对缓存进行索引时，Data Grid 会假定 application/x-protostream，否则 应用/未知。

2.1.8. 检索所有可变缓存配置属性
复制链接

调用 GET 请求，以检索 Data Grid 缓存的所有可变缓存配置属性。 

GET /rest/v2/caches/{name}?action=get-mutable-attributes
Copy to Clipboard Toggle word wrap

Data Grid 提供了一个 JSON 响应，如下所示： 

[
  "jmx-statistics.statistics",
  "locking.acquire-timeout",
  "transaction.single-phase-auto-commit",
  "expiration.max-idle",
  "transaction.stop-timeout",
  "clustering.remote-timeout",
  "expiration.lifespan",
  "expiration.interval",
  "memory.max-count",
  "memory.max-size"
]
Copy to Clipboard Toggle word wrap

添加 full 参数以获取值和类型信息： 

GET /rest/v2/caches/mycache?action=get-mutable-attributes&full=true
Copy to Clipboard Toggle word wrap

Data Grid 提供了一个 JSON 响应，如下所示： 

{
  "jmx-statistics.statistics": {
    "value": true,
    "type": "boolean"
  },
  "locking.acquire-timeout": {
    "value": 15000,
    "type": "long"
  },
  "transaction.single-phase-auto-commit": {
    "value": false,
    "type": "boolean"
  },
  "expiration.max-idle": {
    "value": -1,
    "type": "long"
  },
  "transaction.stop-timeout": {
    "value": 30000,
    "type": "long"
  },
  "clustering.remote-timeout": {
    "value": 17500,
    "type": "long"
  },
  "expiration.lifespan": {
    "value": -1,
    "type": "long"
  },
  "expiration.interval": {
    "value": 60000,
    "type": "long"
  },
  "memory.max-count": {
    "value": -1,
    "type": "long"
  },
  "memory.max-size": {
    "value": null,
    "type": "string"
  }
}
Copy to Clipboard Toggle word wrap

对于 enum 类型的属性，额外的 universe 属性将包含一组可能的值。

2.1.9. 更新缓存配置属性
复制链接

调用 POST 请求，以更改 mutable 缓存配置属性。 

POST /rest/v2/caches/{name}?action=set-mutable-attributes&attribute-name={attributeName}&attribute-value={attributeValue}
Copy to Clipboard Toggle word wrap

2.1.10. 添加条目
复制链接

使用 POST 请求向缓存添加条目。 

POST /rest/v2/caches/{cacheName}/{cacheKey}
Copy to Clipboard Toggle word wrap

前面的请求将有效负载或请求正文放在 cacheName 缓存中。请求替换了已存在的任何数据，并在适用时更新 Time-To-Live 和 Last-Modified 值。

如果成功创建条目，服务会返回 204 (No Content)。

如果指定键的值已存在，POST 请求会返回 409 (Conflict)，且不会修改值。要更新值，您应该使用 PUT 请求。请参阅 替换条目。

Expand
表 2.4. Headers
标头必需/可选参数

Key-Content-Type

OPTIONAL

为请求中的密钥设置内容类型。如需更多信息，请参阅 Key-Content-Type。

Content-Type

OPTIONAL

为键设置值的 MediaType。

timeToLiveSeconds

OPTIONAL

设置条目自动删除前的秒数。如果没有设置此参数，Data Grid 将使用配置中的默认值。如果您设置了负值，则条目永远不会被删除。

maxIdleTimeSeconds

OPTIONAL

设置条目可以闲置的秒数。如果在最大空闲时间过后没有对条目进行读取或写入操作，则会自动删除该条目。如果没有设置此参数，Data Grid 将使用配置中的默认值。如果您设置了负值，则条目永远不会被删除。

标记

OPTIONAL

用于添加条目的标志。如需更多信息，请参阅 标记。

注意

标志 标头也适用于涉及缓存数据操作的所有其他操作，

注意

如果 timeToLiveSeconds 和 maxIdleTimeSeconds 的值为 0， 则 Data Grid 使用默认的 lifespan 和 maxIdle 值。

如果只有 maxIdleTimeSeconds 的值为 0， Data Grid 使用：

  • 配置中的默认 maxIdle 值。
  • 如果没有传递值，则作为请求参数传递的 timeToLiveSeconds 的值为 -1。

如果只有 timeToLiveSeconds 的值为 0， Data Grid 使用：

  • 配置中的 默认 lifespan 值。
  • 如果没有传递值，则作为 request 参数或值 -1 的 maxIdle 的值。

2.1.11. 替换条目
复制链接

将缓存中的条目替换为 PUT 请求。 

PUT /rest/v2/caches/{cacheName}/{cacheKey}
Copy to Clipboard Toggle word wrap

如果指定键的值已存在，PUT 请求会更新该值。如果您不想修改现有值，请使用返回 409 (Conflict) 的 POST 请求，而不是修改值。请参阅 添加值。

2.1.12. 通过密钥检索数据
复制链接

使用 GET 请求检索特定密钥的数据。 

GET /rest/v2/caches/{cacheName}/{cacheKey}
Copy to Clipboard Toggle word wrap

服务器在响应正文中给定密钥 cacheKey 下返回来自给定缓存的数据 cacheName。响应包含与 MediaType 协商对应的 Content-Type 标头。

注意

浏览器也可以直接访问缓存，例如内容交付网络(CDN)。Data Grid 为每个条目返回一个唯一 ETag，以及 Last-Modified 和 Expires 标头字段。

这些字段提供有关请求中返回的数据状态的信息。etags 允许浏览器和其他客户端仅请求已更改的数据，从而节省带宽。

Expand
表 2.5. Headers
标头必需/可选参数

Key-Content-Type

OPTIONAL

为请求中的密钥设置内容类型。默认为 application/x-java-object; type=java.lang.String。如需更多信息，请参阅 Key-Content-Type。

accept

OPTIONAL

设置所需的格式以返回内容。如需更多信息，请参阅 Accept。

提示

在查询字符串中附加 扩展 参数以获取更多信息： 

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.13. 检查条目预期
复制链接

使用 HEAD 请求验证特定条目是否存在。 

HEAD /rest/v2/caches/{cacheName}/{cacheKey}
Copy to Clipboard Toggle word wrap

前面的请求仅返回标头字段以及与条目存储相同的内容。例如，如果您存储了字符串，则请求会返回一个字符串。如果您存储了二进制、base64 编码的、blob 或序列化 Java 对象，则 Data Grid 不会反序列化请求中的内容。

注意

HEAD 请求也支持 扩展 参数。

Expand
表 2.6. Headers
标头必需/可选参数

Key-Content-Type

OPTIONAL

为请求中的密钥设置内容类型。默认为 application/x-java-object; type=java.lang.String。如需更多信息，请参阅 Key-Content-Type。

2.1.14. 删除条目
复制链接

使用 DELETE 请求从缓存中删除条目。 

DELETE /rest/v2/caches/{cacheName}/{cacheKey}
Copy to Clipboard Toggle word wrap
Expand
表 2.7. Headers
标头必需/可选参数

Key-Content-Type

OPTIONAL

为请求中的密钥设置内容类型。默认为 application/x-java-object; type=java.lang.String。如需更多信息，请参阅 Key-Content-Type。

2.1.15. 删除缓存
复制链接

使用 DELETE 请求从 Data Grid 集群中删除缓存。 

DELETE /rest/v2/caches/{cacheName}
Copy to Clipboard Toggle word wrap

2.1.16. 从缓存检索所有密钥
复制链接

调用 GET 请求，以 JSON 格式检索缓存中的所有密钥。 

GET /rest/v2/caches/{cacheName}?action=keys
Copy to Clipboard Toggle word wrap
Expand
表 2.8. 请求参数
参数必需/可选值

limit

OPTIONAL

指定使用 InputStream 检索的最大密钥数。负值检索所有键。默认值为 -1。

batch

OPTIONAL

指定检索密钥时的内部批处理大小。默认值为 1000。

2.1.17. 从缓存检索所有条目
复制链接

调用 GET 请求，以 JSON 格式检索缓存中的所有条目。 

GET /rest/v2/caches/{cacheName}?action=entries
Copy to Clipboard Toggle word wrap
Expand
表 2.9. 请求参数
参数必需/可选值

元数据

OPTIONAL

包括响应中每个条目的元数据。默认值为 false。

limit

OPTIONAL

指定要在响应中包含的最大键数。负值检索所有键。默认值为 -1。

batch

OPTIONAL

指定检索密钥时的内部批处理大小。默认值为 1000。

content-negotiation

OPTIONAL

如果为 true，则将键和值转换为可读的格式。对于使用文本编码（如 text/plain、xml、json）的缓存，服务器会以纯文本形式返回键和值。对于带有二进制编码的缓存，服务器将在支持转换时返回条目为 JSON，否则以文本十六进制格式（如 0xA123CF98 ）返回条目。使用内容协商时，响应将包含两个标头： key-content-type 和 value-content-type，以描述协商的格式。

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
    }
]
Copy to Clipboard Toggle word wrap
  • 条目的键。
  • 条目的值。
  • timeToLiveSeconds 基于条目寿命，但以秒为单位，如果条目永不过期，则为 -1。除非设置了 metadata="true"，否则它不会返回。
  • maxIdleTimeSeconds 最大空闲时间，以秒为单位，如果条目永不过期，则为 -1。除非设置了 metadata="true"，否则它不会返回。
  • 创建 条目创建时间，或为 immortal 条目创建 -1。除非设置了 metadata="true"，否则它不会返回。
  • lastUsed Last time 是在条目上执行某个操作，或 -1 代表 immortal 条目。除非设置了 metadata="true"，否则它不会返回。
  • 当条目过期或 -1 代表 immortal 条目时，expireTime 时间。除非设置了 metadata="true"，否则它不会返回。

2.1.18. 清除缓存
复制链接

要从缓存中删除所有数据，请使用 ?action=clear 参数调用 POST 请求。 

POST /rest/v2/caches/{cacheName}?action=clear
Copy to Clipboard Toggle word wrap

如果操作成功完成，服务会返回 204 (No Content)。

2.1.19. 获取缓存大小
复制链接

使用 GET 请求和 ?action=size 参数，检索整个集群中的缓存大小。 

GET /rest/v2/caches/{cacheName}?action=size
Copy to Clipboard Toggle word wrap

2.1.20. 获取缓存统计信息
复制链接

获取使用 GET 请求缓存的运行时统计信息。 

GET /rest/v2/caches/{cacheName}?action=stats
Copy to Clipboard Toggle word wrap

2.1.21. 列出缓存
复制链接

使用 GET 请求列出 Data Grid 集群中的所有可用缓存。 

GET /rest/v2/caches/
Copy to Clipboard Toggle word wrap

2.1.22. 侦听缓存事件
复制链接

使用 服务器层事件接收缓存事件。事件 值将是 cache-entry-created,cache-entry-removed,cache-entry-updated,cache-entry-expired 之一。data 值将包含以 Accept 标头设置的格式触发事件的条目键。 

GET /rest/v2/caches/{name}?action=listen
Copy to Clipboard Toggle word wrap
Expand
表 2.10. Headers
标头必需/可选参数

accept

OPTIONAL

设置所需的格式以返回内容。支持的格式为 text/plain 和 application/json。默认为 application/json。如需更多信息，请参阅 Accept。

2.1.23. 启用重新平衡
复制链接

为特定的缓存打开自动重新平衡。 

POST /rest/v2/caches/{cacheName}?action=enable-rebalancing
Copy to Clipboard Toggle word wrap

2.1.24. 禁用重新平衡
复制链接

关闭特定缓存的自动重新平衡。 

POST /rest/v2/caches/{cacheName}?action=disable-rebalancing
Copy to Clipboard Toggle word wrap

2.1.25. 获取缓存可用性
复制链接

检索缓存的可用性。 

GET /rest/v2/caches/{cacheName}?action=get-availability
Copy to Clipboard Toggle word wrap
注意

您可以获取内部缓存的可用性，但可能会在未来的 Data Grid 版本中有所变化。

2.1.26. 设置缓存可用性
复制链接

在使用 DENY_READ_WRITES 或 ALLOW_READS 分区处理策略时，更改集群缓存的可用性。 

POST /rest/v2/caches/{cacheName}?action=set-availability&availability={AVAILABILITY}
Copy to Clipboard Toggle word wrap
Expand
表 2.11. 请求参数
参数必需/可选值

可用性

必需

AVAILABLE 或 DEGRADED_MODE

  • AVAILABLE 使缓存对网络分区中的所有节点可用。
  • DEGRADED_MODE 可防止发生网络分区时缓存上的读写操作。
注意

您可以设置内部缓存的可用性，但可能会在未来的 Data Grid 版本中有所变化。

2.1.27. 使用 REST API 索引和查询
复制链接

使用 GET 请求和任何 HTTP 客户端中的 ?action=search&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
    }
  } ]
}
Copy to Clipboard Toggle word wrap

  • total_results 显示来自查询的结果总数。
  • hits 是来自查询的数组。

  • hit 是与查询匹配的对象。

    提示

    如果使用 Select 子句，则 hits 可以包含所有字段或字段子集。

Expand
表 2.12. 请求参数
参数必需/可选值

query

必需

指定查询字符串。

max_results

OPTIONAL

设置要返回的最大结果数。默认值为 10。

offset

OPTIONAL

指定要返回的第一个结果的索引。默认值为 0。

local

OPTIONAL

为 true 时，查询仅限于处理请求的节点中存在的数据。默认值为 false。

要使用请求的正文而不是指定查询参数，请按如下方式调用 POST 请求： 

POST /rest/v2/caches/{cacheName}?action=search
Copy to Clipboard Toggle word wrap

在请求正文中查询

{
 "query":"from Entity where name:\"user1\"",
 "max_results":20,
 "offset":10
}
Copy to Clipboard Toggle word wrap

2.1.27.1. 重新索引数据
复制链接

使用 POST 请求和 ?action=mass-index 参数重新索引缓存中的所有数据。 

POST  /v2/caches/{cacheName}/search/indexes?action=mass-index
Copy to Clipboard Toggle word wrap
Expand
表 2.13. 请求参数
参数必需/可选值

模式

OPTIONAL

mode 参数的值如下：

* sync 仅在重新索引操作完成后返回 204 (No Content)。

* async 立即返回 204 (No Content)，重新索引操作将继续在集群中运行。您可以使用 Index Statistics REST 调用来检查状态。

local

OPTIONAL

为 true 时，只有处理请求的节点数据才会被重新索引。默认值为 false，表示所有集群范围的数据都会被重新索引。

2.1.27.2. 清除索引
复制链接

使用 POST 请求和 ?action=clear 参数从缓存中删除所有索引。 

POST  /rest/v2/caches/{cacheName}/search/indexes?action=clear
Copy to Clipboard Toggle word wrap

如果操作成功完成，服务会返回 204 (No Content)。

2.1.27.3. 检索查询和索引统计信息
复制链接

获取有关 GET 请求在缓存中查询和索引的信息。

注意

您必须在缓存配置中启用统计信息或结果为空。 

GET /rest/v2/caches/{cacheName}/search/stats
Copy to Clipboard Toggle word wrap
Expand
表 2.14. 请求参数
参数必需/可选值

scope

OPTIONAL

使用集群检索 集群 所有成员的合并统计。省略时，Data Grid 会返回本地查询和索引的统计信息。

Data Grid 响应

{
  "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 提供分布式索引查询的详细信息。
  • 混合 提供有关仅使用索引的查询详情。
  • non_indexed 提供有关不使用索引的查询的详细信息。
  • entity_load 提供在索引查询执行后获取对象的缓存操作的详细信息。
注意

时间始终以纳秒为单位。

在 index 部分中：

  • 类型 提供在缓存中配置的每个索引类型（类名称或 protobuf 消息）的详细信息。

    • 计算为类型索引的实体数量。
    • 类型 的大小 使用（以字节为单位）。
  • 重新索引 如果值为 true，则 索引 程序在缓存中运行。
2.1.27.4. 清除查询统计信息
复制链接

使用 POST 请求和 ?action=clear 参数重置运行时统计信息。 

POST /rest/v2/caches/{cacheName}/search/stats?action=clear
Copy to Clipboard Toggle word wrap

Data Grid 仅重置本地节点的执行时间。此操作不清除索引统计信息。

2.1.27.5. 检索索引统计信息（已弃用）
复制链接

使用 GET 请求获取缓存中索引的信息。 

GET /rest/v2/caches/{cacheName}/search/indexes/stats
Copy to Clipboard Toggle word wrap

Data Grid 响应

{
    "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 提供缓存中的每个索引的大小，以字节为单位。
  • 重新索引 指示是否为缓存执行重新索引操作。如果值为 true，则缓存中启动 MassIndexer。
2.1.27.6. 检索查询统计信息（已弃用）
复制链接

获取有关 GET 请求在缓存中运行的查询的信息。 

GET /rest/v2/caches/{cacheName}/search/query/stats
Copy to Clipboard Toggle word wrap

Data Grid 响应

{
    "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 提供加载对象执行的平均时间。
  • object_loaded_count 提供加载的对象计数。
  • search_query_execution_max_time_query_string 提供执行较慢的查询。
2.1.27.7. 清除查询统计信息（已弃用）
复制链接

使用 POST 请求和 ?action=clear 参数重置运行时统计信息。 

POST /rest/v2/caches/{cacheName}/search/query/stats?action=clear
Copy to Clipboard Toggle word wrap

2.1.28. 使用缓存的跨站点操作
复制链接

使用 Data Grid REST API 执行跨站点复制操作。

2.1.28.1. 获取所有备份位置的状态
复制链接

使用 GET 请求检索所有备份位置的状态。 

GET /rest/v2/caches/{cacheName}/x-site/backups/
Copy to Clipboard Toggle word wrap

Data Grid 以 JSON 格式响应每个备份位置的状态，如下例所示： 

{
  "NYC": {
    "status": "online"
  },
  "LON": {
    "status": "mixed",
    "online": [
      "NodeA"
    ],
    "offline": [
      "NodeB"
    ]
  }
}
Copy to Clipboard Toggle word wrap
Expand
表 2.15. 返回的状态
值描述

online

本地集群中的所有节点都有一个带有备份位置的跨站点视图。

离线

本地集群中的节点没有带有备份位置的跨站点视图。

mixed

本地集群中的某些节点具有带有备份位置的跨站点视图，本地集群中的其他节点没有跨站点视图。响应指示每个节点的状态。

2.1.28.2. 获取特定备份位置的状态
复制链接

使用 GET 请求检索备份位置的状态。 

GET /rest/v2/caches/{cacheName}/x-site/backups/{siteName}
Copy to Clipboard Toggle word wrap

Data Grid 使用 JSON 格式的站点的状态响应，如下例所示： 

{
  "NodeA":"offline",
  "NodeB":"online"
}
Copy to Clipboard Toggle word wrap
Expand
表 2.16. 返回的状态
值描述

online

节点在线。

离线

节点离线。

失败

无法检索状态。远程缓存可能会关闭，或者在请求过程中发生网络错误。

2.1.28.3. 离线备份位置
复制链接

通过 POST 请求和 ?action=take-offline 参数使位置离线。 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=take-offline
Copy to Clipboard Toggle word wrap
2.1.28.4. 在线备份位置
复制链接

使用 ?action=bring-online 参数使备份位置上线。 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=bring-online
Copy to Clipboard Toggle word wrap
2.1.28.5. 将状态推送到备份位置
复制链接

使用 ?action=start-push-state 参数将缓存状态推送到备份位置。 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=start-push-state
Copy to Clipboard Toggle word wrap
2.1.28.6. 取消状态传输
复制链接

使用 ?action=cancel-push-state 参数取消状态传输操作。 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-push-state
Copy to Clipboard Toggle word wrap
2.1.28.7. 获取状态传输状态
复制链接

使用 ?action=push-state-status 参数检索状态传输操作。 

GET /rest/v2/caches/{cacheName}/x-site/backups?action=push-state-status
Copy to Clipboard Toggle word wrap

Data Grid 使用 JSON 格式的每个备份位置的状态进行响应，如下例所示： 

{
   "NYC":"CANCELED",
   "LON":"OK"
}
Copy to Clipboard Toggle word wrap
Expand
表 2.17. 返回的状态
值描述

SEND

状态转移到备份位置正在进行中。

确定

状态转移成功完成。

ERROR

状态传输发生错误。检查日志文件。

取消

状态转移取消正在进行。

2.1.28.8. 清除状态传输状态
复制链接

使用 ?action=clear-push-state-status 参数发送站点的明确状态传输状态。 

POST /rest/v2/caches/{cacheName}/x-site/local?action=clear-push-state-status
Copy to Clipboard Toggle word wrap
2.1.28.9. 修改所需的离线条件
复制链接

如果满足特定条件，站点会脱机。修改 take offline 参数，以控制备份位置自动下线的时间。

流程

  1. 检查配置了 GET 请求和 take-offline-config 参数的离线参数。 

    GET /rest/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
}
    Copy to Clipboard Toggle word wrap

  2. 修改在 PUT 请求正文中的获取离线参数。 

    PUT /rest/v2/caches/{cacheName}/x-site/backups/{siteName}/take-offline-config
    Copy to Clipboard Toggle word wrap

    如果操作成功完成，服务会返回 204 (No Content)。

2.1.28.10. 取消接收站点的状态传输
复制链接

如果两个备份位置之间的连接中断，您可以取消接收推送的站点的状态传输。

从远程站点取消状态传输，并使用 ?action=cancel-receive-state 参数保留本地缓存的当前状态。 

POST /rest/v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-receive-state
Copy to Clipboard Toggle word wrap

2.1.29. 滚动升级
复制链接

在 Data Grid 集群间执行缓存数据的滚动升级

2.1.29.1. 连接源集群
复制链接

使用以下方法将目标集群连接到源集群： 

POST /rest/v2/caches/{cacheName}/rolling-upgrade/source-connection
Copy to Clipboard Toggle word wrap

您必须以 JSON 格式提供一个 remote-store 定义，作为正文：

JSON

{
  "remote-store": {
    "cache": "my-cache",
    "shared": true,
    "raw-values": true,
    "socket-timeout": 60000,
    "protocol-version": "2.9",
    "remote-server": [
      {
        "host": "127.0.0.2",
        "port": 12222
      }
    ],
    "connection-pool": {
      "max-active": 110,
      "exhausted-action": "CREATE_NEW"
    },
    "async-executor": {
      "properties": {
        "name": 4
      }
    },
    "security": {
      "authentication": {
        "server-name": "servername",
        "digest": {
          "username": "username",
          "password": "password",
          "realm": "realm",
          "sasl-mechanism": "DIGEST-MD5"
        }
      },
      "encryption": {
        "protocol": "TLSv1.2",
        "sni-hostname": "snihostname",
        "keystore": {
          "filename": "/path/to/keystore_client.jks",
          "password": "secret",
          "certificate-password": "secret",
          "key-alias": "hotrod",
          "type": "JKS"
        },
        "truststore": {
          "filename": "/path/to/gca.jks",
          "password": "secret",
          "type": "JKS"
        }
      }
    }
  }
}
Copy to Clipboard Toggle word wrap

多个元素是可选的，如 安全、async-executor 和 connection-pool。配置必须包含缓存名称最少，raw-values 设置为 false，以及源集群中单个端口的主机/ip。有关 remote-store 配置的详细信息，请参阅 XSD Schema。

如果操作成功完成，服务会返回 204 (No Content)。如果目标集群已连接到源集群，它会返回 304 状态（未修改）。

2.1.29.2. 获取源集群连接详情
复制链接

要获取缓存的 remote-store 定义，请使用 GET 请求： 

GET /rest/v2/caches/{cacheName}/rolling-upgrade/source-connection
Copy to Clipboard Toggle word wrap

如果缓存之前已连接，它将以 JSON 格式返回关联 remote-store 的配置，以及状态 200 (OK)，否则会返回 404 (Not Found)状态。

注意

这不是一个集群范围的操作，它只会在处理 REST 调用的节点中返回缓存的远程存储。

2.1.29.3. 检查缓存是否已连接
复制链接

要检查缓存是否已连接到远程集群，请使用 HEAD 请求： 

HEAD /rest/v2/caches/{cacheName}/rolling-upgrade/source-connection
Copy to Clipboard Toggle word wrap

如果对于集群的所有节点，则返回状态 200 (OK)，cacheName 配置了单个远程存储，否则为 404 (NOT_FOUND)。

2.1.29.4. 同步数据
复制链接

使用 POST 请求和 ?action=sync-data 参数将数据从源集群同步到目标集群： 

POST /rest/v2/caches/{cacheName}?action=sync-data
Copy to Clipboard Toggle word wrap

当操作完成后，Data Grid 会以复制到目标集群的条目总数进行响应。

2.1.29.5. 断开源集群
复制链接

将数据与目标集群同步后，使用 DELETE 请求与源集群断开连接： 

DELETE /rest/v2/caches/{cacheName}/rolling-upgrade/source-connection
Copy to Clipboard Toggle word wrap

如果操作成功完成，服务会返回 204 (No Content)。它没有连接源，它会返回代码 304 （未修改）。

2.2. 创建和管理计数
复制链接

通过 REST API 创建、删除和修改计数器。

2.2.1. 创建计数
复制链接

使用在有效负载中包含配置的 POST 请求创建计数器。 

POST /rest/v2/counters/{counterName}
Copy to Clipboard Toggle word wrap

Weak Counter 示例

{
    "weak-counter":{
        "initial-value":5,
        "storage":"PERSISTENT",
        "concurrency-level":1
    }
}
Copy to Clipboard Toggle word wrap

Strong Counter 示例

{
    "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}
Copy to Clipboard Toggle word wrap

2.2.3. 检索计数配置
复制链接

使用 GET 请求检索特定计数器的配置。 

GET /rest/v2/counters/{counterName}/config
Copy to Clipboard Toggle word wrap

Data Grid 使用 JSON 格式的计数器配置响应。

2.2.4. 获取计数值
复制链接

使用 GET 请求检索计数器值。 

GET /rest/v2/counters/{counterName}
Copy to Clipboard Toggle word wrap
Expand
表 2.18. Headers
标头必需/可选参数

accept

OPTIONAL

返回内容所需的格式。支持的格式为 application/json 和 text/plain。如果未提供标头，则会假定 JSON。

2.2.5. 重置计数
复制链接

恢复没有 POST 请求和 ?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
Copy to Clipboard Toggle word wrap
注意

WEAK 计数器不会在操作后响应并返回 204 （无内容）。

STRONG 计数器在每次操作后返回 200 (OK) 和当前值。

2.2.7. 将 Deltas 添加到 Counters
复制链接

使用包含 ?action=add 和 delta 参数的 POST 请求向计数器添加任意值。 

POST /rest/v2/counters/{counterName}?action=add&delta={delta}
Copy to Clipboard Toggle word wrap
注意

WEAK 计数器不会在操作后响应并返回 204 （无内容）。

STRONG 计数器在每次操作后返回 200 (OK) 和当前值。

2.2.8. 减少计数值
复制链接

使用 POST 请求和 ?action=decrement 参数来解码计数器值。 

POST /rest/v2/counters/{counterName}?action=decrement
Copy to Clipboard Toggle word wrap
注意

WEAK 计数器不会在操作后响应并返回 204 （无内容）。

STRONG 计数器在每次操作后返回 200 (OK) 和当前值。

2.2.9. 在 Strong Counters 上执行比较AndSet 操作
复制链接

通过 GET 请求和 compareAndSet 参数，以原子方式设置计数器的值。 

POST /rest/v2/counters/{counterName}?action=compareAndSet&expect={expect}&update={update}
Copy to Clipboard Toggle word wrap

如果当前值为 {expect}，则数据网格会以原子方式将值设置为 {update}。如果操作成功，Data Grid 将返回 true。

2.2.10. 在 Strong Counters 上执行比较AndSwap 操作
复制链接

通过 GET 请求和 compareAndSwap 参数，以原子方式设置计数器的值。 

POST /rest/v2/counters/{counterName}?action=compareAndSwap&expect={expect}&update={update}
Copy to Clipboard Toggle word wrap

如果当前值为 {expect}，则数据网格会以原子方式将值设置为 {update}。如果操作成功，Data Grid 会从载荷返回先前的值。

2.2.11. 列出计数
复制链接

使用 GET 请求检索 Data Grid 集群中的计数器列表。 

GET /rest/v2/counters/
Copy to Clipboard Toggle word wrap

2.3. 使用 Protobuf Schemas
复制链接

通过 Data Grid REST API 创建和管理 Protobuf 模式 .proto 文件。

2.3.1. 创建 Protobuf Schemas
复制链接

使用 POST 请求在 Data Grid 集群中创建 Protobuf 模式，该请求在有效负载中包含 protobuf 文件的内容。 

POST /rest/v2/schemas/{schemaName}
Copy to Clipboard Toggle word wrap

如果架构已存在，Data Grid 会返回 HTTP 409 (Conflict)。如果架构无效，要么因为语法错误，或者由于缺少其某些依赖项，Data Grid 存储架构并在响应正文中返回错误。

Data Grid 使用 schema 名称和任何错误做出响应。 

{
  "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 模式的名称。
  • 对于有效的 Protobuf 模式，error 为 null。如果 Data Grid 无法成功验证架构，它会返回错误。

如果操作成功完成，服务会返回 201 (Created)。

2.3.2. 阅读 Protobuf Schemas
复制链接

使用 GET 请求从 Data Grid 检索 Protobuf 模式。 

GET /rest/v2/schemas/{schemaName}
Copy to Clipboard Toggle word wrap

2.3.3. 更新 Protobuf Schemas
复制链接

使用 PUT 请求修改 Protobuf 模式，该模式在有效负载中包含 protobuf 文件的内容。 

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"
  }
}
Copy to Clipboard Toggle word wrap
  • name 是 Protobuf 模式的名称。
  • 对于有效的 Protobuf 模式，error 为 null。如果 Data Grid 无法成功验证架构，它会返回错误。

2.3.4. 删除 Protobuf Schemas
复制链接

从带有 DELETE 请求的 Data Grid 集群中删除 Protobuf 模式。 

DELETE /rest/v2/schemas/{schemaName}
Copy to Clipboard Toggle word wrap

如果操作成功完成，服务会返回 204 (No Content)。

2.3.5. 列出 Protobuf Schemas
复制链接

使用 GET 请求列出所有可用的 Protobuf 模式。 

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
}]
Copy to Clipboard Toggle word wrap
  • name 是 Protobuf 模式的名称。
  • 对于有效的 Protobuf 模式，error 为 null。如果 Data Grid 无法成功验证架构，它会返回错误。

2.4. 使用缓存管理器
复制链接

与 Data Grid Cache Manager 交互以获取集群和用量统计。

2.4.1. 获取基本缓存管理器信息
复制链接

使用 GET 请求检索有关缓存管理器的信息。 

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",
    "relay_node": true,
    "relay_nodes_address": [
      "CacheManagerResourceTest-NodeA-49696"
    ],
    "sites_view": [
        "LON",
        "NYC"
    ],
    "rebalancing_enabled": true
}
Copy to Clipboard Toggle word wrap
  • 版本 包含 Data Grid 版本
  • name 包含配置中定义的缓存管理器名称
  • 如果缓存管理器是集群的 协调器，则协调器为 true
  • cache_configuration_names 包含缓存管理器中定义的所有缓存配置的数组
  • cluster_NAME 包含配置中定义的集群名称
  • physical_addresses 包含与缓存管理器关联的物理网络地址
  • coordinator_address 包含集群的协调器的物理网络地址
  • cache_manager_status 缓存管理器的生命周期状态。对于可能的值，请检查 org.infinispan.lifecycle.ComponentStatus 文档
  • created 缓存的 created_cache_count 数量，排除所有内部和外部缓存
  • running_cache_count 所创建的缓存数量
  • node_address 包含缓存管理器的逻辑地址
  • cluster_members 和 cluster_members_physical_addresses 是集群成员成员的逻辑和物理地址的数组
  • cluster_size 集群中的成员数
  • defined_caches 在缓存管理器中定义的所有缓存列表，不包括私有缓存，但包括可访问的内部缓存
  • local_site 本地站点的名称。
    如果没有配置跨站点复制，Data Grid 会返回"本地"。
  • 如果节点在集群之间处理 RELAY 信息，则 relay_node 为 true。
  • relay_nodes_address 是中继节点的逻辑地址数组。
  • site _view 参与跨站点复制的站点列表。
    如果没有配置跨站点复制，Data Grid 会返回一个空列表。
  • 如果启用了重新平衡，则 rebalancing_enabled 为 true。获取此属性可能会在服务器中失败。在这种情况下，属性不会出现在有效负载中。

2.4.2. 获取集群健康状况
复制链接

使用 GET 请求检索 Data Grid 集群的健康信息。 

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"
        }
    ]
}
Copy to Clipboard Toggle word wrap

  • cluster_health 包含集群的健康状况

    • cluster_ NAME 指定配置中定义的集群名称。

    • health_status 提供以下之一：

      • DEGRADED 表示至少一个缓存处于 degraded 模式。
      • HEALTHY_REBALANCING 表示至少一个缓存处于重新平衡状态。
      • HEALTHY 表示集群中的所有缓存实例都如预期运行。
      • FAILED 表示缓存无法通过提供的配置启动。
    • number_of_nodes 显示群集成员的总数。为非集群(standalone)服务器返回值 0。
    • node_names 是所有群集成员的数组。对于单机服务器，为空。

  • cache_health contains health information per-cache

    • Status HEALTHY, DEGRADED, HEALTHY_REBALANCING 或 FAILED
    • cache_name 配置中定义的缓存名称。

2.4.3. 获取缓存管理器健康状况
复制链接

使用不需要身份验证的 GET 请求检索缓存管理器的健康状况。 

GET /rest/v2/cache-managers/{cacheManagerName}/health/status
Copy to Clipboard Toggle word wrap

Data Grid 使用 文本/plain 格式以下之一进行响应：

  • HEALTHY
  • HEALTHY_REBALANCING
  • DEGRADED
  • 失败

2.4.4. 检查 REST 端点可用性
复制链接

通过 HEAD 请求验证 Data Grid server REST 端点的可用性。 

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
Copy to Clipboard Toggle word wrap
Expand
表 2.19. Headers
标头必需/可选参数

accept

OPTIONAL

返回内容所需的格式。支持的格式为 application/json 和 application/xml。如果未提供标头，则会假定 JSON。

参考

GlobalConfiguration

2.4.6. 获取所有缓存的配置
复制链接

使用 GET 请求检索所有缓存的配置。 

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"
              }
          }
      }
  }
]
Copy to Clipboard Toggle word wrap

2.4.7. 列出可用的缓存模板
复制链接

使用 GET 请求检索所有可用的 Data Grid 缓存模板。 

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs/templates
Copy to Clipboard Toggle word wrap
提示

2.4.8. 获取缓存状态和信息
复制链接

检索缓存管理器的所有可用缓存列表，以及缓存状态和详细信息，以及 GET 请求。 

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",
  "rebalancing_enabled": true
}, {
  "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",
  "rebalancing_enabled": false
}]
Copy to Clipboard Toggle word wrap

2.4.9. 获取缓存管理器统计信息
复制链接

使用 GET 请求检索缓存管理器的统计信息。 

GET /rest/v2/cache-managers/{cacheManagerName}/stats
Copy to Clipboard Toggle word wrap

Data Grid 以 JSON 格式响应 Cache Manager 统计信息，如下例所示： 

{
    "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 为 true。
  • read_write_ratio 显示所有缓存之间的读/写比率。
  • time_since_start 显示缓存管理器启动以来的时间（以秒为单位）。
  • time_since_reset 显示上次重置缓存管理器统计信息的秒数。
  • number_of_entries 显示当前缓存中所有缓存中的条目总数。此统计仅返回本地缓存实例中的条目。
  • total_number_of_entries 显示在缓存管理器的所有缓存中执行的存储操作数量。
  • off_heap_memory_used 显示此缓存容器使用的不堆内存的数量( 以字节为单位 )。
  • data_memory_used 显示当前驱除算法估计用于所有缓存的数据的数量( 以字节为单位 )。如果没有启用驱除，则返回 0。
  • 未命中 显示所有缓存的 get （） 数。
  • remove_hits 显示所有缓存中删除点击数。
  • remove_misses 显示所有缓存间删除丢失的数量。
  • 驱除 显示所有缓存的驱除数。
  • 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 （） 命中次数。
  • 存储 为所有缓存的 put （） 操作数量提供。
  • current_number_of_entries_in_memory 显示所有缓存中当前条目总数，不包括传递的条目。
  • hit_ratio 为所有缓存提供总百分比的 hit/(hit+miss)比率。
  • 检索 显示 get （） 操作总数。

2.4.10. 关闭所有容器缓存
复制链接

使用 POST 请求关闭服务器上的 Data Grid 容器。 

POST /rest/v2/container?action=shutdown
Copy to Clipboard Toggle word wrap

Data Grid 使用 204 （无内容） 响应，然后关闭容器中的所有缓存。服务器保持使用活动端点和集群运行，但对容器资源的 REST 调用会导致 503 Service Unavailable 响应。

注意

此方法主要用于 Data Grid Operator。其预期是，在调用此端点后，服务器进程将很快终止。调用此方法后，就无法重新启动容器状态。

2.4.11. 为所有缓存启用重新平衡
复制链接

为所有缓存打开自动重新平衡。 

POST /rest/v2/cache-managers/{cacheManagerName}?action=enable-rebalancing
Copy to Clipboard Toggle word wrap

2.4.12. 为所有缓存禁用重新平衡
复制链接

为所有缓存关闭自动重新平衡。 

POST /rest/v2/cache-managers/{cacheManagerName}?action=disable-rebalancing
Copy to Clipboard Toggle word wrap

2.4.13. 备份 Data Grid Cache Manager
复制链接

创建备份存档 application/zip，其中包含当前存储在缓存管理器中的资源（缓存、缓存模板、计数器、Protobuf 模式、服务器任务等）。 

POST /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
Copy to Clipboard Toggle word wrap

如果存在具有相同名称的备份，服务会使用 409 (Conflict) 响应。如果 directory 参数无效，服务会返回 400 (Bad Request)。202 响应表示接受备份请求进行处理。

（可选）包括带有您包含备份操作的参数的 JSON 有效负载，如下所示：

Expand
表 2.20. JSON 参数
键必需/可选值

目录

OPTIONAL

指定要创建并存储备份存档的服务器上的位置。

resources

OPTIONAL

以 JSON 格式指定要备份的资源。默认为备份所有资源。如果您指定了一个或多个资源，则 Data Grid 只备份这些资源。如需更多信息，请参阅 资源参数 表。

Expand
表 2.21. 资源参数
键必需/可选值

缓存

OPTIONAL

为所有缓存指定要备份的缓存名称的数组。

cache-configs

OPTIONAL

为所有模板指定要备份的缓存模板数组，或指定为 *。

计数器

OPTIONAL

为所有计数器定义一系列计数器名称来备份或 *。

proto-schemas

OPTIONAL

定义用于备份的 Protobuf 模式名称的数组，或为所有模式定义 *。

tasks

OPTIONAL

指定一组服务器任务来备份，或为所有任务指定 *。

以下示例在指定目录中创建一个名为 [cache1,cache2] 的所有计数器和缓存的备份存档： 

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

2.4.14. 列出备份
复制链接

检索正在进行、完成或失败的所有备份操作的名称。 

GET /rest/v2/cache-managers/{cacheManagerName}/backups
Copy to Clipboard Toggle word wrap

Data Grid 使用所有备份名称的数组响应，如下例所示： 

["backup1", "backup2"]
Copy to Clipboard Toggle word wrap

2.4.15. 检查备份可用性
复制链接

验证备份操作是否已完成。 

HEAD /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
Copy to Clipboard Toggle word wrap

200 响应表示备份存档可用。202 响应表示备份操作正在进行。

2.4.16. 下载备份归档
复制链接

从服务器下载备份存档。 

GET /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
Copy to Clipboard Toggle word wrap

200 响应表示备份存档可用。202 响应表示备份操作正在进行。

2.4.17. 删除备份归档
复制链接

从服务器中删除备份存档。 

DELETE /rest/v2/cache-managers/{cacheManagerName}/backups/{backupName}
Copy to Clipboard Toggle word wrap

204 响应表示删除了备份存档。202 响应表示备份操作正在进行中，但在操作完成后会被删除。

2.4.18. 从备份归档中恢复 Data Grid 资源
复制链接

从备份存档恢复 Data Grid 资源。提供的 {restoreName} 用于跟踪恢复进度，独立于正在恢复的备份文件的名称。

重要

只有在备份存档中的容器名称与 {cacheManagerName} 匹配时才可以恢复资源。 

POST /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
Copy to Clipboard Toggle word wrap

202 响应表示接受恢复请求进行处理。

2.4.18.1. 在 Data Grid Server 上从备份归档中恢复
复制链接

将 application/json 内容类型与您的 POST 请求一起使用，以从服务器上可用的存档备份。

Expand
表 2.22. JSON 参数
键必需/可选值

位置

必需

指定要恢复的备份存档的路径。

resources

OPTIONAL

以 JSON 格式指定要恢复的资源。默认为恢复所有资源。如果您指定了一个或多个资源，则 Data Grid 只恢复这些资源。如需更多信息，请参阅 资源参数 表。

Expand
表 2.23. 资源参数
键必需/可选值

缓存

OPTIONAL

为所有缓存指定要备份的缓存名称的数组。

cache-configs

OPTIONAL

为所有模板指定要备份的缓存模板数组，或指定为 *。

计数器

OPTIONAL

为所有计数器定义一系列计数器名称来备份或 *。

proto-schemas

OPTIONAL

定义用于备份的 Protobuf 模式名称的数组，或为所有模式定义 *。

tasks

OPTIONAL

指定一组服务器任务来备份，或为所有任务指定 *。

以下示例从服务器上的备份归档中恢复所有计数器： 

{
  "location": "/path/accessible/to/the/server/backup-to-restore.zip",
  "resources": {
    "counters": ["*"]
  }
}
Copy to Clipboard Toggle word wrap
2.4.18.2. 从本地备份归档中恢复
复制链接

将 multipart/form-data 内容类型与您的 POST 请求一起使用，将本地备份存档上传到服务器。

Expand
表 2.24. 格式数据
参数Content-Type必需/可选值

backup

application/zip

必需

指定要恢复的备份归档的字节。

resources

application/json,text/plain

OPTIONAL

定义请求参数的 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--
Copy to Clipboard Toggle word wrap

2.4.19. 列出恢复
复制链接

检索正在进行、完成或失败的所有恢复请求的名称。 

GET /rest/v2/cache-managers/{cacheManagerName}/restores
Copy to Clipboard Toggle word wrap

Data Grid 使用所有恢复名称的数组响应，如下例所示： 

["restore1", "restore2"]
Copy to Clipboard Toggle word wrap

2.4.20. 检查恢复进度
复制链接

验证恢复操作是否已完成。 

HEAD /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
Copy to Clipboard Toggle word wrap

201 (Created) 响应表示恢复操作已完成。202 (Accepted) 响应表示备份操作正在进行中。

2.4.21. 删除恢复元数据
复制链接

删除从服务器恢复请求的元数据。此操作会删除与恢复请求关联的所有元数据，但不会删除任何恢复的内容。如果删除了请求元数据，您可以使用请求名称来执行后续恢复操作。 

DELETE /rest/v2/cache-managers/{cacheManagerName}/restores/{restoreName}
Copy to Clipboard Toggle word wrap

204 (No Content) 响应表示删除恢复元数据。202 (Accepted) 响应表示恢复操作正在进行中，并在操作完成后删除。

2.4.22. 侦听容器配置事件
复制链接

使用 Server-Sent Events 接收有关配置更改的事件。event 值将是 create-cache,remove-cache,update-cache,create-template,remove-template 或 update-template 之一。data 值将包含创建的实体的声明配置。删除事件将仅包含已删除实体的名称。 

GET /rest/v2/container/config?action=listen
Copy to Clipboard Toggle word wrap
Expand
表 2.25. Headers
标头必需/可选参数

accept

OPTIONAL

设置所需的格式以返回内容。支持的格式为 application/yaml、application/json 和 application/xml。默认为 application/yaml。如需更多信息，请参阅 Accept。

2.4.23. 使用缓存管理器进行跨站点操作
复制链接

对缓存管理器执行跨站点操作，将操作应用到所有缓存。

2.4.23.1. 获取备份位置状态
复制链接

使用 GET 请求从缓存管理器检索所有备份位置的状态。 

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"
      ],
      "mixed": [
         "CACHE_3"
      ]
   }
}
Copy to Clipboard Toggle word wrap
Expand
表 2.26. 返回的状态
值描述

online

本地集群中的所有节点都有一个带有备份位置的跨站点视图。

离线

本地集群中的节点没有带有备份位置的跨站点视图。

mixed

本地集群中的某些节点具有带有备份位置的跨站点视图，本地集群中的其他节点没有跨站点视图。响应指示每个节点的状态。 

GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{site}
Copy to Clipboard Toggle word wrap

返回单个备份位置的状态。

2.4.23.2. 离线备份位置
复制链接

使用 ?action= take-offline 参数使备份位置离线。 

POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=take-offline
Copy to Clipboard Toggle word wrap
2.4.23.3. 在线备份位置
复制链接

使用 ?action=bring-online 参数使备份位置上线。 

POST /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=bring-online
Copy to Clipboard Toggle word wrap
2.4.23.4. 检索状态传输模式
复制链接

使用 GET 请求检查状态传输模式。 

GET /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode
Copy to Clipboard Toggle word wrap
2.4.23.5. 设置状态传输模式
复制链接

使用 ?action=set 参数配置状态传输模式。 

POST /rest/v2/caches/{cacheName}/x-site/backups/{site}/state-transfer-mode?action=set&mode={mode}
Copy to Clipboard Toggle word wrap
2.4.23.6. 开始状态传输
复制链接

使用 ?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.23.7. 取消状态传输
复制链接

使用 ?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 Servers
复制链接

监控和管理数据网格服务器实例。

2.5.1. 检索基本服务器信息
复制链接

查看有关使用 GET 请求的数据网格服务器的基本信息。 

GET /rest/v2/server
Copy to Clipboard Toggle word wrap

Data Grid 使用 JSON 格式的服务器名称、代码名称和版本响应，如下例所示： 

{
  "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
Copy to Clipboard Toggle word wrap

Data Grid 使用为服务器配置的缓存管理器名称的数组响应。

注意

Data Grid 目前仅支持每台服务器有一个缓存管理器。

2.5.3. 在 Ignore List 中添加缓存
复制链接

配置 Data Grid，以临时从客户端请求中排除特定的缓存。发送包括缓存管理器名称和缓存名称的空 POST 请求。 

POST /rest/v2/server/ignored-caches/{cache-manager}/{cache}
Copy to Clipboard Toggle word wrap

如果找不到缓存或缓存管理器，则 data Grid 会成功添加到忽略列表或 404 (Not Found) 中带有 204 （无内容 ）的响应。

注意

Data Grid 目前仅支持每台服务器有一个缓存管理器。为了未来兼容性，您必须在请求中提供缓存管理器名称。

2.5.4. 从 Ignore Lists 中删除缓存
复制链接

使用 DELETE 请求从忽略列表中删除缓存。 

DELETE /rest/v2/server/ignored-caches/{cache-manager}/{cache}
Copy to Clipboard Toggle word wrap

如果未找到缓存或缓存管理器，则 data Grid 会成功从忽略列表中移除缓存或 404 (Not Found) 时响应 204 （无内容 ）。

2.5.5. 确认 Ignored 缓存
复制链接

确认使用 GET 请求会忽略缓存。 

GET /rest/v2/server/ignored-caches/{cache-manager}
Copy to Clipboard Toggle word wrap

2.5.6. 获取服务器配置
复制链接

使用 GET 请求检索 Data Grid 服务器配置。 

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"
            }
        }
    }
}
Copy to Clipboard Toggle word wrap

2.5.7. 获取环境变量
复制链接

使用 GET 请求检索 Data Grid 服务器的所有环境变量。 

GET /rest/v2/server/env
Copy to Clipboard Toggle word wrap

2.5.8. 获取 JVM 内存详情
复制链接

使用 GET 请求检索 Data Grid 服务器的 JVM 内存用量信息。 

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
Copy to Clipboard Toggle word wrap

Data Grid 使用当前线程转储以 文本/plain 格式进行响应。

2.5.10. 获取 Data Grid Servers 的诊断报告
复制链接

使用 GET 请求检索 Data Grid 服务器的聚合报告。 

GET /rest/v2/server/report
Copy to Clipboard Toggle word wrap

Data Grid 使用 tar.gz 存档响应，其中包含有关 Data Grid 服务器和主机的诊断信息的聚合报告。除了配置和日志文件外，报告还提供有关 CPU、内存、打开文件、网络套接字和路由、线程的详细信息。

2.5.11. 停止 Data Grid 服务器
复制链接

使用 POST 请求停止 Data Grid 服务器。 

POST /rest/v2/server?action=stop
Copy to Clipboard Toggle word wrap

Data Grid 使用 204 （无内容） 响应，然后停止运行。

2.6. 使用 Data Grid 集群
复制链接

监控和执行 Data Grid 集群上的管理任务。

2.6.1. 停止 Data Grid 集群
复制链接

使用 POST 请求关闭整个 Data Grid 集群。 

POST /rest/v2/cluster?action=stop
Copy to Clipboard Toggle word wrap

Data Grid 使用 204 （无内容） 响应，然后执行整个集群的有序关闭。

2.6.2. 在集群中停止特定数据网格服务器
复制链接

使用 GET 请求和 ?action=stop&server 参数在 Data Grid 集群中关闭一个或多个特定服务器。 

POST /rest/v2/cluster?action=stop&server={server1_host}&server={server2_host}
Copy to Clipboard Toggle word wrap

Data Grid 使用 204 （无内容） 做出响应。

2.6.3. 备份 Data Grid 集群
复制链接

创建备份存档 application/zip，其中包含当前存储在集群的缓存容器中的资源（缓存、模板、计数器、Protobuf 模式、服务器任务等）。 

POST /rest/v2/cluster/backups/{backupName}
Copy to Clipboard Toggle word wrap

（可选）包括带有您包含备份操作的参数的 JSON 有效负载，如下所示：

Expand
表 2.27. JSON 参数
键必需/可选值

目录

OPTIONAL

指定要创建并存储备份存档的服务器上的位置。

如果备份操作成功完成，服务会返回 202 (Accepted)。如果存在具有相同名称的备份，服务会返回 409 (Conflict)。如果 directory 参数无效，服务会返回 400 (Bad Request)。

2.6.4. 列出备份
复制链接

检索正在进行、完成或失败的所有备份操作的名称。 

GET /rest/v2/cluster/backups
Copy to Clipboard Toggle word wrap

Data Grid 使用所有备份名称的数组响应，如下例所示： 

["backup1", "backup2"]
Copy to Clipboard Toggle word wrap

2.6.5. 检查备份可用性
复制链接

验证备份操作是否已完成。200 响应表示备份存档可用。202 响应表示备份操作正在进行。 

HEAD /rest/v2/cluster/backups/{backupName}
Copy to Clipboard Toggle word wrap

2.6.6. 下载备份归档
复制链接

从服务器下载备份存档。200 响应表示备份存档可用。202 响应表示备份操作正在进行。 

GET /rest/v2/cluster/backups/{backupName}
Copy to Clipboard Toggle word wrap

2.6.7. 删除备份归档
复制链接

从服务器中删除备份存档。204 响应表示删除了备份存档。202 响应表示备份操作正在进行中，但在操作完成后会被删除。 

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}
Copy to Clipboard Toggle word wrap

202 响应表示接受恢复请求进行处理。

2.6.8.1. 在 Data Grid Server 上从备份归档中恢复
复制链接

将 application/json 内容类型与您的 POST 请求一起使用，以从服务器上可用的存档备份。

Expand
表 2.28. JSON 参数
键必需/可选值

位置

必需

指定要恢复的备份存档的路径。

resources

OPTIONAL

以 JSON 格式指定要恢复的资源。默认为恢复所有资源。如果您指定了一个或多个资源，则 Data Grid 只恢复这些资源。如需更多信息，请参阅 资源参数 表。

Expand
表 2.29. 资源参数
键必需/可选值

缓存

OPTIONAL

为所有缓存指定要备份的缓存名称的数组。

cache-configs

OPTIONAL

为所有模板指定要备份的缓存模板数组，或指定为 *。

计数器

OPTIONAL

为所有计数器定义一系列计数器名称来备份或 *。

proto-schemas

OPTIONAL

定义用于备份的 Protobuf 模式名称的数组，或为所有模式定义 *。

tasks

OPTIONAL

指定一组服务器任务来备份，或为所有任务指定 *。

以下示例从服务器上的备份归档中恢复所有计数器： 

{
  "location": "/path/accessible/to/the/server/backup-to-restore.zip",
  "resources": {
    "counters": ["*"]
  }
}
Copy to Clipboard Toggle word wrap
2.6.8.2. 从本地备份归档中恢复
复制链接

将 multipart/form-data 内容类型与您的 POST 请求一起使用，将本地备份存档上传到服务器。

Expand
表 2.30. 格式数据
参数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--
Copy to Clipboard Toggle word wrap

2.6.9. 列出恢复
复制链接

检索正在进行、完成或失败的所有恢复请求的名称。 

GET /rest/v2/cluster/restores
Copy to Clipboard Toggle word wrap

Data Grid 使用所有恢复名称的数组响应，如下例所示： 

["restore1", "restore2"]
Copy to Clipboard Toggle word wrap

2.6.10. 检查恢复进度
复制链接

验证恢复操作是否已完成。 

HEAD /rest/v2/cluster/restores/{restoreName}
Copy to Clipboard Toggle word wrap

201 (Created) 响应表示恢复操作已完成。202 响应表示备份操作正在进行。

2.6.11. 删除恢复元数据
复制链接

删除从服务器恢复请求的元数据。此操作会删除与恢复请求关联的所有元数据，但不会删除任何恢复的内容。如果删除了请求元数据，您可以使用请求名称来执行后续恢复操作。 

DELETE /rest/v2/cluster/restores/{restoreName}
Copy to Clipboard Toggle word wrap

204 响应表示已删除恢复元数据。202 响应表示恢复操作正在进行中，操作完成后会被删除。

2.7. Data Grid Server 日志配置
复制链接

在运行时查看和修改 Data Grid 集群上的日志配置。

2.7.1. 列出日志记录附加器
复制链接

使用 GET 请求查看所有配置的附加程序列表。 

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"
  }
}
Copy to Clipboard Toggle word wrap

2.7.2. 列出日志记录器
复制链接

使用 GET 请求查看所有配置的日志记录器的列表。 

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" ]
} ]
Copy to Clipboard Toggle word wrap

2.7.3. 创建/修改日志记录器
复制链接

创建新的日志记录器，或使用 PUT 请求修改现有日志记录器。 

PUT /rest/v2/logging/loggers/{loggerName}?level={level}&appender={appender}&appender={appender}...
Copy to Clipboard Toggle word wrap

Data Grid 将 {loggerName} 标识的日志记录器级别设置为 {level}。（可选）可以为日志记录器设置一个或多个附加器。如果没有指定附加器，则使用根日志记录器中指定的附加器。

如果操作成功完成，服务会返回 204 (No Content)。

2.7.4. 删除日志记录器
复制链接

使用 DELETE 请求删除现有日志记录器。 

DELETE /rest/v2/logging/loggers/{loggerName}
Copy to Clipboard Toggle word wrap

Data Grid 移除了 {loggerName} 标识的日志记录器，有效地恢复到使用根日志记录器配置。

如果操作成功处理，服务会返回响应代码 204 (No Content)。

2.8. 使用服务器任务
复制链接

检索、执行和上传 Data Grid 服务器任务。

2.8.1. 检索服务器任务信息
复制链接

使用 GET 请求查看有关可用服务器任务的信息。 

GET /rest/v2/tasks
Copy to Clipboard Toggle word wrap
Expand
表 2.31. 请求参数
参数必需/可选值

type

OPTIONAL

用户: 将排除结果中的内部(admin)任务

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"
  }
]
Copy to Clipboard Toggle word wrap

2.8.2. 执行任务
复制链接

使用 POST 请求执行任务名称，以及前缀为 param 的必要参数的任务。 

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
Copy to Clipboard Toggle word wrap

2.9. 使用 Data Grid Security
复制链接

查看和修改安全信息。

2.9.1. 检索用户的 ACL
复制链接

查看有关用户主体和 access-control 列表的信息。 

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"
    ]
  }
}
Copy to Clipboard Toggle word wrap

2.9.2. 刷新 ACL 缓存
复制链接

清空集群中的 access-control 列表缓存。 

POST /rest/v2/security/cache?action=flush
Copy to Clipboard Toggle word wrap

2.9.3. 检索可用角色
复制链接

查看服务器中定义的所有可用角色。 

GET /rest/v2/security/roles
Copy to Clipboard Toggle word wrap

Data Grid 使用可用角色列表进行响应。如果启用了授权，则只有具有 ADMIN 权限的用户才能调用此 API。 

["observer","application","admin","monitor","deployer"]
Copy to Clipboard Toggle word wrap

2.9.4. 检索主体的角色
复制链接

查看映射到主体的所有角色。 

GET /rest/v2/security/roles/some_principal
Copy to Clipboard Toggle word wrap

Data Grid 使用指定主体的可用角色列表进行响应。主体不需要在使用的域中。 

["observer"]
Copy to Clipboard Toggle word wrap

2.9.5. 为主体授予角色
复制链接

向主体授予一个或多个新角色。 

PUT /rest/v2/security/roles/some_principal?action=grant&role=role1&role=role2
Copy to Clipboard Toggle word wrap
Expand
表 2.32. 请求参数
参数必需/可选值

role

必需

角色的名称

2.9.6. 拒绝角色到主体
复制链接

删除之前授予主体的一个或多个角色。 

PUT /rest/v2/security/roles/some_principal?action=deny&role=role1&role=role2
Copy to Clipboard Toggle word wrap
Expand
表 2.33. 请求参数
参数必需/可选值

role

必需

角色的名称

法律通告
复制链接

Copyright © 2023 Red Hat, Inc.
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.
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2026 Red Hat