Versions Compared

Old Version 46

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version Current

changes.mady.by.user Jinmei Liao

Saved on

Key

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

Table of Contents
maxLevel2
excludeFoo

Apache Geode Management REST API

REST API to manage Geode. This is experimental. All request/response formats are subject to change.
Swagger: http://locator:7070/management/docs (requires access to a running locator)
Codegen: brew install swagger-codegen; swagger-codegen generate -i http://locator:7070/management/v1/api-docs
More information: http://geode.apache.org

...

http://www.apache.org/licenses/

...

Deployment Management

POST

GET /management/v1/

gateways

deployments/

receivers
create gateway-receiver

Consumes

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

Request body

{id}

get deployed

Path parameters

id body GatewayReceiver (required)
Request Body Path Parameter -- id

Return type

ClusterManagementResult ClusterManagementGetResult_Deployment_DeploymentInfo

Example data

Content-Type: application/json

GET /management/v1/gateways/receivers/{id}

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult-GatewayReceiver,GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "linksresult" : {
  },
  "statusMessagegroups" : "statusMessage",[ {
      "statusCodeconfiguration" : "OK"
}

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error. 
{
  "result" : {
    "configuration" : {
{
        "deployedTime" : "deployedTime",
        "startPortdeployedBy" : 5"deployedBy",
        "gatewayTransportFiltersjarFileName" : [ {"jarFileName",
        "initPropertiesgroup" : {"group"
      },
      "keyruntimeInfo" : [ {
 }
       "jarLocation" : }"jarLocation",
        "classNamememberName" : "classNamememberName",
      }, {
 "lastModified" : "lastModified"
     "initProperties" :}, {
        "jarLocation" : "keyjarLocation",
 : { }
     "memberName" :  }"memberName",
        "classNamelastModified" : "classNamelastModified"
      } ]
    }, {
      "manualStartconfiguration" : true,{
        "maximumTimeBetweenPingsdeployedTime" : 6"deployedTime",
        "endPortdeployedBy" : 0"deployedBy",
        "socketBufferSizejarFileName" : 1"jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSendersjarLocation" : [ "connectedSendersjarLocation",
 "connectedSenders" ],
      "runningmemberName" : true"memberName",
      "port" : 5,
      "hostnameForSenderslastModified" : "hostnameForSenderslastModified",
      "memberName" : "memberName",
}, {
        "bindAddressjarLocation" : "bindAddressjarLocation",
        "senderCountmemberName" : 2"memberName",
    }, {
      "connectedSenderslastModified" : [ "connectedSenders", "connectedSenders" ],lastModified"
      "running" : true,} ]
      "port" : 5} ],
      "hostnameForSendersid" : "hostnameForSendersid",
      "memberName" : "memberName"},
      "bindAddresslinks" : "bindAddress",
      "senderCount{ "self" : 2
    } ]
  },
  "links" : { "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult-GatewayReceiver,GatewayReceiverInfo_Deployment_DeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/

gateways/receivers

deployments

list gateway-receiversdeployed

Query parameters

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

Return type

ClusterManagementListResult-GatewayReceiver,GatewayReceiverInfo_Deployment_DeploymentInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "startPortconfiguration" : 5,{
        "gatewayTransportFiltersdeployedTime" : [ {"deployedTime",
        "initPropertiesdeployedBy" : {"deployedBy",
          "keyjarFileName" : { }
        }"jarFileName",
        "classNamegroup" : "classNamegroup"
      }, {
        "initPropertiesruntimeInfo" : [ {
        "jarLocation" : "keyjarLocation" :,
 { }
      "memberName" : }"memberName",
        "classNamelastModified" : "classNamelastModified"
      }, ],{
        "manualStartjarLocation" : true"jarLocation",
        "maximumTimeBetweenPingsmemberName" : 6"memberName",
        "endPortlastModified" : 0,"lastModified"
      "socketBufferSize" : 1,} ]
      "group" : "group"}, {
    },
    "runtimeInfoconfiguration" : [ {
        "connectedSendersdeployedTime" : [ "connectedSendersdeployedTime",
 "connectedSenders" ],
      "runningdeployedBy" : true"deployedBy",
        "portjarFileName" : 5"jarFileName",
        "hostnameForSendersgroup" : "hostnameForSendersgroup",
      "memberName" : "memberName"},
      "bindAddressruntimeInfo" : "bindAddress", [ {
        "senderCountjarLocation" : 2"jarLocation",
    }, {
      "connectedSendersmemberName" : [ "connectedSendersmemberName",
 "connectedSenders" ],
      "runninglastModified" : true,"lastModified"
      "port" : 5,
}, {
        "hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
        "memberName" : "memberName",
        "bindAddresslastModified" : "bindAddresslastModified",
      "senderCount" : 2
} ]
     } ]
  }, {
    "configurationid" : {"id"
  }, {
    "startPortgroups" : 5,[ {
      "gatewayTransportFiltersconfiguration" : [ {
        "initPropertiesdeployedTime" : {"deployedTime",
        "deployedBy" : "keydeployedBy",
 : { }
     "jarFileName" :  }"jarFileName",
        "classNamegroup" : "classNamegroup"
      }, {
        "initPropertiesruntimeInfo" : [ {
        "jarLocation" : "keyjarLocation",
 : { }
     "memberName" :  }"memberName",
        "classNamelastModified" : "classNamelastModified"
      }, ],{
        "manualStartjarLocation" : true"jarLocation",
        "maximumTimeBetweenPingsmemberName" : 6"memberName",
        "endPortlastModified" : 0,"lastModified"
       "socketBufferSize" : 1,} ]
    }, {
      "groupconfiguration" : "group"
{
    },
    "runtimeInfodeployedTime" : "deployedTime",
 [ {
      "connectedSendersdeployedBy" : [ "connectedSendersdeployedBy",
 "connectedSenders" ],
      "runningjarFileName" : true"jarFileName",
      "port" : 5,
      "hostnameForSendersgroup" : "hostnameForSendersgroup",
      "memberName" : "memberName"},
      "bindAddressruntimeInfo" : "bindAddress",[ {
        "senderCountjarLocation" : 2"jarLocation",
    }, {
      "connectedSendersmemberName" : [ "connectedSendersmemberName",
 "connectedSenders" ],
      "runninglastModified" : true,"lastModified"
      "port" : 5,
}, {
        "hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
        "memberName" : "memberName",
        "bindAddresslastModified" : "bindAddresslastModified",
      "senderCount" : 2} ]
    } ],
  }   "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult-GatewayReceiver,GatewayReceiverInfo_Deployment_DeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Versions

GET /management

/v1/members/{id}
get member

Path parameters

id (required)

get documentation-links
Path Parameter -- id 
Return type
 ClusterManagementGetResult-Member,MemberInformation DocLinks
Example data
Content-Type: application/json
{
  "resultlatest" : {
    "configuration" : {
 latest",
     "idsupported" : [ "idsupported",
      "groupsupported" ]
}
Responses
200
 OK DocLinks 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Gateway Management
POST /management/v1/gateways/receivers
create gateway-receiver
Consumes
 This API call consumes the following media types via the Content-Type request header: 
  • application/json
Request body
body GatewayReceiver (required)
Request Body 
Return type
 ClusterManagementResult 
Example data
Content-Type: application/json
{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Gateway receiver already exists. 
500
 Internal error. 
...
GET /management/v1/gateways/receivers/{id}
get gateway-receiver
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo 
Example data
Content-Type: application/json
{
  "result" : {
    "groups" : [ {: "group"
    },
    "runtimeInfo" : [ {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
      "hostconfiguration" : "host",{
        "maxHeapSizestartPort" : 25,
        "workingDirPathgatewayTransportFilters" : "workingDirPath",[ {
          "idinitProperties" : "id",{
      "clientCount      "key" : { 5,}
      "httpServicePort"   : 7},
          "cacheServerInfoclassName" : [ {
"className"
         "running" : true,
}, {
          "portinitProperties" : 1,
{
            "maxThreadskey" : 6,{ }
        "bindAddress" : "bindAddress"},
          "maxConnectionsclassName" : 0"className"
        } ], {
        "runningmanualStart" : true,
        "portmaximumTimeBetweenPings" : 16,
        "maxThreadsendPort" : 60,
        "bindAddresssocketBufferSize" : "bindAddress"1,
        "maxConnectionsgroup" : 0"group"
      } ],
      "coordinatorruntimeInfo" : true,
[ {
        "groupsconnectedSenders" : [ "connectedSenders", "groupsconnectedSenders" ],
        "serverBindAddressrunning" : "serverBindAddress"true,
        "cacheXmlFilePathport" : "cacheXmlFilePath"5,
        "locatorPorthostnameForSenders" : 3"hostnameForSenders",
        "heapUsagememberName" : 2"memberName",
      "initHeapSize" : 9,
      "logFilePathbindAddress" : "logFilePathbindAddress",
        "offHeapMemorySizesenderCount" : "offHeapMemorySize",2
       "secured" : true,
}, {
        "statArchiveFilePathconnectedSenders" : [ "statArchiveFilePathconnectedSenders",
      "statusconnectedSenders" : "status"],
    }, {
      "cpuUsagerunning" : 5.637376656633329true,
        "serverport" : true5,
        "httpServiceBindAddresshostnameForSenders" : "httpServiceBindAddresshostnameForSenders",
        "memberName" : "memberName",
        "locatorsbindAddress" : "locatorsbindAddress",
        "processIdsenderCount" : 4,2
       "webSSL" : true,} ]
    }, {
      "hostedRegionsconfiguration" : [ "hostedRegions", "hostedRegions" ],
{
        "hoststartPort" : "host"5,
        "maxHeapSizegatewayTransportFilters" : 2,[ {
          "workingDirPathinitProperties" : "workingDirPath",{
      "id" : "id",
      "clientCountkey" : { 5,}
      "httpServicePort"   : 7},
          "cacheServerInfoclassName" : [ {"className"
        "running" : true,
}, {
          "portinitProperties" : 1,{
            "maxThreadskey" : { 6,}
        "bindAddress" : "bindAddress"},
          "maxConnectionsclassName" : 0"className"
        } ], {
        "runningmanualStart" : true,
        "portmaximumTimeBetweenPings" : 16,
        "maxThreadsendPort" : 60,
        "bindAddresssocketBufferSize" : "bindAddress"1,
        "maxConnectionsgroup" : 0"group"
      } ],
      "coordinatorruntimeInfo" : [ true,{
        "groupsconnectedSenders" : [ "groups"connectedSenders", "connectedSenders" ],
        "serverBindAddressrunning" : "serverBindAddress"true,
        "cacheXmlFilePathport" : "cacheXmlFilePath"5,
        "locatorPorthostnameForSenders" : 3"hostnameForSenders",
        "heapUsagememberName" : 2"memberName",
        "initHeapSizebindAddress" : 9"bindAddress",
        "logFilePathsenderCount" : "logFilePath",2
      }, {
        "offHeapMemorySizeconnectedSenders" : [ "offHeapMemorySize"connectedSenders", "connectedSenders" ],
        "securedrunning" : true,
        "statArchiveFilePathport" : "statArchiveFilePath"5,
        "statushostnameForSenders" : "statushostnameForSenders",
    } ]
  },
  "linksmemberName" : { }"memberName",
        "statusMessagebindAddress" : "bindAddress",
        "senderCount" : 2
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementGetResult-Member,MemberInformation_GatewayReceiver_GatewayReceiverInfo
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/gateways/
members
receivers
list membersgateway-receivers
Query parameters
group (optional)
Query Parameter -- group 
id (optional)
Query Parameter -- id 
Return type
ClusterManagementListResult-Member,MemberInformation_GatewayReceiver_GatewayReceiverInfo
Example data
Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "idconfiguration" : "id",{
        "groupstartPort" : "group"5,
    },
    "runtimeInfogatewayTransportFilters" : [ {
          "cpuUsageinitProperties" : 5.637376656633329,
{
            "serverkey" : { true,}
      "httpServiceBindAddress"   : "httpServiceBindAddress"},
          "memberNameclassName" : "memberNameclassName",
      "locators" : "locators"}, {
          "processIdinitProperties" : 4,
{
            "webSSLkey" : true,{ }
       "hostedRegions" : [ "hostedRegions"},
 "hostedRegions" ],
         "hostclassName" : "hostclassName",
      "maxHeapSize"  :} 2],
        "workingDirPathmanualStart" : "workingDirPath"true,
        "idmaximumTimeBetweenPings" : "id"6,
        "clientCountendPort" : 50,
        "httpServicePortsocketBufferSize" : 71,
        "cacheServerInfogroup" : [ {"group"
        "running" : true},
        "portruntimeInfo" : 1,[ {
        "maxThreadsconnectedSenders" : 6,
        "bindAddress" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
        "maxConnectionsrunning" : 0
      }, {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, ],{
        "coordinatorconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
        "groupsrunning" : "groups"true,
        "serverBindAddressport" : "serverBindAddress"5,
        "cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
        "locatorPortmemberName" : 3"memberName",
        "heapUsagebindAddress" : 2"bindAddress",
        "initHeapSizesenderCount" : 9,2
      } ]
  "logFilePath" : "logFilePath"}, {
      "offHeapMemorySizeconfiguration" : "offHeapMemorySize",
{
        "securedstartPort" : true5,
        "statArchiveFilePathgatewayTransportFilters" : "statArchiveFilePath",
 [ {
          "statusinitProperties" : "status"{
     }, {
      "cpuUsagekey" : 5.637376656633329, { }
      "server"   : true},
          "httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
      "memberName" : "memberName"}, {
          "locatorsinitProperties" : "locators",
{
            "processIdkey" : 4,{ }
      "webSSL"   : true},
       "hostedRegions" : [ "hostedRegionsclassName", : "hostedRegionsclassName"
 ],
      "host } ],
        "manualStart" : "host"true,
        "maxHeapSizemaximumTimeBetweenPings" : 26,
        "workingDirPathendPort" : "workingDirPath"0,
        "idsocketBufferSize" : "id"1,
        "clientCountgroup" : 5 "group"
      },
      "httpServicePortruntimeInfo" : [ 7,{
        "cacheServerInfoconnectedSenders" : [ { "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, {
        "runningconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
        "portrunning" : 1true,
        "maxThreadsport" : 65,
        "bindAddresshostnameForSenders" : "bindAddresshostnameForSenders",
        "maxConnectionsmemberName" : 0"memberName",
      } ],
   "bindAddress" : "bindAddress",
        "coordinatorsenderCount" : true,2
      } ]
   "groups" :} "groups"],
      "serverBindAddressid" : "serverBindAddressid",
  }, {
    "cacheXmlFilePathgroups" : "cacheXmlFilePath", [ {
      "locatorPortconfiguration" : 3,{
        "heapUsagestartPort" : 25,
        "initHeapSizegatewayTransportFilters" : 9,
[ {
          "logFilePathinitProperties" : "logFilePath",{
      "offHeapMemorySize" : "offHeapMemorySize",
      "securedkey" : true,{ }
       "statArchiveFilePath"  : "statArchiveFilePath"},
          "statusclassName" : "statusclassName"
     } ]
  }, {
          "configurationinitProperties" : {
      "id"  : "id",
    "key" : { }
          },
          "groupclassName" : "groupclassName"
    },
    "runtimeInfo" : [ {
} ],
        "cpuUsagemanualStart" : 5.637376656633329true,
        "servermaximumTimeBetweenPings" : true6,
        "httpServiceBindAddressendPort" : "httpServiceBindAddress"0,
        "memberNamesocketBufferSize" : "memberName"1,
        "locatorsgroup" : "locatorsgroup",
      "processId" : 4},
      "webSSLruntimeInfo" : true,
[ {
        "hostedRegionsconnectedSenders" : [ "hostedRegionsconnectedSenders", "hostedRegionsconnectedSenders" ],
        "hostrunning" : "host"true,
        "maxHeapSizeport" : 25,
        "workingDirPathhostnameForSenders" : "workingDirPathhostnameForSenders",
        "idmemberName" : "idmemberName",
        "clientCountbindAddress" : 5"bindAddress",
        "httpServicePortsenderCount" : 7,2
      }, {
        "cacheServerInfoconnectedSenders" : [ { "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 15,
        "maxThreadshostnameForSenders" : 6"hostnameForSenders",
        "bindAddressmemberName" : "bindAddressmemberName",
        "maxConnectionsbindAddress" : 0"bindAddress",
       }, { "senderCount" : 2
      } ]
 "running"  : true}, {
        "portconfiguration" : 1,{
        "maxThreadsstartPort" : 65,
        "bindAddressgatewayTransportFilters" : "bindAddress",
 [ {
          "maxConnectionsinitProperties" : 0{
      } ],
      "coordinatorkey" : true,
{ }
        "groups" : "groups"},
          "serverBindAddressclassName" : "serverBindAddressclassName",
      "cacheXmlFilePath" : "cacheXmlFilePath"}, {
          "locatorPortinitProperties" : 3,{
      "heapUsage      "key" : { 2,}
      "initHeapSize"   : 9},
          "logFilePathclassName" : "logFilePathclassName",
      "offHeapMemorySize"  :} "offHeapMemorySize"],
        "securedmanualStart" : true,
        "statArchiveFilePathmaximumTimeBetweenPings" : "statArchiveFilePath"6,
        "statusendPort" : "status"
  0,
  }, {
      "cpuUsagesocketBufferSize" : 5.6373766566333291,
        "servergroup" : true,"group"
      "httpServiceBindAddress" : "httpServiceBindAddress"},
      "memberNameruntimeInfo" : "memberName",[ {
        "locatorsconnectedSenders" : [ "locators""connectedSenders", "connectedSenders" ],
        "processIdrunning" : 4true,
        "webSSLport" : true5,
        "hostedRegionshostnameForSenders" : [ "hostedRegionshostnameForSenders",
 "hostedRegions" ],
      "hostmemberName" : "hostmemberName",
        "maxHeapSizebindAddress" : 2"bindAddress",
        "workingDirPathsenderCount" : "workingDirPath",2
      "id" : "id",
}, {
        "clientCountconnectedSenders" : 5,
      "httpServicePort" : 7[ "connectedSenders", "connectedSenders" ],
        "cacheServerInforunning" : [ {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, {]
    } ],
    "runningid" : true,"id"
  } ],
  "links" : { "portself" : 1"uri" },
        "maxThreadsstatusMessage" : 6"statusMessage",
        "bindAddress"statusCode" : "bindAddressOK"
}
Responses
200
 OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Member Management
GET /management/v1/members/{id}
get member
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementGetResult_Member_MemberInformation 
Example data
Content-Type: application/json
{
  "result,
        "maxConnections" : 0{
    "groups" : }[ ],{
      "coordinatorconfiguration" : true,{
        "groupsid" : "groupsid",
        "serverBindAddressgroup" : "serverBindAddressgroup",
      "cacheXmlFilePath" : "cacheXmlFilePath"},
      "locatorPortruntimeInfo" : [ 3,{
        "heapUsagecpuUsage" : 25.637376656633329,
        "initHeapSizeserver" : 9true,
        "logFilePathhttpServiceBindAddress" : "logFilePathhttpServiceBindAddress",
        "offHeapMemorySizememberName" : "offHeapMemorySizememberName",
        "securedlocators" : true"locators",
        "statArchiveFilePathprocessId" : 4,
        "statArchiveFilePathwebSSL" : true,
        "statushostedRegions" : [ "status""hostedRegions", "hostedRegions" ],
    }   ]
 "host" }: ]"host",
        "linksmaxHeapSize" : { }2,
        "statusMessageworkingDirPath" : "statusMessageworkingDirPath",
  "statusCode      "id" : "OKid"
}
Responses
200
 OK ClusterManagementListResult-Member,MemberInformation 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
Pdx Management
POST /management/v1/configurations/pdx
configure pdx
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"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Pdx already configured. 
500
 Internal error. 
Ping
GET /management/v1/ping
ping
Return type
 String 
Example data
Content-Type: application/json
""
Responses
200
 OK String 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
Rebalance Operation
GET /management/v1/operations/rebalances/{id}
check rebalance
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementOperationStatusResult-RebalanceResult 
Example data
Content-Type: application/json
{
  "result" : {
    "rebalanceRegionResults" : [ {
,
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bucketCreateTimeInMillisecondsbindAddress" : 6"bindAddress",
          "primaryTransferTimeInMillisecondsmaxConnections" : 7,0
       "bucketCreatesCompleted" :} 1],
        "bucketTransfersCompletedcoordinator" : 2true,
        "bucketCreateBytesgroups" : 0"groups",
        "regionNameserverBindAddress" : "regionNameserverBindAddress",
        "bucketTransferTimeInMillisecondscacheXmlFilePath" : 5"cacheXmlFilePath",
        "timeInMillisecondslocatorPort" : 3,
        "primaryTransfersCompletedheapUsage" : 92,
        "bucketTransferBytesinitHeapSize" : 5
9,
        }, {
"logFilePath" : "logFilePath",
        "bucketCreateTimeInMillisecondsoffHeapMemorySize" : 6"offHeapMemorySize",
        "primaryTransferTimeInMillisecondssecured" : 7true,
        "bucketCreatesCompletedstatArchiveFilePath" : 1"statArchiveFilePath",
        "bucketTransfersCompletedstatus" : 2,
 "status"
      }, {
        "bucketCreateBytescpuUsage" : 05.637376656633329,
        "regionNameserver" : "regionName"true,
        "bucketTransferTimeInMillisecondshttpServiceBindAddress" : 5"httpServiceBindAddress",
        "timeInMillisecondsmemberName" : 3"memberName",
        "primaryTransfersCompletedlocators" : 9"locators",
        "bucketTransferBytesprocessId" : 54,
    } ],
    "statusMessagewebSSL" : "statusMessage"true,
  },
      "operationEndedhostedRegions" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"[ "hostedRegions", "hostedRegions" ],
  "operationStart      "host" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXhost",
        "linksmaxHeapSize" : { }2,
  "operator      "workingDirPath" : "operatorworkingDirPath",
        "statusMessageid" : "statusMessageid",
        "statusCodeclientCount" : 5,
        "OKhttpServicePort"
}
Responses
200
 OK ClusterManagementOperationStatusResult-RebalanceResult 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
GET /management/v1/operations/rebalances
list rebalances
Return type
 ClusterManagementListOperationsResult-RebalanceResult 
Example data
Content-Type: application/json
GET /management/v1/regions/{regionName}/indexes/{id}
get index
Path parameters
id (required)
Path Parameter -- id 
regionName (required)
Path Parameter -- regionName 
Return type
 ClusterManagementGetResult-Index,RuntimeInfo 
Example data
Content-Type: application/json
{
  "result" : [ {
 : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "operationEndedport" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
1,
          "operationStartmaxThreads" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
6,
          "operationIdbindAddress" : "operationIdbindAddress",
    "operator" : "operator",
    "statusMessagemaxConnections" : "statusMessage",0
    "statusCode" : "OK"
  }, {
    "operationEnded"   : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
   "running" : true,
          "operationStartport" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
1,
          "operationIdmaxThreads" : "operationId"6,
          "operatorbindAddress" : "operatorbindAddress",
          "statusMessagemaxConnections" : "statusMessage",
 0
        } ],
        "statusCodecoordinator" : "OK"
true,
     } ],
  "linksgroups" : { }"groups",
        "statusMessageserverBindAddress" : "statusMessageserverBindAddress",
        "statusCodecacheXmlFilePath" : "OKcacheXmlFilePath"
}
Responses
200
 OK ClusterManagementListOperationsResult-RebalanceResult 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
POST /management/v1/operations/rebalances
start rebalance
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"
}
Responses
200
 OK ClusterManagementOperationResult-RebalanceResult 
201
 Created 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
Region Management
POST /management/v1/regions
create region
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"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Region already exists. 
500
 Internal error. 
DELETE /management/v1/regions/{id}
delete region
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"
}
Responses
200
 OK ClusterManagementResult 
204
 No Content 
401
 Unauthorized 
403
 Forbidden 
GET /management/v1/regions/{id}
get region
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementGetResult-Region,RuntimeRegionInfo 
Example data
Content-Type: application/json
{
  "result" : {
    "configuration" : {
      "regionPath" : "regionPath",
      "expression" : "expression,
        "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",
        "keyIndexmaxHeapSize" : true2,
        "nameworkingDirPath" : "nameworkingDirPath",
        "groupid" : "groupid",
    },
    "runtimeInfoclientCount" : [ {
5,
        "memberNamehttpServicePort" : "memberName"
7,
       }, "cacheServerInfo" : [ {
          "memberNamerunning" : true,
          "memberNameport" : 1,
    }  ]
  },
  "linksmaxThreads" : { }6,
          "statusMessagebindAddress" : "statusMessagebindAddress",
    "statusCode      "maxConnections" : "OK"
}
Responses
200
 OK ClusterManagementGetResult-Index,RuntimeInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
{
  "result" : {
    "configuration" : {
 0
        }, {
          "running" : true,
          "expirationsport" : [ {
1,
          "actionmaxThreads" : "DESTROY"6,
          "typebindAddress" : "ENTRY_TIME_TO_LIVEbindAddress",
          "timeInSecondsmaxConnections" : 0
        } ], {
        "actioncoordinator" : "DESTROY"true,
        "typegroups" : "ENTRY_TIME_TO_LIVEgroups",
        "timeInSecondsserverBindAddress" : 0
      } ],
"serverBindAddress",
        "redundantCopiescacheXmlFilePath" : 6"cacheXmlFilePath",
        "keyConstraintlocatorPort" : "keyConstraint"3,
        "nameheapUsage" : "name"2,
      "valueConstraint  "initHeapSize" : 9,
        "logFilePath" : "valueConstraintlogFilePath",
        "typeoffHeapMemorySize" : "offHeapMemorySize",
        "PARTITIONsecured" : true,
        "diskStoreNamestatArchiveFilePath" : "diskStoreNamestatArchiveFilePath",
        "groupstatus" : "groupstatus"
      }, {
        "runtimeInfocpuUsage" : 5.637376656633329,
 [ {
      "entryCountserver" : 1true,
        "memberNamehttpServiceBindAddress" : "memberNamehttpServiceBindAddress",
    }, {
      "entryCountmemberName" : 1"memberName",
        "memberNamelocators" : "memberNamelocators",
    } ]
  },
  "linksprocessId" : { }4,
        "statusMessagewebSSL" : "statusMessage"true,
        "statusCodehostedRegions" : [ "OK"
}
Responses
200
 OK ClusterManagementGetResult-Region,RuntimeRegionInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
GET /management/v1/indexes
list indexes
Query parameters
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult-Index,RuntimeInfo 
Example data
Content-Type: application/json
{
  "result" : [ {
hostedRegions", "hostedRegions" ],
        "configurationhost" : {"host",
        "regionPathmaxHeapSize" : "regionPath"2,
        "expressionworkingDirPath" : "expressionworkingDirPath",
        "keyIndexid" : true"id",
        "nameclientCount" : "name"5,
        "grouphttpServicePort" : "group"7,
    },
    "runtimeInfocacheServerInfo" : [ {
          "memberNamerunning" : "memberName"true,
    }, {
      "memberNameport" : "memberName"1,
    } ]
  }, {
    "configurationmaxThreads" : {6,
          "regionPathbindAddress" : "regionPathbindAddress",
          "expressionmaxConnections" : "expression",0
      "keyIndex" : true}, {
          "namerunning" : "name"true,
          "groupport" : "group"1,
    },
      "runtimeInfomaxThreads" : [ {
6,
          "memberNamebindAddress" : "memberNamebindAddress",
    }, {
      "memberNamemaxConnections" : "memberName"0
     } ]
  } ],
        "linkscoordinator" : { }true,
        "statusMessagegroups" : "statusMessagegroups",
        "statusCodeserverBindAddress" : "OK"
}
Responses
200
 OK ClusterManagementListResult-Index,RuntimeInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
GET /management/v1/regions/{regionName}/indexes
list region indexes
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" : [ {
serverBindAddress",
        "configurationcacheXmlFilePath" : {"cacheXmlFilePath",
        "regionPathlocatorPort" : "regionPath"3,
        "expressionheapUsage" : "expression"2,
        "keyIndexinitHeapSize" : true9,
        "namelogFilePath" : "namelogFilePath",
        "groupoffHeapMemorySize" : "groupoffHeapMemorySize",
    },
    "runtimeInfosecured" : true,
 [ {
      "memberNamestatArchiveFilePath" : "memberNamestatArchiveFilePath",
    }, {
      "memberNamestatus" : "memberNamestatus"
    } ]
  }, {]
    "configuration" : {
      "regionPath" : "regionPath"} ],
      "expressionid" : "expressionid",
      "keyIndex" : true},
      "namelinks" : "name",
      "group{ "self" : "groupuri"
    },
    "runtimeInfo" : [ {
      "memberName""statusMessage" : "memberName"
    }, {
   statusMessage",
   "memberNamestatusCode" : "memberNameOK"
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
}
Responses
200
 OK ClusterManagementListResult-Index,RuntimeInfo ClusterManagementGetResult_Member_MemberInformation 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/
regions
members
list regionsmembers
Query parameters
group (optional)
Query Parameter -- group 
id (optional)
Query Parameter -- id 
Return type
ClusterManagementListResult-Region,RuntimeRegionInfo_Member_MemberInformation
Example data
Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "expirationsconfiguration" : [ {
        "actionid" : "DESTROYid",
        "typegroup" : "ENTRY_TIME_TO_LIVE",group"
      },
      "timeInSecondsruntimeInfo" : [ 0{
        "cpuUsage" : }5.637376656633329, {
        "actionserver" : "DESTROY"true,
        "typehttpServiceBindAddress" : "ENTRY_TIME_TO_LIVEhttpServiceBindAddress",
        "timeInSecondsmemberName" : 0"memberName",
      } ],
   "locators" : "locators",
        "redundantCopiesprocessId" : 64,
        "keyConstraintwebSSL" : "keyConstraint"true,
        "namehostedRegions" : [ "name"hostedRegions", "hostedRegions" ],
        "valueConstrainthost" : "valueConstrainthost",
        "typemaxHeapSize" : "PARTITION"2,
        "diskStoreNameworkingDirPath" : "diskStoreNameworkingDirPath",
        "groupid" : "groupid",
    },
    "runtimeInfoclientCount" : 5,
 [ {
      "entryCounthttpServicePort" : 17,
        "memberNamecacheServerInfo" : [ {
   "memberName"
        "running" : true,
   }, {
      "entryCountport" : 1,
          "memberNamemaxThreads" : 6,
          "memberNamebindAddress"
 :   } ]
  }, {
    "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"
}
Responses
200
 OK ClusterManagementListResult-Region,RuntimeRegionInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
Models
CacheServerInfo 
bindAddress (optional)
String 
maxConnections (optional)
Integer format: int32
maxThreads (optional)
Integer format: int32
port (optional)
Integer format: int32
running (optional)
Boolean 
ClassName 
className (optional)
String 
initProperties (optional)
map[String, Object] 
"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_MemberInformation 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Pdx Management
POST /management/v1/configurations/pdx
configure pdx
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" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Pdx already configured. 
500
 Internal error. 
...
GET /management/v1/configurations/pdx
get pdx
Return type
 ClusterManagementGetResult_Pdx_PdxInfo 
Example data
Content-Type: application/json
{
  "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_PdxInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Ping
GET /management/v1/ping
ping
Return type
 String 
Example data
Content-Type: application/json
""
Responses
200
 OK String 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Rebalance Operation
GET /management/v1/operations/rebalances/{id}
check rebalance
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
    } ],
    "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_RebalanceResult 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/operations/rebalances
list rebalances
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" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementListOperationsResult_RebalanceResult 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
POST /management/v1/operations/rebalances
start rebalance
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"
}
Responses
200
 OK ClusterManagementOperationResult_RebalanceResult 
201
 Created 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Region Management
POST /management/v1/regions/{regionName}/indexes
create region index
Path parameters
regionName (required)
Path Parameter -- regionName 
Consumes
 This API call consumes the following media types via the Content-Type request header: 
  • application/json
Request body
body Index (required)
Body Parameter -- indexConfig 
Return type
 ClusterManagementResult 
Example data
Content-Type: application/json
{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Index already exists. 
500
 Internal error. 
...
POST /management/v1/indexes
create index
Consumes
 This API call consumes the following media types via the Content-Type request header: 
  • application/json
Request body
body Index (required)
Body Parameter -- indexConfig 
Return type
 ClusterManagementResult 
Example data
Content-Type: application/json
{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Index already exists. 
500
 Internal error. 
...
POST /management/v1/regions
create region
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" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
409
 Region already exists. 
500
 Internal error. 
...
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
delete region index
Path parameters
indexName (required)
Path Parameter -- indexName 
regionName (required)
Path Parameter -- regionName 
Return type
 ClusterManagementResult 
Example data
Content-Type: application/json
{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
204
 No Content 
401
 Unauthorized 
403
 Forbidden 
...
DELETE /management/v1/regions/{id}
delete region
Path parameters
id (required)
Path Parameter -- id 
Query parameters
group (optional)
Query Parameter -- group 
Return type
 ClusterManagementResult 
Example data
Content-Type: application/json
{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementResult 
204
 No Content 
401
 Unauthorized 
403
 Forbidden 
...
GET /management/v1/regions/{regionName}/indexes/{id}
get index
Path parameters
id (required)
Path Parameter -- id 
regionName (required)
Path Parameter -- regionName 
Return type
 ClusterManagementGetResult_Index_IndexInfo 
Example data
Content-Type: application/json
{
  "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_IndexInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/regions/{id}
get region
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementGetResult_Region_RuntimeRegionInfo 
Example data
Content-Type: application/json
{
  "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_RuntimeRegionInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/indexes
list indexes
Query parameters
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult_Index_IndexInfo 
Example data
Content-Type: application/json
{
  "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_IndexInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/regions/{regionName}/indexes
list region indexes
Path parameters
regionName (required)
Path Parameter -- regionName 
Query parameters
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult_Index_IndexInfo 
Example data
Content-Type: application/json
{
  "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_IndexInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/regions
list regions
Query parameters
group (optional)
Query Parameter -- group 
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult_Region_RuntimeRegionInfo 
Example data
Content-Type: application/json
{
  "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_RuntimeRegionInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Models
AutoSerializer 
portable (optional)
Boolean 
patterns (optional)
array[String] 
CacheServerInfo 
bindAddress (optional)
String 
maxConnections (optional)
Integer format: int32
maxThreads (optional)
Integer format: int32
port (optional)
Integer format: int32
running (optional)
Boolean 
ClassName 
className (optional)
String 
initProperties (optional)
map[String, Object] 
ClusterManagementGetResult_Deployment_DeploymentInfo 
links (optional)
Links 
result (optional)
EntityInfo_Deployment_DeploymentInfo 
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_GatewayReceiver_GatewayReceiverInfo 
links (optional)
Links 
result (optional)
EntityInfo_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_IndexInfo 
links (optional)
Links 
result (optional)
EntityInfo_Index_IndexInfo 
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 
links (optional)
Links 
result (optional)
EntityInfo_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_Pdx_PdxInfo 
links (optional)
Links 
result (optional)
EntityInfo_Pdx_PdxInfo 
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 
links (optional)
Links 
result (optional)
EntityInfo_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 
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_Deployment_DeploymentInfo 
ClusterManagementGetResult-GatewayReceiver,GatewayReceiverInfo 
links (optional)
Links 
result (optional)
ConfigurationResult-GatewayReceiver,GatewayReceiverInfo array[EntityInfo_Deployment_DeploymentInfo]
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 
ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo 
links (optional)
Links 
result (optional)
ConfigurationResult-Index,RuntimeInfo array[EntityInfo_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-Member,MemberInformation 
ClusterManagementListResult_Index_IndexInfo 
links (optional)
Links 
result (optional)
ConfigurationResult-Member,MemberInformation array[EntityInfo_Index_IndexInfo]
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 
ClusterManagementListResult_Member_MemberInformation 
links (optional)
Links 
result (optional)
ConfigurationResult-Region,RuntimeRegionInfo array[EntityInfo_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 
ClusterManagementListOperationsResult-RebalanceResult 
ClusterManagementListResult_Region_RuntimeRegionInfo 
links (optional)
Links 
result (optional)
array[ClusterManagementOperationResult-RebalanceResultEntityInfo_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 
ClusterManagementListResult-GatewayReceiver,GatewayReceiverInfo 
ClusterManagementOperationResult_RebalanceResult 
links (optional)
Links
operationEnded (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String 
operationStart result (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String 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
_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String 
ClusterManagementOperationStatusResult_RebalanceResult 
links (optional)
Links 
operationEnded (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart statusMessage (optional)
String 
ClusterManagementListResult-Index,RuntimeInfo 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator links (optional)
Links String
result (optional)
array[ConfigurationResult-Index,RuntimeInfo] 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-Member,MemberInformation 
ClusterManagementResult 
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 
Deployment 
deployedBy links (optional)
Links String
result deployedTime (optional)
array[ConfigurationResult-Region,RuntimeRegionInfo] 
String 
group statusCode (optional)
String 
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
jarFileName (optional)
String 
DeploymentInfo 
jarLocation (optional)
String 
lastModified (optional)
String 
memberName statusMessage (optional)
String 
ClusterManagementOperationResult-RebalanceResult 
links latest (optional)
Links String
operationEnded supported (optional)
array[String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
]
EntityGroupInfo_Deployment_DeploymentInfo 
configuration operationId (optional)
String Deployment
operationStart runtimeInfo (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
array[DeploymentInfo] 
EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo 
configuration operator (optional)
String GatewayReceiver
statusCode runtimeInfo (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 
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 
array[GatewayReceiverInfo] 
EntityGroupInfo_Index_IndexInfo 
configuration (optional)
Index 
runtimeInfo (optional)
array[IndexInfo] 
EntityGroupInfo_Member_MemberInformation 
configuration (optional)
Member 
runtimeInfo (optional)
array[MemberInformation] 
EntityGroupInfo_Pdx_PdxInfo 
configuration (optional)
Pdx 
runtimeInfo (optional)
array[PdxInfo] 
EntityGroupInfo_Region_RuntimeRegionInfo 
configuration (optional)
Region 
runtimeInfo (optional)
array[RuntimeRegionInfo] 
EntityInfo_Deployment_DeploymentInfo 
groups (optional)
array[EntityGroupInfo_Deployment_DeploymentInfo] 
id (optional)
String 
links (optional)
Links 
EntityInfo_GatewayReceiver_GatewayReceiverInfo 
groups (optional)
array[EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo] 
id (optional)
String 
links (optional)
Links 
EntityInfo_Index_IndexInfo 
groups (optional)
array[EntityGroupInfo_Index_IndexInfo] 
id (optional)
String 
ClusterManagementResult 
links (optional)
Links 
EntityInfo_Member_MemberInformation 
groups statusCode (optional)
String 
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String 
array[EntityGroupInfo_Member_MemberInformation] 
id (optional)
String 
links (optional)
Links 
EntityInfo_Pdx_PdxInfo 
groups (optional)
array[EntityGroupInfo_Pdx_PdxInfo] 
id (optional)
String 
ConfigurationResult-GatewayReceiver,GatewayReceiverInfo 
configuration (optional)
GatewayReceiver 
links (optional)
Links
EntityInfo_Region_RuntimeRegionInfo 
groups runtimeInfo (optional)
array[GatewayReceiverInfoEntityGroupInfo_Region_RuntimeRegionInfo] 
ConfigurationResult-Index,RuntimeInfo 
configuration id (optional)
Index String
links (optional)
Links 
Eviction 
action runtimeInfo (optional)
array[RuntimeInfo] 
ConfigurationResult-Member,MemberInformation 
String 
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount configuration (optional)
Member 
Integer format: int32
memorySizeMb links (optional)
Links 
Integer format: int32
objectSizer runtimeInfo (optional)
array[MemberInformation] 
ConfigurationResult-Region,RuntimeRegionInfo 
ClassName 
type configuration (optional)
Region 
links (optional)
Links 
runtimeInfo (optional)
array[RuntimeRegionInfo] 
String 
Enum:
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE
Expiration 
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 
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 
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 
expression (optional)
String 
group indexType (optional)
String
Enum:
KEY
RANGE
HASH_DEPRECATED
name keyIndex (optional)
Boolean String
name regionPath (optional)
String 
IndexInfo 
regionPath memberName (optional)
String 
Member 
group (optional)
String 
id (optional)
String 
MemberInformation 
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 
autoSerializer (optional)
AutoSerializer 
diskStoreName (optional)
String 
ignoreUnreadFields (optional)
Boolean 
pdxSerializer (optional)
ClassName
readSerialized (optional)
Boolean 
PdxInfo 
diskStoreName (optional)
String 
ignoreUnreadFields persistent (optional)
Boolean 
memberName (optional)
String 
pdxSerializer (optional)
String 
readSerialized (optional)
Boolean 
RebalanceOperation 
excludeRegions (optional)
array[String] 
includeRegions (optional)
array[String] 
simulate (optional)
Boolean 
RebalanceRegionResult 
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 
rebalanceRegionResults (optional)
array[RebalanceRegionResult] 
statusMessage (optional)
String 
success (optional)
Boolean 
Region 
diskStoreName (optional)
String 
eviction (optional)
Eviction 
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 
memberName (optional)
String 
RuntimeRegionInfo 
entryCount (optional)
Long format: int64
memberName (optional)
String