Versions Compared

Old Version 55

changes.mady.by.user Joris Melchior

Saved on

compared with

New Version 56

changes.mady.by.user Owen Nichols

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: automatically generated from 1.10.0 by update-management-wiki.sh

Apache Geode Management REST API

REST API and interface to manage Geode components.
More information: http://geode.apache.org
Contact Info: dev@geode.apache.org
Version: v2
BasePath:

Table of Contents

Region Management

Create Region 

...

/management/experimental/

...

Method: POST

Headers: Authorization

Permission Required: DATA:MANAGE

Code Block
languageyml
titleSample Request
{
	"name": "regionA",
	"type": "REPLICATE"
}

Types supported by this Rest API is defined in RegionType:

Code Block
languagejava
titleRequest Body
public enum RegionType {
  PARTITION,
  PARTITION_REDUNDANT,
  PARTITION_PERSISTENT,
  PARTITION_REDUNDANT_PERSISTENT,
  PARTITION_OVERFLOW,
  PARTITION_REDUNDANT_OVERFLOW,
  PARTITION_PERSISTENT_OVERFLOW,
  PARTITION_REDUNDANT_PERSISTENT_OVERFLOW,
  PARTITION_HEAP_LRU,
  PARTITION_REDUNDANT_HEAP_LRU,

  PARTITION_PROXY,
  PARTITION_PROXY_REDUNDANT,

  REPLICATE,
  REPLICATE_PERSISTENT,
  REPLICATE_OVERFLOW,
  REPLICATE_PERSISTENT_OVERFLOW,
  REPLICATE_HEAP_LRU,

  REPLICATE_PROXY
}

...

Code Block
languagejs
titleSuccess Response
{
	"memberStatuses": [{
		"memberName": "server-2",
		"success": true,
		"message": "Region successfully created."
	}, {
		"memberName": "server-3",
		"success": true,
		"message": "Region successfully created."
	}],
	"statusCode": "OK",
	"statusMessage": "Successfully updated configuration for cluster.",
	"uri": "/management/experimental/regions/regionA"
}

...

Code Block
languageyml
titleName conflict
{
   "statusMessage" : "Region 'regionA' already exists on member(s) server-2.",
   "statusCode" : "ENTITY_EXISTS"
}

...

Code Block
languageyml
titleError Response - empty required parameter
{
  "statusCode" : "ILLEGAL_ARGUMENT",
  "statusMessage" : "Region identifier is required.",
}
Code Block
languageyml
titleError Response - invalid parameter
{
  "statusCode" : "ILLEGAL_ARGUMENT",
  "statusMessage" : "Region names may not begin with a double-underscore: __Foo.",
}

Given an unknown input attribute, for example: foobar in: 

curl -d '{"name":"replicate2","type":"REPLICATE","foobar":"value"}' -H 'Content-Type: application/json' http://localhost:7070/management/experimental/regions

the output is:

{

   "statusCode" : "ILLEGAL_ARGUMENT",

   "statusMessage" : "JSON parse error: Unrecognized field \"foobar\" (class org.apache.geode.cache.configuration.Region), not marked as ignorable; nested exception is com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field \"foobar\" (class org.apache.geode.cache.configuration.Region), not marked as ignorable (9 known properties: \"indexes\", \"groups\", \"type\", \"regionAttributes\", \"customRegionElements\", \"regions\", \"entries\", \"name\", \"group\"])\n at [Source: (PushbackInputStream); line: 1, column: 59] (through reference chain: org.apache.geode.cache.configuration.Region[\"foobar\"])"

}

api-docs
Apache License, version 2.0
http://www.apache.org/licenses/

Access

Methods

...

Table of Contents

GatewayManagementController

MemberManagementController

PdxManagementController

PingManagementController

RebalanceOperationController

RegionManagementController

GatewayManagementController

Up 
post /experimental/gateways/receivers
createGatewayReceiver (createGatewayReceiverUsingPOST)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GatewayReceiverConfig (required)
Body Parameter — gatewayReceiverConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
get /experimental/gateways/receivers
listGatewayReceivers (listGatewayReceiversUsingGET)

Query parameters

group (optional)
Query Parameter — group

Return type

