Table of Contents |
---|
Region Management
Create Region
...
|
Apache Geode Management REST API
Codegen:
brew install swagger-codegen; swagger-codegen generate -i
...
http://locator:7070/management/
...
v1/
...
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.",
} |
...
Deployment Management
GET /management/v1/deployments/{id}
GET /management/v1/deployments/{id}
Path parameters
Return type
Example data
{
"result" : {
"groups" : [ {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
}, {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Deployment_DeploymentInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/deployments
GET /management/v1/deployments
Query parameters
Return type
Example data
{
"result" : [ {
"groups" : [ {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
}, {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
}, {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Deployment_DeploymentInfo401
Unauthorized403
Forbidden404
Not Found...
Versions
GET /management
GET /management
Return type
Example data
{
"latest" : "latest",
"supported" : [ "supported", "supported" ]
}
Responses
200
OK DocLinks401
Unauthorized403
Forbidden404
Not Found...
Gateway Management
POST /management/v1/gateways/receivers
POST /management/v1/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
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Gateway receiver already exists.500
Internal error....
GET /management/v1/gateways/receivers/{id}
GET /management/v1/gateways/receivers/{id}
Path parameters
Return type
Example data
{
"result" : {
"groups" : [ {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
"key" : { }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
}, {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
"key" : { }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/gateways/receivers
GET /management/v1/gateways/receivers
Query parameters
Return type
Example data
{
"result" : [ {
"groups" : [ {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
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
...
language | yml |
---|---|
title | Success Response |
...
"
...
key" :
...
{ }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
}, {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
"key" : { }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
"key" : { }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
}, {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
"key" : { }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
Member Management
GET /management/v1/members/{id}
GET /management/v1/members/{id}
Path parameters
Return type
Example data
{
"result" : {
"groups" : [ {
"configuration" : {
"id" : "id",
"group" : "group"
},
"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"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"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"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/members
GET /management/v1/members
Query parameters
Return type
Example data
{
"result" : [ {
"groups" : [ {
"configuration" : {
"id" : "id",
"group" : "group"
},
"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"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"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"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"id" : "id",
"group" : "group"
},
"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"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"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"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
Pdx Management
POST /management/v1/configurations/pdx
POST /management/v1/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
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Pdx already configured.500
Internal error....
GET /management/v1/configurations/pdx
GET /management/v1/configurations/pdx
Return type
Example data
{
"result" : {
"groups" : [ {
"configuration" : {
"autoSerializer" : {
"patterns" : [ "patterns", "patterns" ],
"portable" : true
},
"readSerialized" : true,
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
}
},
"runtimeInfo" : [ {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
}, {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
} ]
}, {
"configuration" : {
"autoSerializer" : {
"patterns" : [ "patterns", "patterns" ],
"portable" : true
},
"readSerialized" : true,
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
}
},
"runtimeInfo" : [ {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
}, {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Pdx_PdxInfo401
Unauthorized403
Forbidden404
Not Found...
Ping
GET /management/v1/ping
GET /management/v1/ping
Return type
Example data
""
Responses
200
OK String401
Unauthorized403
Forbidden404
Not Found...
Rebalance Operation
GET /management/v1/operations/rebalances/{id}
GET /management/v1/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
} ],
"success" : true,
"statusMessage" : "statusMessage"
},
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links" : { "self" : "uri" },
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationStatusResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/operations/rebalances
GET /management/v1/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",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}, {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListOperationsResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
POST /management/v1/operations/rebalances
POST /management/v1/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",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationResult_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not Found...
Region Management
POST /management/v1/regions/{regionName}/indexes
POST /management/v1/regions/{regionName}/indexes
Path parameters
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Index already exists.500
Internal error....
POST /management/v1/indexes
POST /management/v1/indexes
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Index already exists.500
Internal error....
POST /management/v1/regions
POST /management/v1/regions
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Return type
Example data
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Region already exists.500
Internal error....
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
Path parameters
Return type
Example data
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
DELETE /management/v1/regions/{id}
DELETE /management/v1/regions/{id}
Path parameters
Query parameters
Return type
Example data
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
GET /management/v1/regions/{regionName}/indexes/{id}
GET /management/v1/regions/{regionName}/indexes/{id}
Path parameters
Return type
Example data
{
"result" : {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{id}
GET /management/v1/regions/{id}
Path parameters
Return type
Example data
{
"result" : {
"groups" : [ {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/indexes
GET /management/v1/indexes
Query parameters
Return type
Example data
{
"result" : [ {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{regionName}/indexes
GET /management/v1/regions/{regionName}/indexes
Path parameters
Query parameters
Return type
Example data
{
"result" : [ {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions
GET /management/v1/regions
Query parameters
Return type
Example data
{
"result" : [ {
"groups" : [ {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...