You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

Apache Geode Management REST API

REST API and interface to manage Geode components.
More information: http://geode.apache.org
Contact Info: dev@geode.apache.org
Version: v2
BasePath:/management/experimental/api-docs
Apache License, version 2.0
http://www.apache.org/licenses/

Access

Methods

[ Jump to Models ]

Table of Contents

GatewayManagementController

MemberManagementController

PdxManagementController

PingManagementController

RebalanceOperationController

RegionManagementController

GatewayManagementController

Up 
post /experimental/gateways/receivers
create gateway-receiver (createGatewayReceiverUsingPOST)

Consumes

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

Request body

body GatewayReceiver (required)
Body Parameter -- gatewayReceiverConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.
Up 
get /experimental/gateways/receivers/{id}
get gateway-receiver (getGatewayReceiverUsingGET)

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

Example data

Content-Type: application/json
{  "result" : {    "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    } ]  },  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/gateways/receivers
list gateway-receivers (listGatewayReceiversUsingGET)

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»

Example data

Content-Type: application/json
{  "result" : [ {    "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    } ]  } ],  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found

MemberManagementController

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

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult«Member,MemberInformation»

Example data

Content-Type: application/json
{  "result" : {    "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"    } ]  },  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementGetResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/members
list members (listMembersUsingGET)

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult«Member,MemberInformation»

Example data

Content-Type: application/json
{  "result" : [ {    "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"    } ]  } ],  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementListResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found

PdxManagementController

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

Consumes

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

Request body

body Pdx (required)
Body Parameter -- pdxType

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

PingManagementController

Up 
get /experimental/ping
ping (pingUsingGET)

Return type

String

Example data

Content-Type: application/json
""

Produces

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

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

RebalanceOperationController

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

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementOperationStatusResult«RebalanceResult»

Example data

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

Produces

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

Responses

200

OK ClusterManagementOperationStatusResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/operations/rebalances
list rebalances (listRebalancesUsingGET)

Return type

ClusterManagementListOperationsResult«RebalanceResult»

Example data

Content-Type: application/json
{  "result" : [ {    "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",    "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" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementListOperationsResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
post /experimental/operations/rebalances
start rebalance (startRebalanceUsingPOST)

Consumes

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

Request body

body RebalanceOperation (required)
Body Parameter -- operation

Return type

ClusterManagementOperationResult«RebalanceResult»

Example data

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

Produces

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

Responses

200

OK ClusterManagementOperationResult«RebalanceResult»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

RegionManagementController

Up 
post /experimental/regions
create region (createRegionUsingPOST)

Consumes

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

Request body

body Region (required)
Body Parameter -- regionConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.
Up 
delete /experimental/regions/{id}
delete region (deleteRegionUsingDELETE)

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

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

Path parameters

id (required)
Path Parameter -- id
regionName (required)
Path Parameter -- regionName

Return type

ClusterManagementGetResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{  "result" : {    "configuration" : {      "regionPath" : "regionPath",      "expression" : "expression",      "keyIndex" : true,      "name" : "name",      "group" : "group"    },    "runtimeInfo" : [ {      "memberName" : "memberName"    }, {      "memberName" : "memberName"    } ]  },  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementGetResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/regions/{id}
get region (getRegionUsingGET)

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult«Region,RuntimeRegionInfo»

Example data

Content-Type: application/json
{  "result" : {    "configuration" : {      "expirations" : [ {        "action" : "DESTROY",        "type" : "ENTRY_TIME_TO_LIVE",        "timeInSeconds" : 0      }, {        "action" : "DESTROY",        "type" : "ENTRY_TIME_TO_LIVE",        "timeInSeconds" : 0      } ],      "redundantCopies" : 6,      "keyConstraint" : "keyConstraint",      "name" : "name",      "valueConstraint" : "valueConstraint",      "type" : "PARTITION",      "diskStoreName" : "diskStoreName",      "group" : "group"    },    "runtimeInfo" : [ {      "entryCount" : 1,      "memberName" : "memberName"    }, {      "entryCount" : 1,      "memberName" : "memberName"    } ]  },  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementGetResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/indexes
list indexes (listAllIndexUsingGET)

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{  "result" : [ {    "configuration" : {      "regionPath" : "regionPath",      "expression" : "expression",      "keyIndex" : true,      "name" : "name",      "group" : "group"    },    "runtimeInfo" : [ {      "memberName" : "memberName"    }, {      "memberName" : "memberName"    } ]  }, {    "configuration" : {      "regionPath" : "regionPath",      "expression" : "expression",      "keyIndex" : true,      "name" : "name",      "group" : "group"    },    "runtimeInfo" : [ {      "memberName" : "memberName"    }, {      "memberName" : "memberName"    } ]  } ],  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/regions/{regionName}/indexes
list region indexes (listIndexUsingGET)

Path parameters

regionName (required)
Path Parameter -- regionName

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{  "result" : [ {    "configuration" : {      "regionPath" : "regionPath",      "expression" : "expression",      "keyIndex" : true,      "name" : "name",      "group" : "group"    },    "runtimeInfo" : [ {      "memberName" : "memberName"    }, {      "memberName" : "memberName"    } ]  }, {    "configuration" : {      "regionPath" : "regionPath",      "expression" : "expression",      "keyIndex" : true,      "name" : "name",      "group" : "group"    },    "runtimeInfo" : [ {      "memberName" : "memberName"    }, {      "memberName" : "memberName"    } ]  } ],  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /experimental/regions
list regions (listRegionUsingGET)

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult«Region,RuntimeRegionInfo»

Example data

Content-Type: application/json
{  "result" : [ {    "configuration" : {      "expirations" : [ {        "action" : "DESTROY",        "type" : "ENTRY_TIME_TO_LIVE",        "timeInSeconds" : 0      }, {        "action" : "DESTROY",        "type" : "ENTRY_TIME_TO_LIVE",        "timeInSeconds" : 0      } ],      "redundantCopies" : 6,      "keyConstraint" : "keyConstraint",      "name" : "name",      "valueConstraint" : "valueConstraint",      "type" : "PARTITION",      "diskStoreName" : "diskStoreName",      "group" : "group"    },    "runtimeInfo" : [ {      "entryCount" : 1,      "memberName" : "memberName"    }, {      "entryCount" : 1,      "memberName" : "memberName"    } ]  }, {    "configuration" : {      "expirations" : [ {        "action" : "DESTROY",        "type" : "ENTRY_TIME_TO_LIVE",        "timeInSeconds" : 0      }, {        "action" : "DESTROY",        "type" : "ENTRY_TIME_TO_LIVE",        "timeInSeconds" : 0      } ],      "redundantCopies" : 6,      "keyConstraint" : "keyConstraint",      "name" : "name",      "valueConstraint" : "valueConstraint",      "type" : "PARTITION",      "diskStoreName" : "diskStoreName",      "group" : "group"    },    "runtimeInfo" : [ {      "entryCount" : 1,      "memberName" : "memberName"    }, {      "entryCount" : 1,      "memberName" : "memberName"    } ]  } ],  "links" : { },  "statusMessage" : "statusMessage",  "statusCode" : "OK"}

Produces

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

Responses

200

OK ClusterManagementListResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

Models

[ Jump to Methods ]

Table of Contents

  1. CacheServerInfo - CacheServerInfo
  2. ClassName - ClassName
  3. ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
  4. ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo»
  5. ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation»
  6. ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo»
  7. ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult»
  8. ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»
  9. ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo»
  10. ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation»
  11. ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo»
  12. ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult»
  13. ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult»
  14. ClusterManagementResult - ClusterManagementResult
  15. ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
  16. ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo»
  17. ConfigurationResult«Member,MemberInformation» - ConfigurationResult«Member,MemberInformation»
  18. ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo»
  19. Expiration - Expiration
  20. GatewayReceiver - GatewayReceiver
  21. GatewayReceiverInfo - GatewayReceiverInfo
  22. Index - Index
  23. Links - Links
  24. Member - Member
  25. MemberInformation - MemberInformation
  26. Pdx - Pdx
  27. RebalanceOperation - RebalanceOperation
  28. RebalanceRegionResult - RebalanceRegionResult
  29. RebalanceResult - RebalanceResult
  30. Region - Region
  31. RuntimeInfo - RuntimeInfo
  32. RuntimeRegionInfo - RuntimeRegionInfo

CacheServerInfo - CacheServerInfo Up

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

ClassName - ClassName Up

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

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» Up

links (optional)
Links
result (optional)
ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo» Up

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

ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation» Up

links (optional)
Links
result (optional)
ConfigurationResult«Member,MemberInformation»
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo» Up

links (optional)
Links
result (optional)
ConfigurationResult«Region,RuntimeRegionInfo»
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult» Up

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

ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» Up

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

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

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

ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation» Up

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

ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo» Up

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

ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult» Up

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

ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult» Up

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

ClusterManagementResult - ClusterManagementResult Up

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

ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» Up

configuration (optional)
GatewayReceiver
links (optional)
Links
runtimeInfo (optional)
array[GatewayReceiverInfo]

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

configuration (optional)
Index
links (optional)
Links
runtimeInfo (optional)
array[RuntimeInfo]

ConfigurationResult«Member,MemberInformation» - ConfigurationResult«Member,MemberInformation» Up

configuration (optional)
Member
links (optional)
Links
runtimeInfo (optional)
array[MemberInformation]

ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo» Up

configuration (optional)
Region
links (optional)
Links
runtimeInfo (optional)
array[RuntimeRegionInfo]

Expiration - Expiration Up

action (optional)
String
Enum:
DESTROY
INVALIDATE
LEGACY
timeInSeconds (optional)
Integer format: int32
type (optional)
String
Enum:
ENTRY_TIME_TO_LIVE
ENTRY_IDLE_TIME
LEGACY

GatewayReceiver - GatewayReceiver Up

endPort (optional)
Integer format: int32
gatewayTransportFilters (optional)
array[ClassName]
group (optional)
String
manualStart (optional)
Boolean
maximumTimeBetweenPings (optional)
Integer format: int32
socketBufferSize (optional)
Integer format: int32
startPort (optional)
Integer format: int32

GatewayReceiverInfo - GatewayReceiverInfo Up

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

Index - Index Up

expression (optional)
String
group (optional)
String
keyIndex (optional)
Boolean
name (optional)
String
regionPath (optional)
String

Member - Member Up

group (optional)
String
id (optional)
String

MemberInformation - MemberInformation Up

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

Pdx - Pdx Up

diskStoreName (optional)
String
ignoreUnreadFields (optional)
Boolean
pdxSerializer (optional)
ClassName
persistent (optional)
Boolean
readSerialized (optional)
Boolean

RebalanceOperation - RebalanceOperation Up

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

RebalanceRegionResult - RebalanceRegionResult Up

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

RebalanceResult - RebalanceResult Up

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

Region - Region Up

diskStoreName (optional)
String
expirations (optional)
array[Expiration]
group (optional)
String
keyConstraint (optional)
String
name (optional)
String
redundantCopies (optional)
Integer format: int32
type (optional)
String
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
valueConstraint (optional)
String

RuntimeInfo - RuntimeInfo Up

memberName (optional)
String

RuntimeRegionInfo - RuntimeRegionInfo Up

entryCount (optional)
Long format: int64
memberName (optional)
String
  • No labels