ClusterManagementListResult«GatewayReceiverConfig,GatewayReceiverInfo»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "startPort" : "startPort",
      "gatewayTransportFilters" : [ {
        "className" : "className",
        "parameters" : [ {
          "string" : "string",
          "name" : "name"
        }, {
          "string" : "string",
          "name" : "name"
        } ]
      }, {
        "className" : "className",
        "parameters" : [ {
          "string" : "string",
          "name" : "name"
        }, {
          "string" : "string",
          "name" : "name"
        } ]
      } ],
      "hostnameForSenders" : "hostnameForSenders",
      "manualStart" : true,
      "groups" : [ "groups", "groups" ],
      "maximumTimeBetweenPings" : "maximumTimeBetweenPings",
      "endPort" : "endPort",
      "uri" : "uri",
      "bindAddress" : "bindAddress",
      "socketBufferSize" : "socketBufferSize",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
      "running" : true,
      "port" : 0,
      "hostnameForSenders" : "hostnameForSenders",
      "memberName" : "memberName",
      "bindAddress" : "bindAddress",
      "senderCount" : 6
    }, {
      "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
      "running" : true,
      "port" : 0,
      "hostnameForSenders" : "hostnameForSenders",
      "memberName" : "memberName",
      "bindAddress" : "bindAddress",
      "senderCount" : 6
    } ]
  }, {
    "config" : {
      "startPort" : "startPort",
      "gatewayTransportFilters" : [ {
        "className" : "className",
        "parameters" : [ {
          "string" : "string",
          "name" : "name"
        }, {
          "string" : "string",
          "name" : "name"
        } ]
      }, {
        "className" : "className",
        "parameters" : [ {
          "string" : "string",
          "name" : "name"
        }, {
          "string" : "string",
          "name" : "name"
        } ]
      } ],
      "hostnameForSenders" : "hostnameForSenders",
      "manualStart" : true,
      "groups" : [ "groups", "groups" ],
      "maximumTimeBetweenPings" : "maximumTimeBetweenPings",
      "endPort" : "endPort",
      "uri" : "uri",
      "bindAddress" : "bindAddress",
      "socketBufferSize" : "socketBufferSize",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
      "running" : true,
      "port" : 0,
      "hostnameForSenders" : "hostnameForSenders",
      "memberName" : "memberName",
      "bindAddress" : "bindAddress",
      "senderCount" : 6
    }, {
      "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
      "running" : true,
      "port" : 0,
      "hostnameForSenders" : "hostnameForSenders",
      "memberName" : "memberName",
      "bindAddress" : "bindAddress",
      "senderCount" : 6
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«GatewayReceiverConfig,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

MemberManagementController

Up 
get /experimental/members/{id}
getMember (getMemberUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementListResult«MemberConfig,MemberInformation»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "groups" : [ "groups", "groups" ],
      "id" : "id",
      "uri" : "uri"
    },
    "runtimeInfo" : [ {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    }, {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    } ]
  }, {
    "config" : {
      "groups" : [ "groups", "groups" ],
      "id" : "id",
      "uri" : "uri"
    },
    "runtimeInfo" : [ {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    }, {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«MemberConfig,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
get /experimental/members
listMembers (listMembersUsingGET)

Query parameters

group (optional)
Query Parameter — group
id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«MemberConfig,MemberInformation»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "groups" : [ "groups", "groups" ],
      "id" : "id",
      "uri" : "uri"
    },
    "runtimeInfo" : [ {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    }, {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    } ]
  }, {
    "config" : {
      "groups" : [ "groups", "groups" ],
      "id" : "id",
      "uri" : "uri"
    },
    "runtimeInfo" : [ {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    }, {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "host" : "host",
      "maxHeapSize" : 2,
      "workingDirPath" : "workingDirPath",
      "id" : "id",
      "clientCount" : 5,
      "httpServicePort" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      }, {
        "running" : true,
        "port" : 1,
        "maxThreads" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groups" : "groups",
      "serverBindAddress" : "serverBindAddress",
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPort" : 3,
      "heapUsage" : 2,
      "initHeapSize" : 9,
      "logFilePath" : "logFilePath",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
      "statArchiveFilePath" : "statArchiveFilePath",
      "status" : "status"
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«MemberConfig,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found

...

PdxManagementController

Up 
post /experimental/configurations/pdx
configure PDX (configurePdxUsingPOST)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body Pdx (required)
Body Parameter — pdxType

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK. ClusterManagementResult

201

Created

401

Invalid Username or Password.

403

Insufficient privileges for operation.

404

Not Found

500

GemFire throws an error or exception.

...

PingManagementController

Up 
get /experimental/ping
ping (pingUsingGET)

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

...

RebalanceOperationController

Up 
get /experimental/operations/rebalances/{id}
checkRebalanceStatus (checkRebalanceStatusUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementOperationStatusResult«RebalanceResult»

Example data

Content-Type: application/json
{
  "result" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 7,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 3,
      "primaryTransfersCompleted" : 9,
      "bucketTransferBytes" : 5
    }, {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 7,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 3,
      "primaryTransfersCompleted" : 9,
      "bucketTransferBytes" : 5
    } ],
    "statusMessage" : "statusMessage"
  },
  "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "uri" : "uri",
  "operator" : "operator",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementOperationStatusResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
get /experimental/operations/rebalances
listRebalances (listRebalancesUsingGET)

Return type

ClusterManagementListOperationsResult«RebalanceResult»

Example data

Content-Type: application/json
{
  "result" : [ {
    "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "uri" : "uri",
    "operator" : "operator",
    "statusMessage" : "statusMessage",
    "statusCode" : "ILLEGAL_ARGUMENT"
  }, {
    "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "uri" : "uri",
    "operator" : "operator",
    "statusMessage" : "statusMessage",
    "statusCode" : "ILLEGAL_ARGUMENT"
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListOperationsResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
post /experimental/operations/rebalances
startRebalance (startRebalanceUsingPOST)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RebalanceOperation (required)
Body Parameter — operation

Return type

ClusterManagementOperationResult«RebalanceResult»

Example data

Content-Type: application/json
{
  "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "uri" : "uri",
  "operator" : "operator",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementOperationResult«RebalanceResult»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

RegionManagementController

Up 
post /experimental/regions
create regions (createRegionUsingPOST)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RegionConfig (required)
Body Parameter — regionConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK. ClusterManagementResult

201

Created

401

Invalid Username or Password.

403

Insufficient privileges for operation.

404

Not Found

409

Region already exist.

500

GemFire throws an error or exception.

...

Up 
delete /experimental/regions/{id}
deleteRegion (deleteRegionUsingDELETE)

Path parameters

id (required)
Path Parameter — id

Query parameters

group (optional)
Query Parameter — group

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

...

Up 
get /experimental/regions/{regionName}/indexes/{id}
getIndex (getIndexUsingGET)

Path parameters

id (required)
Path Parameter — id
regionName (required)
Path Parameter — regionName

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "expression" : "expression",
      "fromClause" : "fromClause",
      "imports" : "imports",
      "keyIndex" : true,
      "regionName" : "regionName",
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  }, {
    "config" : {
      "expression" : "expression",
      "fromClause" : "fromClause",
      "imports" : "imports",
      "keyIndex" : true,
      "regionName" : "regionName",
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
get /experimental/regions/{id}
getRegion (getRegionUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementListResult«RegionConfig,RuntimeRegionInfo»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "regionAttributes" : {
        "enableAsyncConflation" : true,
        "hubId" : "hubId",
        "isLockGrantor" : true,
        "membershipAttributes" : {
          "requiredRoles" : [ {
            "name" : "name"
          }, {
            "name" : "name"
          } ],
          "lossAction" : "lossAction",
          "resumptionAction" : "resumptionAction"
        },
        "concurrencyChecksEnabled" : true,
        "asyncEventQueueIds" : "asyncEventQueueIds",
        "evictionAttributes" : {
          "lruHeapPercentage" : {
            "action" : "LOCAL_DESTROY",
            "className" : "className",
            "parameters" : [ {
              "string" : "string",
              "name" : "name"
            }, {
              "string" : "string",
              "name" : "name"
            } ]
          },
          "lruEntryCount" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum"
          },
          "lruMemorySize" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum",
            "className" : "className",
            "parameters" : [ null, null ]
          }
        },
        "entryIdleTime" : {
          "action" : "action",
          "timeout" : "timeout"
        },
        "dataPolicy" : "EMPTY",
        "initialCapacity" : "initialCapacity",
        "diskWriteAttributes" : {
          "rollOplogs" : "rollOplogs",
          "synchronousWrites" : { },
          "maxOplogSize" : "maxOplogSize",
          "asynchronousWrites" : {
            "bytesThreshold" : "bytesThreshold",
            "timeInterval" : "timeInterval"
          }
        },
        "gatewaySenderIds" : "gatewaySenderIds",
        "enableSubscriptionConflation" : true,
        "cacheListeners" : [ {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        }, {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        } ],
        "concurrencyLevel" : "concurrencyLevel",
        "ignoreJta" : true,
        "scope" : "DISTRIBUTED_ACK",
        "persistBackup" : true,
        "offHeap" : true,
        "id" : "id",
        "refid" : "refid",
        "poolName" : "poolName",
        "mirrorType" : "KEYS",
        "earlyAck" : true,
        "statisticsEnabled" : true,
        "diskDirs" : {
          "diskDirs" : [ {
            "dirSize" : "dirSize",
            "content" : "content"
          }, {
            "dirSize" : "dirSize",
            "content" : "content"
          } ]
        },
        "indexUpdateType" : "ASYNCHRONOUS",
        "multicastEnabled" : true,
        "diskStoreName" : "diskStoreName",
        "diskSynchronous" : true,
        "loadFactor" : "loadFactor",
        "partitionAttributes" : {
          "redundantCopies" : "redundantCopies",
          "startupRecoveryDelay" : "startupRecoveryDelay",
          "recoveryDelay" : "recoveryDelay",
          "localMaxMemory" : "localMaxMemory",
          "totalNumBuckets" : "totalNumBuckets",
          "colocatedWith" : "colocatedWith",
          "fixedPartitionAttributes" : [ {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          }, {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          } ],
          "totalMaxMemory" : "totalMaxMemory",
          "partitionListeners" : [ null, null ]
        },
        "enableGateway" : true,
        "subscriptionAttributes" : {
          "interestPolicy" : "interestPolicy"
        },
        "keyConstraint" : "keyConstraint",
        "cloningEnabled" : true,
        "publisher" : true,
        "valueConstraint" : "valueConstraint",
        "compressor" : {
          "className" : "className"
        }
      },
      "indexes" : [ {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      }, {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      } ],
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 0,
      "memberName" : "memberName"
    }, {
      "entryCount" : 0,
      "memberName" : "memberName"
    } ]
  }, {
    "config" : {
      "regionAttributes" : {
        "enableAsyncConflation" : true,
        "hubId" : "hubId",
        "isLockGrantor" : true,
        "membershipAttributes" : {
          "requiredRoles" : [ {
            "name" : "name"
          }, {
            "name" : "name"
          } ],
          "lossAction" : "lossAction",
          "resumptionAction" : "resumptionAction"
        },
        "concurrencyChecksEnabled" : true,
        "asyncEventQueueIds" : "asyncEventQueueIds",
        "evictionAttributes" : {
          "lruHeapPercentage" : {
            "action" : "LOCAL_DESTROY",
            "className" : "className",
            "parameters" : [ {
              "string" : "string",
              "name" : "name"
            }, {
              "string" : "string",
              "name" : "name"
            } ]
          },
          "lruEntryCount" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum"
          },
          "lruMemorySize" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum",
            "className" : "className",
            "parameters" : [ null, null ]
          }
        },
        "entryIdleTime" : {
          "action" : "action",
          "timeout" : "timeout"
        },
        "dataPolicy" : "EMPTY",
        "initialCapacity" : "initialCapacity",
        "diskWriteAttributes" : {
          "rollOplogs" : "rollOplogs",
          "synchronousWrites" : { },
          "maxOplogSize" : "maxOplogSize",
          "asynchronousWrites" : {
            "bytesThreshold" : "bytesThreshold",
            "timeInterval" : "timeInterval"
          }
        },
        "gatewaySenderIds" : "gatewaySenderIds",
        "enableSubscriptionConflation" : true,
        "cacheListeners" : [ {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        }, {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        } ],
        "concurrencyLevel" : "concurrencyLevel",
        "ignoreJta" : true,
        "scope" : "DISTRIBUTED_ACK",
        "persistBackup" : true,
        "offHeap" : true,
        "id" : "id",
        "refid" : "refid",
        "poolName" : "poolName",
        "mirrorType" : "KEYS",
        "earlyAck" : true,
        "statisticsEnabled" : true,
        "diskDirs" : {
          "diskDirs" : [ {
            "dirSize" : "dirSize",
            "content" : "content"
          }, {
            "dirSize" : "dirSize",
            "content" : "content"
          } ]
        },
        "indexUpdateType" : "ASYNCHRONOUS",
        "multicastEnabled" : true,
        "diskStoreName" : "diskStoreName",
        "diskSynchronous" : true,
        "loadFactor" : "loadFactor",
        "partitionAttributes" : {
          "redundantCopies" : "redundantCopies",
          "startupRecoveryDelay" : "startupRecoveryDelay",
          "recoveryDelay" : "recoveryDelay",
          "localMaxMemory" : "localMaxMemory",
          "totalNumBuckets" : "totalNumBuckets",
          "colocatedWith" : "colocatedWith",
          "fixedPartitionAttributes" : [ {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          }, {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          } ],
          "totalMaxMemory" : "totalMaxMemory",
          "partitionListeners" : [ null, null ]
        },
        "enableGateway" : true,
        "subscriptionAttributes" : {
          "interestPolicy" : "interestPolicy"
        },
        "keyConstraint" : "keyConstraint",
        "cloningEnabled" : true,
        "publisher" : true,
        "valueConstraint" : "valueConstraint",
        "compressor" : {
          "className" : "className"
        }
      },
      "indexes" : [ {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      }, {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      } ],
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 0,
      "memberName" : "memberName"
    }, {
      "entryCount" : 0,
      "memberName" : "memberName"
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«RegionConfig,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
get /experimental/regions/{regionName}/indexes
listIndex (listIndexUsingGET)

Path parameters

regionName (required)
Path Parameter — regionName

Query parameters

id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "expression" : "expression",
      "fromClause" : "fromClause",
      "imports" : "imports",
      "keyIndex" : true,
      "regionName" : "regionName",
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  }, {
    "config" : {
      "expression" : "expression",
      "fromClause" : "fromClause",
      "imports" : "imports",
      "keyIndex" : true,
      "regionName" : "regionName",
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

Up 
get /experimental/regions
listRegion (listRegionUsingGET)

Query parameters

group (optional)
Query Parameter — group
id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«RegionConfig,RuntimeRegionInfo»

Example data

Content-Type: application/json
{
  "result" : [ {
    "config" : {
      "regionAttributes" : {
        "enableAsyncConflation" : true,
        "hubId" : "hubId",
        "isLockGrantor" : true,
        "membershipAttributes" : {
          "requiredRoles" : [ {
            "name" : "name"
          }, {
            "name" : "name"
          } ],
          "lossAction" : "lossAction",
          "resumptionAction" : "resumptionAction"
        },
        "concurrencyChecksEnabled" : true,
        "asyncEventQueueIds" : "asyncEventQueueIds",
        "evictionAttributes" : {
          "lruHeapPercentage" : {
            "action" : "LOCAL_DESTROY",
            "className" : "className",
            "parameters" : [ {
              "string" : "string",
              "name" : "name"
            }, {
              "string" : "string",
              "name" : "name"
            } ]
          },
          "lruEntryCount" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum"
          },
          "lruMemorySize" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum",
            "className" : "className",
            "parameters" : [ null, null ]
          }
        },
        "entryIdleTime" : {
          "action" : "action",
          "timeout" : "timeout"
        },
        "dataPolicy" : "EMPTY",
        "initialCapacity" : "initialCapacity",
        "diskWriteAttributes" : {
          "rollOplogs" : "rollOplogs",
          "synchronousWrites" : { },
          "maxOplogSize" : "maxOplogSize",
          "asynchronousWrites" : {
            "bytesThreshold" : "bytesThreshold",
            "timeInterval" : "timeInterval"
          }
        },
        "gatewaySenderIds" : "gatewaySenderIds",
        "enableSubscriptionConflation" : true,
        "cacheListeners" : [ {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        }, {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        } ],
        "concurrencyLevel" : "concurrencyLevel",
        "ignoreJta" : true,
        "scope" : "DISTRIBUTED_ACK",
        "persistBackup" : true,
        "offHeap" : true,
        "id" : "id",
        "refid" : "refid",
        "poolName" : "poolName",
        "mirrorType" : "KEYS",
        "earlyAck" : true,
        "statisticsEnabled" : true,
        "diskDirs" : {
          "diskDirs" : [ {
            "dirSize" : "dirSize",
            "content" : "content"
          }, {
            "dirSize" : "dirSize",
            "content" : "content"
          } ]
        },
        "indexUpdateType" : "ASYNCHRONOUS",
        "multicastEnabled" : true,
        "diskStoreName" : "diskStoreName",
        "diskSynchronous" : true,
        "loadFactor" : "loadFactor",
        "partitionAttributes" : {
          "redundantCopies" : "redundantCopies",
          "startupRecoveryDelay" : "startupRecoveryDelay",
          "recoveryDelay" : "recoveryDelay",
          "localMaxMemory" : "localMaxMemory",
          "totalNumBuckets" : "totalNumBuckets",
          "colocatedWith" : "colocatedWith",
          "fixedPartitionAttributes" : [ {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          }, {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          } ],
          "totalMaxMemory" : "totalMaxMemory",
          "partitionListeners" : [ null, null ]
        },
        "enableGateway" : true,
        "subscriptionAttributes" : {
          "interestPolicy" : "interestPolicy"
        },
        "keyConstraint" : "keyConstraint",
        "cloningEnabled" : true,
        "publisher" : true,
        "valueConstraint" : "valueConstraint",
        "compressor" : {
          "className" : "className"
        }
      },
      "indexes" : [ {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      }, {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      } ],
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 0,
      "memberName" : "memberName"
    }, {
      "entryCount" : 0,
      "memberName" : "memberName"
    } ]
  }, {
    "config" : {
      "regionAttributes" : {
        "enableAsyncConflation" : true,
        "hubId" : "hubId",
        "isLockGrantor" : true,
        "membershipAttributes" : {
          "requiredRoles" : [ {
            "name" : "name"
          }, {
            "name" : "name"
          } ],
          "lossAction" : "lossAction",
          "resumptionAction" : "resumptionAction"
        },
        "concurrencyChecksEnabled" : true,
        "asyncEventQueueIds" : "asyncEventQueueIds",
        "evictionAttributes" : {
          "lruHeapPercentage" : {
            "action" : "LOCAL_DESTROY",
            "className" : "className",
            "parameters" : [ {
              "string" : "string",
              "name" : "name"
            }, {
              "string" : "string",
              "name" : "name"
            } ]
          },
          "lruEntryCount" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum"
          },
          "lruMemorySize" : {
            "action" : "LOCAL_DESTROY",
            "maximum" : "maximum",
            "className" : "className",
            "parameters" : [ null, null ]
          }
        },
        "entryIdleTime" : {
          "action" : "action",
          "timeout" : "timeout"
        },
        "dataPolicy" : "EMPTY",
        "initialCapacity" : "initialCapacity",
        "diskWriteAttributes" : {
          "rollOplogs" : "rollOplogs",
          "synchronousWrites" : { },
          "maxOplogSize" : "maxOplogSize",
          "asynchronousWrites" : {
            "bytesThreshold" : "bytesThreshold",
            "timeInterval" : "timeInterval"
          }
        },
        "gatewaySenderIds" : "gatewaySenderIds",
        "enableSubscriptionConflation" : true,
        "cacheListeners" : [ {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        }, {
          "className" : "className",
          "parameters" : [ {
            "string" : "string",
            "name" : "name"
          }, {
            "string" : "string",
            "name" : "name"
          } ]
        } ],
        "concurrencyLevel" : "concurrencyLevel",
        "ignoreJta" : true,
        "scope" : "DISTRIBUTED_ACK",
        "persistBackup" : true,
        "offHeap" : true,
        "id" : "id",
        "refid" : "refid",
        "poolName" : "poolName",
        "mirrorType" : "KEYS",
        "earlyAck" : true,
        "statisticsEnabled" : true,
        "diskDirs" : {
          "diskDirs" : [ {
            "dirSize" : "dirSize",
            "content" : "content"
          }, {
            "dirSize" : "dirSize",
            "content" : "content"
          } ]
        },
        "indexUpdateType" : "ASYNCHRONOUS",
        "multicastEnabled" : true,
        "diskStoreName" : "diskStoreName",
        "diskSynchronous" : true,
        "loadFactor" : "loadFactor",
        "partitionAttributes" : {
          "redundantCopies" : "redundantCopies",
          "startupRecoveryDelay" : "startupRecoveryDelay",
          "recoveryDelay" : "recoveryDelay",
          "localMaxMemory" : "localMaxMemory",
          "totalNumBuckets" : "totalNumBuckets",
          "colocatedWith" : "colocatedWith",
          "fixedPartitionAttributes" : [ {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          }, {
            "partitionName" : "partitionName",
            "isPrimary" : true,
            "numBuckets" : "numBuckets"
          } ],
          "totalMaxMemory" : "totalMaxMemory",
          "partitionListeners" : [ null, null ]
        },
        "enableGateway" : true,
        "subscriptionAttributes" : {
          "interestPolicy" : "interestPolicy"
        },
        "keyConstraint" : "keyConstraint",
        "cloningEnabled" : true,
        "publisher" : true,
        "valueConstraint" : "valueConstraint",
        "compressor" : {
          "className" : "className"
        }
      },
      "indexes" : [ {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      }, {
        "expression" : "expression",
        "fromClause" : "fromClause",
        "imports" : "imports",
        "keyIndex" : true,
        "regionName" : "regionName",
        "name" : "name",
        "groups" : [ "groups", "groups" ],
        "type" : "type",
        "uri" : "uri",
        "group" : "group"
      } ],
      "name" : "name",
      "groups" : [ "groups", "groups" ],
      "type" : "type",
      "uri" : "uri",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 0,
      "memberName" : "memberName"
    }, {
      "entryCount" : 0,
      "memberName" : "memberName"
    } ]
  } ],
  "uri" : "uri",
  "statusMessage" : "statusMessage",
  "statusCode" : "ILLEGAL_ARGUMENT"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • */*

Responses

200

OK ClusterManagementListResult«RegionConfig,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

Models

...

Table of Contents

  1. AsynchronousWrites - AsynchronousWrites
  2. CacheServerInfo - CacheServerInfo
  3. ClassName - ClassName
  4. ClassNameType - ClassNameType
  5. ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult»
  6. ClusterManagementListResult«GatewayReceiverConfig,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiverConfig,GatewayReceiverInfo»
  7. ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo»
  8. ClusterManagementListResult«MemberConfig,MemberInformation» - ClusterManagementListResult«MemberConfig,MemberInformation»
  9. ClusterManagementListResult«RegionConfig,RuntimeRegionInfo» - ClusterManagementListResult«RegionConfig,RuntimeRegionInfo»
  10. ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult»
  11. ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult»
  12. ClusterManagementResult - ClusterManagementResult
  13. ConfigurationResult«GatewayReceiverConfig,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiverConfig,GatewayReceiverInfo»
  14. ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo»
  15. ConfigurationResult«MemberConfig,MemberInformation» - ConfigurationResult«MemberConfig,MemberInformation»
  16. ConfigurationResult«RegionConfig,RuntimeRegionInfo» - ConfigurationResult«RegionConfig,RuntimeRegionInfo»
  17. DeclarableType - DeclarableType
  18. DiskDirType - DiskDirType
  19. DiskDirsType - DiskDirsType
  20. DiskWriteAttributes - DiskWriteAttributes
  21. EvictionAttributes - EvictionAttributes
  22. ExpirationAttributesType - ExpirationAttributesType
  23. FixedPartitionAttributes - FixedPartitionAttributes
  24. GatewayReceiverConfig - GatewayReceiverConfig
  25. GatewayReceiverInfo - GatewayReceiverInfo
  26. Index - Index
  27. LruEntryCount - LruEntryCount
  28. LruHeapPercentage - LruHeapPercentage
  29. LruMemorySize - LruMemorySize
  30. MemberConfig - MemberConfig
  31. MemberInformation - MemberInformation
  32. MembershipAttributes - MembershipAttributes
  33. ParameterType - ParameterType
  34. PartitionAttributes - PartitionAttributes
  35. Pdx - Pdx
  36. RebalanceOperation - RebalanceOperation
  37. RebalanceRegionResult - RebalanceRegionResult
  38. RebalanceResult - RebalanceResult
  39. RegionAttributesType - RegionAttributesType
  40. RegionConfig - RegionConfig
  41. RequiredRole - RequiredRole
  42. RuntimeInfo - RuntimeInfo
  43. RuntimeRegionInfo - RuntimeRegionInfo
  44. SubscriptionAttributes - SubscriptionAttributes

AsynchronousWrites - AsynchronousWrites Up

bytesThreshold (optional)
String
timeInterval (optional)
String

CacheServerInfo - CacheServerInfo Up

bindAddress (optional)
String
maxConnections (optional)
Integer format: int32
maxThreads (optional)
Integer format: int32
port (optional)
Integer format: int32
running (optional)
Boolean

ClassName - ClassName Up

className (optional)
String
initProperties (optional)
map[String, Object]

ClassNameType - ClassNameType Up

className (optional)
String

ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult» Up

result (optional)
array[ClusterManagementOperationResult«RebalanceResult»]
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementListResult«GatewayReceiverConfig,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiverConfig,GatewayReceiverInfo» Up

result (optional)
array[ConfigurationResult«GatewayReceiverConfig,GatewayReceiverInfo»]
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo» Up

result (optional)
array[ConfigurationResult«Index,RuntimeInfo»]
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementListResult«MemberConfig,MemberInformation» - ClusterManagementListResult«MemberConfig,MemberInformation» Up

result (optional)
array[ConfigurationResult«MemberConfig,MemberInformation»]
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementListResult«RegionConfig,RuntimeRegionInfo» - ClusterManagementListResult«RegionConfig,RuntimeRegionInfo» Up

result (optional)
array[ConfigurationResult«RegionConfig,RuntimeRegionInfo»]
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult» Up

operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult» Up

operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
result (optional)
RebalanceResult
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementResult - ClusterManagementResult Up

statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ConfigurationResult«GatewayReceiverConfig,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiverConfig,GatewayReceiverInfo» Up

config (optional)
GatewayReceiverConfig
runtimeInfo (optional)
array[GatewayReceiverInfo]

ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo» Up

config (optional)
Index
runtimeInfo (optional)
array[RuntimeInfo]

ConfigurationResult«MemberConfig,MemberInformation» - ConfigurationResult«MemberConfig,MemberInformation» Up

config (optional)
MemberConfig
runtimeInfo (optional)
array[MemberInformation]

ConfigurationResult«RegionConfig,RuntimeRegionInfo» - ConfigurationResult«RegionConfig,RuntimeRegionInfo» Up

config (optional)
RegionConfig
runtimeInfo (optional)
array[RuntimeRegionInfo]

DeclarableType - DeclarableType Up

className (optional)
String
parameters (optional)
array[ParameterType]

DiskDirType - DiskDirType Up

content (optional)
String
dirSize (optional)
String

DiskDirsType - DiskDirsType Up

diskDirs (optional)
array[DiskDirType]

DiskWriteAttributes - DiskWriteAttributes Up

asynchronousWrites (optional)
AsynchronousWrites
maxOplogSize (optional)
String
rollOplogs (optional)
String
synchronousWrites (optional)
Object

EvictionAttributes - EvictionAttributes Up

lruEntryCount (optional)
LruEntryCount
lruHeapPercentage (optional)
LruHeapPercentage
lruMemorySize (optional)
LruMemorySize

ExpirationAttributesType - ExpirationAttributesType Up

action (optional)
String
customExpiry (optional)
DeclarableType
timeout (optional)
String

FixedPartitionAttributes - FixedPartitionAttributes Up

isPrimary (optional)
Boolean
numBuckets (optional)
String
partitionName (optional)
String

GatewayReceiverConfig - GatewayReceiverConfig Up

bindAddress (optional)
String
endPort (optional)
String
gatewayTransportFilters (optional)
array[DeclarableType]
group (optional)
String
groups (optional)
array[String]
hostnameForSenders (optional)
String
manualStart (optional)
Boolean
maximumTimeBetweenPings (optional)
String
socketBufferSize (optional)
String
startPort (optional)
String
uri (optional)
String

GatewayReceiverInfo - GatewayReceiverInfo Up

bindAddress (optional)
String
connectedSenders (optional)
array[String]
hostnameForSenders (optional)
String
memberName (optional)
String
port (optional)
Integer format: int32
running (optional)
Boolean
senderCount (optional)
Integer format: int32

Index - Index Up

expression (optional)
String
fromClause (optional)
String
group (optional)
String
groups (optional)
array[String]
imports (optional)
String
keyIndex (optional)
Boolean
name (optional)
String
regionName (optional)
String
type (optional)
String
uri (optional)
String

LruEntryCount - LruEntryCount Up

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
maximum (optional)
String

LruHeapPercentage - LruHeapPercentage Up

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
className (optional)
String
parameters (optional)
array[ParameterType]

LruMemorySize - LruMemorySize Up

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
className (optional)
String
maximum (optional)
String
parameters (optional)
array[ParameterType]

MemberConfig - MemberConfig Up

groups (optional)
array[String]
id (optional)
String
uri (optional)
String

MemberInformation - MemberInformation Up

cacheServerInfo (optional)
array[CacheServerInfo]
cacheXmlFilePath (optional)
String
clientCount (optional)
Integer format: int32
coordinator (optional)
Boolean
cpuUsage (optional)
Double format: double
groups (optional)
String
heapUsage (optional)
Long format: int64
host (optional)
String
hostedRegions (optional)
array[String]
httpServiceBindAddress (optional)
String
httpServicePort (optional)
Integer format: int32
id (optional)
String
initHeapSize (optional)
Long format: int64
locatorPort (optional)
Integer format: int32
locators (optional)
String
logFilePath (optional)
String
maxHeapSize (optional)
Long format: int64
memberName (optional)
String
offHeapMemorySize (optional)
String
processId (optional)
Integer format: int32
secured (optional)
Boolean
server (optional)
Boolean
serverBindAddress (optional)
String
statArchiveFilePath (optional)
String
status (optional)
String
webSSL (optional)
Boolean
workingDirPath (optional)
String

MembershipAttributes - MembershipAttributes Up

lossAction (optional)
String
requiredRoles (optional)
array[RequiredRole]
resumptionAction (optional)
String

ParameterType - ParameterType Up

declarable (optional)
DeclarableType
name (optional)
String
string (optional)
String

PartitionAttributes - PartitionAttributes Up

colocatedWith (optional)
String
fixedPartitionAttributes (optional)
array[FixedPartitionAttributes]
localMaxMemory (optional)
String
partitionListeners (optional)
array[DeclarableType]
partitionResolver (optional)
DeclarableType
recoveryDelay (optional)
String
redundantCopies (optional)
String
startupRecoveryDelay (optional)
String
totalMaxMemory (optional)
String
totalNumBuckets (optional)
String

Pdx - Pdx Up

diskStoreName (optional)
String
group (optional)
String
groups (optional)
array[String]
ignoreUnreadFields (optional)
Boolean
pdxSerializer (optional)
ClassName
persistent (optional)
Boolean
readSerialized (optional)
Boolean
uri (optional)
String

RebalanceOperation - RebalanceOperation Up

excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
simulate (optional)
Boolean

RebalanceRegionResult - RebalanceRegionResult Up

bucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64

RebalanceResult - RebalanceResult Up

rebalanceRegionResults (optional)
array[RebalanceRegionResult]
statusMessage (optional)
String

RegionAttributesType - RegionAttributesType Up

asyncEventQueueIds (optional)
String
cacheListeners (optional)
array[DeclarableType]
cacheLoader (optional)
DeclarableType
cacheWriter (optional)
DeclarableType
cloningEnabled (optional)
Boolean
compressor (optional)
ClassNameType
concurrencyChecksEnabled (optional)
Boolean
concurrencyLevel (optional)
String
dataPolicy (optional)
String
Enum:
EMPTY
NORMAL
PARTITION
PERSISTENT_REPLICATE
PRELOADED
REPLICATE
PERSISTENT_PARTITION
diskDirs (optional)
DiskDirsType
diskStoreName (optional)
String
diskSynchronous (optional)
Boolean
diskWriteAttributes (optional)
DiskWriteAttributes
earlyAck (optional)
Boolean
enableAsyncConflation (optional)
Boolean
enableGateway (optional)
Boolean
enableSubscriptionConflation (optional)
Boolean
entryIdleTime (optional)
ExpirationAttributesType
entryTimeToLive (optional)
ExpirationAttributesType
evictionAttributes (optional)
EvictionAttributes
gatewaySenderIds (optional)
String
hubId (optional)
String
id (optional)
String
ignoreJta (optional)
Boolean
indexUpdateType (optional)
String
Enum:
ASYNCHRONOUS
SYNCHRONOUS
initialCapacity (optional)
String
isLockGrantor (optional)
Boolean
keyConstraint (optional)
String
loadFactor (optional)
String
membershipAttributes (optional)
MembershipAttributes
mirrorType (optional)
String
Enum:
KEYS
KEYS_VALUES
NONE
multicastEnabled (optional)
Boolean
offHeap (optional)
Boolean
partitionAttributes (optional)
PartitionAttributes
persistBackup (optional)
Boolean
poolName (optional)
String
publisher (optional)
Boolean
refid (optional)
String
regionIdleTime (optional)
ExpirationAttributesType
regionTimeToLive (optional)
ExpirationAttributesType
scope (optional)
String
Enum:
DISTRIBUTED_ACK
DISTRIBUTED_NO_ACK
GLOBAL
LOCAL
statisticsEnabled (optional)
Boolean
subscriptionAttributes (optional)
SubscriptionAttributes
valueConstraint (optional)
String

RegionConfig - RegionConfig Up

group (optional)
String
groups (optional)
array[String]
indexes (optional)
array[Index]
name (optional)
String
regionAttributes (optional)
RegionAttributesType
type (optional)
String
uri (optional)
String

RequiredRole - RequiredRole Up

name (optional)
String

RuntimeInfo - RuntimeInfo Up

memberName (optional)
String

RuntimeRegionInfo - RuntimeRegionInfo Up

entryCount (optional)
Long format: int64
memberName (optional)
String

SubscriptionAttributes - SubscriptionAttributes Up

interestPolicy (optional)
String

...

Code Block
languageyml
titleError Response - unauthenticated
{
  "statusCode" : "UNAUTHENTICATED",
  "statusMessage" : "Authentication error. Please check your credentials.",
}

...

Code Block
languageyml
titleError Response - not authorized
{
  "statusCode" : "UNAUTHORIZED",
  "statusMessage" : "User not authorized for DATA:MANAGE.",
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "ERROR",
  "statusMessage" : "Cluster configuration service is not running.",
}

Notes:

  • the CREATE[POST] endpoint is not idempotent, you will receive a 409 when creating the a region with the same name the 2nd time.
  • if group name is "cluster" or omitted, the region will be created on all the data members in this cluster.

401 and 403 responses are omitted for the rest of the end points.

List Regions

...

Endpoint: http://locator:7070/management/experimental/regions

Method: GET

Headers: Authorization

...

200

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": [{
		"config": {
			"groups": ["group2"],
			"regionAttributes": {
				"dataPolicy": "PARTITION",
				"concurrencyChecksEnabled": true
			},
			"name": "customers2",
			"type": "PARTITION",
			"uri": "/management/experimental/regions/customers2"
		},
		"runtimeInfo": [{
			"entryCount": 0
		}]
	}, {
		"config": {
			"groups": ["group2", "group1"],
			"regionAttributes": {
				"dataPolicy": "PARTITION",
				"concurrencyChecksEnabled": true
			},
			"name": "customers3",
			"type": "PARTITION",
			"uri": "/management/experimental/regions/customers3"
		},
		"runtimeInfo": [{
			"entryCount": 0
		}]
	}]
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "UNAUTHENTICATED",
  "statusMessage" : "Authentication error. Please check your credentials.",
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "UNAUTHORIZED",
  "statusMessage" : "User not authorized for DATA:MANAGE.",
}

Get Region

...

Endpoint: http://locator:7070/management/experimental/regions/Foo

Method: GET

Headers: Authorization

...

200

Code Block
languagejs
themeEclipse
titleSuccess Response
{
	"statusCode": "OK",
	"result": {
		"config": {
			"groups": ["group2"],
			"regionAttributes": {
				"dataPolicy": "PARTITION",
				"concurrencyChecksEnabled": true
			},
			"name": "Foo",
			"type": "PARTITION",
			"uri": "/management/experimental/regions/Foo"
		},
		"runtimeInfo": [{
			"entryCount": 0
		}]
	}
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "UNAUTHENTICATED",
  "statusMessage" : "Authentication error. Please check your credentials.",
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "UNAUTHORIZED",
  "statusMessage" : "User not authorized for DATA:MANAGE.",
}

...

Code Block
languagejs
titleNot Found Response
{
     "statusCode": "ENTITY_NOT_FOUND",
     "statusMessage": "Region 'Foo' does not exist."
}

Delete Region

...

Endpoint: http://locator:7070/management/experimental/regions/Foo

Method: DELETE

Headers: Authorization

...

200

Code Block
languageyml
titleSuccess Response
{
	"memberStatuses": [{
		"memberName": "server-1",
		"success": true,
		"message": "Region successfully deleted."
	}, {
		"memberName": "server-3",
		"success": true,
		"message": "Region successfully deleted."
	}],
	"statusCode": "OK",
	"statusMessage": "Successfully removed configuration for [cluster]."
}

...

Code Block
languageyml
titleNot Found Response
{
     "statusCode":"ENTITY_NOT_FOUND",
     "statusMessage":"Region 'Foo' does not exist."
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "UNAUTHENTICATED",
  "statusMessage" : "Authentication error. Please check your credentials.",
}

...

Code Block
languageyml
titleError Response
{
  "statusCode" : "UNAUTHORIZED",
  "statusMessage" : "User not authorized for DATA:MANAGE.",
}

...

Code Block
languageyml
titleError Response
{
    "statusCode" : "ERROR",
    "statusMessage": "Failed to delete on all members."
}

Note that the DELETE endpoint is idempotent – i.e. it should be a NOOP if the region does not exist.

Member Management

List Members

...

Endpoint: http://locator:7070/management/experimental/members

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": [{
		"runtimeInfo": [{
			"memberName": "locator-0",
			"id": "10.10.10.10(locator-0:4317:locator)<ec><v0>:41001",
			"workingDirPath": "/Users/user/projects/geode/vm0",
			"logFilePath": "/Users/user/projects/geode/vm0",
			"statArchiveFilePath": "/Users/user/projects/geode/vm0",
			"locators": "10.10.10.10[64759]",
			"heapUsage": 209,
			"maxHeapSize": 480,
			"initHeapSize": 512,
			"cacheXmlFilePath": "/Users/user/projects/geode/vm0",
			"host": "10.10.10.10",
			"processId": 4317,
			"locatorPort": 64759,
			"httpServicePort": 22500,
			"httpServiceBindAddress": "localhost",
			"clientCount": 0,
			"cpuUsage": 0.0,
			"webSSL": false,
			"coordinator": true,
			"secured": false,
			"server": false,
            "status": "online"
		}, {
			"memberName": "server-1",
			"id": "10.10.10.10(server-1:4318)<v1>:41002",
			"workingDirPath": "/Users/user/projects/geode/vm1",
			"logFilePath": "/Users/user/projects/geode/vm1",
			"statArchiveFilePath": "/Users/user/projects/geode/vm1",
			"locators": "localhost[64759]",
			"heapUsage": 107,
			"maxHeapSize": 491,
			"initHeapSize": 512,
			"cacheXmlFilePath": "/Users/user/projects/geode/vm1/cache.xml",
			"host": "10.10.10.10",
			"processId": 4318,
			"locatorPort": 0,
			"httpServicePort": 0,
			"clientCount": 0,
			"cpuUsage": 0.0,
			"webSSL": false,
			"coordinator": false,
			"secured": false,
			"server": true,
            "status": "online",
			"cacheServerInfo": [{
				"port": 64772,
				"maxConnections": 800,
				"maxThreads": 0,
				"running": true
			}]
		}]
	}]
}

...

Endpoint: http://locator:7070/management/experimental/members?id=server-1

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": [{
        "config" : {
            "id" : "locator-0",
            "uri" : "/management/experimental/members/locator-0",
        },
		"runtimeInfo": [{
			"memberName": "locator-0",
			"id": "10.10.10.10(locator-0:4317:locator)<ec><v0>:41001",
			"workingDirPath": "/Users/user/projects/geode/vm0",
			"logFilePath": "/Users/user/projects/geode/vm0",
			"statArchiveFilePath": "/Users/user/projects/geode/vm0",
			"locators": "10.10.10.10[64759]",
			"heapUsage": 209,
			"maxHeapSize": 480,
			"initHeapSize": 512,
			"cacheXmlFilePath": "/Users/juser/projects/geode/vm0",
			"host": "10.10.10.10",
			"processId": 4317,
			"locatorPort": 64759,
			"httpServicePort": 22500,
			"httpServiceBindAddress": "localhost",
			"clientCount": 0,
			"cpuUsage": 0.0,
			"webSSL": false,
			"coordinator": true,
			"secured": false,
			"server": false,
            "status": "online"
		}]
	}]
}

...

Endpoint: http://locator:7070/management/experimental/members?id=Non-Existent

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
   "statusCode" : "OK",
   "result" : [
      {
         "config" : {
            "uri" : "/management/experimental/members/Non-Existent",
            "id" : "Non-Existent"
         }
      }
   ]
}

Get Member

...

Endpoint: http://locator:7070/management/experimental/members/server-1

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": {
        "config" : {
            "id" : "server-1",
            "uri" : "/management/experimental/members/server-1",
        },
		"runtimeInfo": [{
			"memberName": "server-1",
			"id": "10.10.10.10(locator-0:4317:locator)<ec><v0>:41001",
			"workingDirPath": "/Users/user/projects/geode/vm0",
			"logFilePath": "/Users/user/projects/geode/vm0",
			"statArchiveFilePath": "/Users/user/projects/geode/vm0",
			"locators": "10.10.10.10[64759]",
			"heapUsage": 209,
			"maxHeapSize": 480,
			"initHeapSize": 512,
			"cacheXmlFilePath": "/Users/user/projects/geode/vm0",
			"host": "10.10.10.10",
			"processId": 4317,
			"locatorPort": 64759,
			"httpServicePort": 22500,
			"httpServiceBindAddress": "localhost",
			"clientCount": 0,
			"cpuUsage": 0.0,
			"webSSL": false,
			"coordinator": true,
			"secured": false,
			"server": false,
            "status": "online"
		}]
	}
}

...

Endpoint: http://locator:7070/management/experimental/members/Non-Existent

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleNot Found Response
{
   "statusCode" : "ENTITY_NOT_FOUND",
   "statusMessage" : "Member 'Non-Existent' does not exist."
}

Index Management

List Indexes

...

Endpoint: http://locator:7070/management/experimental/regions/{regionName}/indexes

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": [{
		"config": {
			"name": "index1",
			"expression": "id",
			"fromClause": "/region1",
			"keyIndex": true,
			"type": "key",
			"regionName": "region1",
			"uri": "/management/experimental/regions/region1/indexes/index1"
		}
	}, {
		"config": {
			"name": "index2",
			"expression": "key",
			"fromClause": "/region1",
			"keyIndex": true,
			"type": "key",
			"regionName": "region1",
			"uri": "/management/experimental/regions/region1/indexes/index2"
		}
	}]
}

Get Index

...

Endpoint: http://locator:7070/management/experimental/regions/{regionName}/indexes/{indexName}

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": {
		"config": {
			"name": "index1",
			"expression": "id",
			"fromClause": "/region1",
			"keyIndex": true,
			"type": "key",
			"regionName": "region1",
			"uri": "/management/experimental/regions/region1/indexes/index1"
		}
	}
}

...

Endpoint: http://locator:7070/management/experimental/regions/{regionName}/indexes/{indexName}

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languagejs
titleNot found response
{
  "statusCode": "ENTITY_NOT_FOUND",
  "statusMessage": "Index 'foo' does not exist in region 'replicate'."
}

PDX Management

Configure PDX

...

Endpoint:http://locator:7070/management/experimental/configurations/pdx

Method: POST

Headers: Authorization

Permission Required: CLUSTER:MANAGE

Code Block
languageyml
titleSample Request
{"readSerialized":true}

...

Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "statusMessage": "Successfully updated configuration for cluster.",
  "uri": "/management/experimental/configurations/pdx",
  "memberStatuses": [
    {
      "memberName": "server-1",
      "success": true,
      "message": "Server 'server-1' needs to be restarted for this configuration change to be realized."
    }
  ]
}

Gateway Management

Create Gateway Receiver

...

Endpoint: http://locator:7070/management/experimental/gateways/receivers

Method: POST

Headers: Authorization

Permission Required: CLUSTER:MANAGE

Code Block
languageyml
titleSample Request
{
 "startPort":"5000",
 "group":"group1"
}

...

Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "statusMessage": "Successfully updated configuration for group1.",
  "uri": "/management/experimental/gateways/receivers/group1"
}

List Gateway Receivers

...

Endpoint: http://locator:7070/management/experimental/gateways/receivers

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": [{
		"config": {
			"groups": ["group2"],
			"startPort": "5002",
			"endPort": "5500",
			"uri": "/management/experimental/gateways/receivers/group2"
		}
	}, {
		"config": {
			"groups": ["group1"],
			"startPort": "5000",
			"endPort": "5500",
			"uri": "/management/experimental/gateways/receivers/group1"
		},
		"runtimeInfo": [{
			"memberName": "server-1",
			"running": true,
			"port": 5134
		}]
	}]
}

Get Gateway Receiver

...

Endpoint: http://locator:7070/management/experimental/gateways/receivers/{receiverGroup}

Method: GET

Headers: Authorization

Permission Required: CLUSTER:READ

...

Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": {
		"config": {
			"groups": ["group1"],
			"startPort": "5000",
			"endPort": "5500",
			"uri": "/management/experimental/gateways/receivers/group1"
		},
		"runtimeInfo": [{
			"memberName": "server-1",
			"running": true,
			"port": 5134
		}]
	}
}

Rebalance Operation

Start Rebalance

...

Endpoint: http://locator:7070/management/experimental/operations/rebalances

Method: POST

Headers: Authorization

Permission Required: DATA:MANAGE

Code Block
languageyml
titleSample Request
{
"excludeRegions": [],
"includeRegions": [],
"simulate": false
}

...

Code Block
languageyml
titleSuccess Response
{
  "statusCode": "ACCEPTED",
  "statusMessage": "Operation started.  Use the URI to check its status.",
  "uri": "/management/experimental/operations/rebalances/8a70d6c4",
  "operationStart": "2019-07-25T10:17:42.004Z"
}

List Rebalance History

...

Endpoint: http://locator:7070/management/experimental/operations/rebalances

Method: GET

Headers: Authorization

Permission Required: DATA:MANAGE

...

Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "result": [
    {
      "statusCode": "OK",
      "statusMessage": "Operation finished successfully.",
      "uri": "/management/experimental/operations/rebalances/8a70d6c4",
      "operationStart": "2019-07-25T10:17:42.004Z",
      "operationEnded": "2019-07-25T10:17:42.060Z"
    },
    {
      "statusCode": "IN_PROGRESS",
      "statusMessage": "Operation in progress.",
      "uri": "/management/experimental/operations/rebalances/a7d6204c",
      "operationStart": "2019-07-26T04:57:22.534Z",
    }
  ]
}

Get Rebalance Status

...

Endpoint: http://locator:7070/management/experimental/operations/rebalances/{id}

Method: GET

Headers: Authorization

Permission Required: DATA:MANAGE

...

Code Block
languageyml
titleSuccess Response
{
  "statusCode": "IN_PROGRESS",
  "statusMessage": "Operation in progress.",
  "operationStart": "2019-07-25T10:17:42.004Z",
}

...

Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "statusMessage": "Operation finished successfully.",
  "operationStart": "2019-07-25T10:17:42.004Z",
  "operationEnded": "2019-07-25T10:17:42.060Z",
  "result": {
    "rebalanceRegionResults": [
      {
        "regionName": "testRegion2",
        "bucketCreateBytes": 0,
        "bucketCreateTimeInMilliseconds": 0,
        "bucketCreatesCompleted": 0,
        "bucketTransferBytes": 0,
        "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "primaryTransfersCompleted": 0,
        "timeInMilliseconds": 17
      },
      {
        "regionName": "testRegion1",
        "bucketCreateBytes": 0,
        "bucketCreateTimeInMilliseconds": 0,
        "bucketCreatesCompleted": 0,
        "bucketTransferBytes": 0,
        "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "primaryTransfersCompleted": 0,
        "timeInMilliseconds": 5
      }
    ]
  }
}

...

Code Block
languageyml
titleInformation Response
{
  "statusCode": "OK",
  "statusMessage": "Operation finished successfully.",
  "operationStart": "2019-07-25T10:17:42.004Z",
  "operationEnded": "2019-07-25T10:17:42.060Z",
  "result": {
    "statusMessage": "Distributed system has no regions that can be rebalanced."
  }
}

...

languageyml
titleNot Found Response

...