Table of Contents |
---|
Region Management
Create Region
...
|
Apache Geode Management REST API
...
...
Method: POST
Headers: Authorization
Permission Required: DATA:MANAGE
Code Block | ||||
---|---|---|---|---|
| ||||
{
"name": "regionA",
"type": "REPLICATE"
}
|
Types supported by this Rest API is defined in RegionType:
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"statusMessage" : "Region 'regionA' already exists on member(s) server-2.",
"statusCode" : "ENTITY_EXISTS"
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "ILLEGAL_ARGUMENT",
"statusMessage" : "Region identifier is required.",
} |
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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\"])"
}
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHENTICATED",
"statusMessage" : "Authentication error. Please check your credentials.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHORIZED",
"statusMessage" : "User not authorized for DATA:MANAGE.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHENTICATED",
"statusMessage" : "Authentication error. Please check your credentials.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHENTICATED",
"statusMessage" : "Authentication error. Please check your credentials.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHORIZED",
"statusMessage" : "User not authorized for DATA:MANAGE.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"statusCode":"ENTITY_NOT_FOUND",
"statusMessage":"Region 'Foo' does not exist."
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHENTICATED",
"statusMessage" : "Authentication error. Please check your credentials.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"statusCode" : "UNAUTHORIZED",
"statusMessage" : "User not authorized for DATA:MANAGE.",
} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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
...
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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"
}]
}
}
|
Gateway Management
POST /management/experimental/gateways/receivers
POST /management/experimental/gateways/receivers
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}
Responses
200
OK ClusterManagementResult201
Created401
Unauthorized403
Forbidden404
Not Found...
GET /management/experimental/gateways/receivers
GET /management/experimental/gateways/receivers
Query parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_GatewayReceiverConfig_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
Member Management
GET /management/experimental/members/{id}
GET /management/experimental/members/{id}
Path parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_MemberConfig_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
GET /management/experimental/members
GET /management/experimental/members
Query parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_MemberConfig_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
Pdx Management
POST /management/experimental/configurations/pdx
POST /management/experimental/configurations/pdx
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}
Responses
200
OK. ClusterManagementResult201
Created401
Invalid Username or Password.403
Insufficient privileges for operation.404
Not Found500
GemFire throws an error or exception....
Ping
GET /management/experimental/ping
GET /management/experimental/ping
Return type
Example data
""
Responses
200
OK String401
Unauthorized403
Forbidden404
Not Found...
Rebalance Operation
GET /management/experimental/operations/rebalances/{id}
GET /management/experimental/operations/rebalances/{id}
Path parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementOperationStatusResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
GET /management/experimental/operations/rebalances
GET /management/experimental/operations/rebalances
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListOperationsResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
POST /management/experimental/operations/rebalances
POST /management/experimental/operations/rebalances
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementOperationResult_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not Found...
Region Management
POST /management/experimental/regions
POST /management/experimental/regions
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}
Responses
200
OK. ClusterManagementResult201
Created401
Invalid Username or Password.403
Insufficient privileges for operation.404
Not Found409
Region already exist.500
GemFire throws an error or exception....
DELETE /management/experimental/regions/{id}
DELETE /management/experimental/regions/{id}
Path parameters
Query parameters
Return type
Example data
{
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
GET /management/experimental/regions/{regionName}/indexes/{id}
GET /management/experimental/regions/{regionName}/indexes/{id}
Path parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_Index_RuntimeInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/experimental/regions/{id}
GET /management/experimental/regions/{id}
Path parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_RegionConfig_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/experimental/regions/{regionName}/indexes
GET /management/experimental/regions/{regionName}/indexes
Path parameters
Query parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_Index_RuntimeInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/experimental/regions
GET /management/experimental/regions
Query parameters
Return type
Example data
{
"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"
}
Responses
200
OK ClusterManagementListResult_RegionConfig_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
Models
AsynchronousWrites
CacheServerInfo
ClassName
ClassNameType
ClusterManagementListOperationsResult_RebalanceResult
ClusterManagementListResult_GatewayReceiverConfig_GatewayReceiverInfo
ClusterManagementListResult_Index_RuntimeInfo
ClusterManagementListResult_MemberConfig_MemberInformation
ClusterManagementListResult_RegionConfig_RuntimeRegionInfo
ClusterManagementOperationResult_RebalanceResult
ClusterManagementOperationStatusResult_RebalanceResult
ClusterManagementResult
DiskDirType
DiskDirsType
DiskWriteAttributes
EvictionAttributes
FixedPartitionAttributes
GatewayReceiverConfig
GatewayReceiverInfo
Index
LruEntryCount
LruHeapPercentage
LruMemorySize
MemberConfig
MemberInformation
MembershipAttributes
PartitionAttributes
Pdx
RebalanceOperation
RebalanceRegionResult
RegionAttributesType
RegionConfig
RequiredRole
RuntimeInfo
RuntimeRegionInfo
SubscriptionAttributes
...
Endpoint: http://locator:7070/management/experimental/members/Non-Existent
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{"readSerialized":true}
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"startPort":"5000",
"group":"group1"
}
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"excludeRegions": [],
"includeRegions": [],
"simulate": false
}
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"statusCode": "IN_PROGRESS",
"statusMessage": "Operation in progress.",
"operationStart": "2019-07-25T10:17:42.004Z",
}
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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 | ||||
---|---|---|---|---|
| ||||
{
"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."
}
}
|
...
language | yml |
---|---|
title | Not Found Response |
...