Region Endpoints

This topic provides links to information about VMware Tanzu GemFire regions. Tanzu GemFire logically groups data within its cache in Tanzu GemFire Regions. Regions stores data as entries, which are key-value pairs. Using the REST APIs you can read, add, update, and delete region data.

For more in information about working with regions, see Data Regions.

• GET /gemfire-api/v1

  List all available resources (regions) in the Tanzu GemFire cluster.

• GET /gemfire-api/v1/{region}

  Read data for the region. The optional limit URL query parameter specifies the number of values from the Region that will be returned. The default limit is 50. If the user specifies a limit of “ALL”, then all entry values for the region will be returned.

• GET /gemfire-api/v1/{region}/keys

  List all keys for the specified region.

• GET /gemfire-api/v1/{region}/{key}

  Read data for a specific key in the region.

• GET /gemfire-api/v1/{region}/{key1},{key2},…,{keyN}

  Read data for multiple keys in the region.

• HEAD /gemfire-api/v1/{region}

  An HTTP HEAD request that returns region’s size (number of entries) within the HEADERS, which is a response without the content-body. Region size is specified in the pre-defined header named “Resource-Count”.

• POST /gemfire-api/v1/{region}?key=<key>

  Create (put-if-absent) data in region.

• PUT /gemfire-api/v1/{region}/{key}

  Update or insert (put) data for key in region.

• PUT /gemfire-api/v1/{region}/{key1},{key2},…{keyN}

  Update or insert (put) data for multiple keys in the region.

• PUT /gemfire-api/v1/{region}/{key}?op=REPLACE

  Update (replace) data with keys if and only if the keys exists in region. The Keys must be present in the Region for the update to occur.

• PUT /gemfire-api/v1/{region}/{key}?op=CAS

  Update (compare-and-set) value having key with a new value if and only if the “@old” value sent matches the current value having key in region.

• DELETE /gemfire-api/v1/{region}

  Delete all entries in the region.

• DELETE /gemfire-api/v1/{region}/{key}

  Delete entry for specified key in the region.

• DELETE /gemfire-api/v1/{region}/{key1},{key2},…{keyN}

  Delete entries for multiple keys in the region.