Table of Contents |
---|
Region Management
Create region
|
Apache Geode Management REST API
...
...
Method: POST
Headers: Authorization
Permission Required: DATA:MANAGE
Body:
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
} |
...
language | java |
---|---|
title | Success Response |
...
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" :
...
language | java |
---|---|
title | Name conflict |
...
"name"
}, {
"string" : "
...
string",
...
"
...
name" : "
...
name"
...
...
...
...
...
...
...
}
...
language | java |
---|---|
title | Error Response - missing required parameter |
...
]
}, {
"className" : "
...
className",
...
"
...
parameters" : [ {
...
...
...
...
...
...
...
...
"
...
string" :
...
language | java |
---|---|
title | Error Response - invalid parameter |
...
"string",
"name" : "
...
name"
}, {
"
...
string" : "string"
...
,
...
...
...
...
...
...
...
...
"
...
name" :
...
language | java |
---|---|
title | Error Response |
...
"name"
} ]
} ],
"hostnameForSenders" : "
...
hostnameForSenders",
...
"
...
manualStart" :
...
true,
"
...
groups" :
...
language | java |
---|---|
title | Error Response |
...
[ "groups", "groups" ],
"maximumTimeBetweenPings" : "
...
maximumTimeBetweenPings",
...
"
...
endPort" : "
...
language | java |
---|---|
title | Error Response |
...
endPort",
"uri" : "uri",
"bindAddress" : "bindAddress",
"socketBufferSize" : "socketBufferSize",
"group" : "
...
group"
},
"
...
runtimeInfo" :
...
[
...
{
...
...
...
...
"
...
connectedSenders" :
...
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 End Point
...
Endpoint: http://locator:8080/geode-management/v2/regions
Method: GET
Headers: Authorization
...
200
...
language | java |
---|---|
title | Success Response |
...
[ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 0,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"
...
senderCount" :
...
6
...
},
...
{
...
language | java |
---|---|
title | Error Response |
...
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"
...
running" :
...
language | java |
---|---|
title | Error Response |
...
true,
"port" : 0,
"
...
hostnameForSenders" : "
...
hostnameForSenders",
...
...
...
...
Describe End Point
...
Endpoint: http://locator:8080/geode-management/v2/regions/Foo
Method: GET
Headers: Authorization
...
200
...
language | java |
---|---|
title | Success Response |
...
"
...
memberName" : "
...
memberName",
...
"
...
bindAddress" : "
...
bindAddress",
...
"
...
senderCount" :
...
6
} ]
}, {
"
...
config" : {
...
"startPort" : "startPort",
...
"
...
gatewayTransportFilters"
...
: [ {
...
"
...
className" :
...
"className",
"
...
parameters" : [
...
{
...
"
...
string" :
...
"string",
"
...
name" : "
...
name"
}
...
, {
...
language | java |
---|---|
title | Error Response |
...
"string" : "
...
language | java |
---|---|
title | Error Response |
...
string",
"
...
name" : "
...
language | java |
---|---|
title | Error Response |
...
name"
} ]
}, {
"
...
className" :
...
Update End Point (not implemented)
...
Endpoint: http://locator:8080/geode-management/v2/regions/Foo
Method: PATCH
Headers: Authorization
Body:
...
language | java |
---|---|
title | Request Body |
...
"className",
"parameters" : [ {
"
...
string" :
...
"
...
string",
...
200
...
language | java |
---|---|
title | Success Response |
...
"
...
name" :
...
language | java |
---|---|
title | Error Response |
...
"name"
}, {
...
...
...
...
language | java |
---|---|
title | Error Response |
...
...
"
...
string" :
...
language | java |
---|---|
title | Error Response |
...
"string",
"
...
name" :
...
language | java |
---|---|
title | Error Response |
...
"name"
} ]
} ],
"
...
hostnameForSenders" : "
...
hostnameForSenders",
...
...
...
...
...
...
language | java |
---|---|
title | Error Response |
...
"manualStart" : true,
"groups" : [ "groups", "groups" ],
"
...
maximumTimeBetweenPings" : "maximumTimeBetweenPings"
...
,
...
...
...
...
...
"endPort"
...
:
...
"endPort"
...
Delete End Point
...
Endpoint: http://locator:8080/geode-management/v2/regions/Foo
Method: DELETE
Headers: Authorization
...
204
...
<Successful deletion>
...
language | java |
---|---|
title | Error Response |
...
,
"
...
uri" : "
...
language | java |
---|---|
title | Error Response |
...
uri",
"bindAddress" : "bindAddress",
"
...
socketBufferSize" :
...
language | java |
---|---|
title | Error Response |
...
"socketBufferSize",
"group" : "group"
},
"runtimeInfo" : [ {
"
...
connectedSenders" : [ "connectedSenders", "
...
language | java |
---|---|
title | Error Response |
...
connectedSenders" ],
"running" : true,
"
...
port" :
...
Note that the DELETE endpoint is idempotent – i.e. it should be a NOOP if the region does not exist.
Member Management
List members end point
...
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"memberStatuses": {},
"statusCode": "OK",
"statusMessage": null,
"result": [{
"class": "org.apache.geode.management.configuration.MemberConfig",
"id": "locator-0",
"host": "10.118.19.10",
"pid": "51876",
"cacheServers": [{...}],
"locator": true,
"coordinator": true,
"usedHeap": 500,
"groups": ["group-1", "group-2"],
"clientConnections": 5,
"workingDirectory": "/var/vcap/sys/log/something",
"logFile": "/var/vcap/sys/log/locator"
}, {
"class": "org.apache.geode.management.configuration.MemberConfig",
"id": "server-1",
"host": "10.118.19.10",
"pid": "51877",
"cacheServers": [{...}],
"locator": false,
"coordinator": false,
"usedHeap": 510,
"groups": ["group-1", "group-2"],
"clientConnections": 5,
"workingDirectory": "/var/vcap/sys/log/something",
"logFile": "/var/vcap/sys/log/server"
}]
}
|
...
Endpoint:http://locator:8080/geode-management/v2/members?id=server-1
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"memberStatuses": {},
"statusCode": "OK",
"statusMessage": null,
"result": [{
"class": "org.apache.geode.management.configuration.MemberConfig",
"id": "server-1",
"host": "10.118.19.10",
"pid": "51877",
"cacheServers": [{...}],
"locator": false,
"coordinator": false
}]
}
|
...
Endpoint:http://locator:8080/geode-management/v2/members?id=Non-Existent
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"memberStatuses": {},
"statusCode": "OK",
"statusMessage": null,
"result": []
}
|
Get members end point
...
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"memberStatuses": {},
"statusCode": "OK",
"statusMessage": null,
"result": [{
"class": "org.apache.geode.management.configuration.MemberConfig",
"id": "server-1",
"host": "10.118.19.10",
"pid": "51877",
"cacheServers": [{...}],
"locator": false,
"coordinator": false
}]
}
|
...
Endpoint:http://locator:8080/geode-management/v2/members/Non-Existent
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"memberStatuses": {},
"statusCode": "ENTITY_NOT_FOUND",
"statusMessage": "Unable to find the member with id = Non-Existent",
"result": []
}
|
Index Management
List indexes
...
Endpoint:http://locator:8080/geode-management/v2/regions/{regionName}/indexes
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
Get index
...
Endpoint:http://locator:8080/geode-management/v2/regions/{regionName}/indexes/{indexName}
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
PDX Management
Configure PDX
...
Endpoint:http://locator:8080/geode-management/v2/configurations/pdx
Method: POST
Headers: Authorization
Permission Required: CLUSTER:MANAGE
...
Gateway Management
List gateway receivers
...
Endpoint:http://locator:8080/geode-management/v2/gateways/receivers
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
...
{"statusCode":"OK","result":[{"class":"org.apache.geode.cache.configuration.GatewayReceiverConfig","startPort":"5000","bindAddress":"localhost","manualStart":false,"uri":"/gateways/receivers/cluster"}]}
Create gateway receiver
...
Endpoint:http://locator:8080/geode-management/v2/gateways/receivers
Method: POST
Headers: Authorization
Permission Required: CLUSTER:MANAGE
...
{"startPort":"5000","group":"group1"}
...
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...