Versions Compared

Old Version 1

changes.mady.by.user Unknown User (onichols)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (onichols)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: automatically generated from 1.13.1 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
Contact Info: user@geode.apache.org
Version: v1
BasePath:/management/v1/api-docs
Apache License, version 2.0
http://www.apache.org/licenses/

Deployment Management

GET

PUT /management/v1/deployments

/{id}
get deployed

Path parameters

deploy
Consumes
 This API call consumes the following media types via the Content-Type request header: 
  • multipart/form-data
Query parameters
config (optional)
Query Parameter -- deployment json configuration 
Form parameters
file id (required)
Path Form Parameter -- idformat: binary
Return type
ClusterManagementGetResult_Deployment_DeploymentInfoClusterManagementResult
Example data
Content-Type: application/json
{
  "resultlinks" : {
    "configurationByGroup" : [ {
      "configuration "self" : {
        "deployedTime" : "deployedTime""uri" },
        "deployedBy"statusMessage" : "deployedBy",
        "jarFileName" : "jarFileName"statusMessage",
        "group"statusCode" : "groupOK"
}
Responses
200
 OK ClusterManagementResult 
201
 Created 
400
 Bad request. 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
500
 Internal error. 
...
GET /management/v1/deployments/{id}
get deployed
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementGetResult_Deployment_DeploymentInfo 
Example data
Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberNameconfiguration" : "memberName",{
        "lastModifiedfileName" : "lastModified"
      }, {fileName",
        "jarLocationdeployedTime" : "jarLocationdeployedTime",
        "memberNamedeployedBy" : "memberNamedeployedBy",
        "lastModifiedgroup" : "lastModifiedgroup"
      } ]
    }, {
      "configurationruntimeInfo" : [ {
        "deployedTimejarLocation" : "deployedTimejarLocation",
        "deployedBymemberName" : "deployedBymemberName",
        "jarFileNamelastModified" : "jarFileNamelastModified",
      }, {
   "group" : "group"    "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementGetResult_Deployment_DeploymentInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/deployments
list deployed
Query parameters
group (optional)
Query Parameter -- group 
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult_Deployment_DeploymentInfo 
Example data
Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "deployedTimeconfiguration" : "deployedTime",
{
        "deployedByfileName" : "deployedByfileName",
      "jarFileName  "deployedTime" : "deployedTime",
        "deployedBy" : "jarFileNamedeployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "deployedTimefileName" : "deployedTimefileName",
        "deployedBydeployedTime" : "deployedBydeployedTime",
        "jarFileNamedeployedBy" : "jarFileNamedeployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    } ],
    "id" : "linksid"
  }, {
    "groups" : [ {
      "selfconfiguration" : {
        "urifileName" : }"fileName",
  "statusMessage      "deployedTime" : "statusMessagedeployedTime",
  "statusCode      "deployedBy" : "OKdeployedBy"
}
Responses
200
OK ClusterManagementListResult_Deployment_DeploymentInfo
401
Unauthorized
403
Forbidden
404
Not Found
Versions
GET /management
get documentation-links
Return type
DocLinks
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
{
  "latest,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "latestjarLocation",
        "supportedmemberName" : [ "supportedmemberName",
 "supported" ]
}
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.
{
  "result" : {
    "configurationByGroup       "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "configurationjarLocation" : {"jarLocation",
        "startPortmemberName" : 5"memberName",
        "gatewayTransportFilterslastModified" : [ {"lastModified"
          "initProperties" :}, {
            "keyjarLocation" : { }"jarLocation",
        "memberName" : }"memberName",
          "classNamelastModified" : "classNamelastModified"
      }  }, {
      ]
    "initProperties" : {
            "key" : { }
          },
       ],
    "classNameid" : "classNameid"
        } ],
        "manualStartlinks" : true,
       { "maximumTimeBetweenPingsself" : 6,
        "endPorturi" : 0},
        "socketBufferSize"statusMessage" : 1"statusMessage",
        "group"statusCode" : "groupOK"
}
Responses
200
 OK ClusterManagementListResult_Deployment_DeploymentInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
DiskStoreController
POST /management/v1/diskstores
create disk-store
Consumes
 This API call consumes the following media types via the Content-Type request header: 
  • application/json
Request body
body DiskStore (required)
Body Parameter -- diskStoreConfig 
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
 Diskstore already exists. 
500
 Internal error. 
...
DELETE /management/v1/diskstores/{id}
delete disk-store
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/diskstores/{id}
get disk-store
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementGetResult_DiskStore_DiskStoreInfo 
Example data
Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "configuration" : {      },
      "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",
        "bindAddressdiskUsageCriticalPercentage" : "bindAddress"1.4658129,
        "senderCountqueueSize" : 2,
      } ]
 "allowForceCompaction" : true,
 }, {
      "configurationdiskUsageWarningPercentage" : {5.962134,
        "startPortmaxOplogSizeInBytes" : 5,
        "gatewayTransportFiltersname" : [ {
 "name",
         "initPropertiesautoCompact" : {true,
            "keydirectories" : [ { }
          }"dirSize" : 6,
          "classNamename" : "classNamename"
        }, {
          "initPropertiesdirSize" : {6,
            "keyname" : { }"name"
        }  }],
          "classNametimeInterval" : "className"7,
        } ]"writeBufferSize" : 9,
        "manualStartcompactionThreshold" : true0,
        "maximumTimeBetweenPingsgroup" : 6,"group"
      },
      "endPortruntimeInfo" : [ 0,{
        "socketBufferSizememberName" : 1,"memberName"
      }, {
        "groupmemberName" : "groupmemberName"
      } ]
    }, {
      "runtimeInfoconfiguration" : [ {
        "connectedSendersdiskUsageCriticalPercentage" : [ "connectedSenders", "connectedSenders" ],1.4658129,
        "runningqueueSize" : true2,
        "portallowForceCompaction" : 5true,
        "hostnameForSendersdiskUsageWarningPercentage" : "hostnameForSenders"5.962134,
        "memberNamemaxOplogSizeInBytes" : "memberName"5,
        "bindAddressname" : "bindAddressname",
        "senderCountautoCompact" : 2
      }, {true,
        "connectedSendersdirectories" : [ "connectedSenders", "connectedSenders" ],
{
          "runningdirSize" : true6,
        "port  "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 57,
        "hostnameForSenderswriteBufferSize" : 9,
        "hostnameForSenderscompactionThreshold" : 0,
        "memberNamegroup" : "memberName",group"
      },
      "runtimeInfo" : [ {
        "bindAddressmemberName" : "bindAddress",memberName"
      }, {
        "senderCountmemberName" : 2"memberName"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementGetResult_GatewayReceiverDiskStore_GatewayReceiverInfoDiskStoreInfo
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/
gateways/receivers
diskstores
list gatewaydisk-receiversstores
Query parameters
group (optional)
Query Parameter -- group 
Return type
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult_DiskStore_DiskStoreInfo ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo
Example data
Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "startPortconfiguration" : 5,{
        "gatewayTransportFiltersdiskUsageCriticalPercentage" : [ {1.4658129,
        "initPropertiesqueueSize" : {2,
          "keyallowForceCompaction" : true,
 { }
      "diskUsageWarningPercentage" : }5.962134,
        "classNamemaxOplogSizeInBytes" : "className"5,
      }, {  "name" : "name",
        "initPropertiesautoCompact" : {true,
          "keydirectories" : [ {
 }
         "dirSize" : }6,
          "classNamename" : "classNamename"
        }, ],{
          "manualStartdirSize" : true6,
          "maximumTimeBetweenPingsname" : 6,"name"
       "endPort" :} 0],
        "socketBufferSizetimeInterval" : 17,
        "groupwriteBufferSize" : "group"9,
    },
    "runtimeInfocompactionThreshold" : [ {
0,
        "connectedSendersgroup" : [ "connectedSenders", "connectedSenders" ],"group"
      "running" : true},
      "portruntimeInfo" : 5,
[ {
        "hostnameForSendersmemberName" : "hostnameForSendersmemberName",
      "memberName" : "memberName",
}, {
        "bindAddressmemberName" : "bindAddressmemberName",
      "senderCount" : 2} ]
    }, {
      "connectedSendersconfiguration" : [ "connectedSenders", "connectedSenders" ],
{
         "runningdiskUsageCriticalPercentage" : true1.4658129,
        "portqueueSize" : 52,
        "hostnameForSendersallowForceCompaction" : "hostnameForSenders"true,
        "memberNamediskUsageWarningPercentage" : "memberName"5.962134,
        "bindAddressmaxOplogSizeInBytes" : "bindAddress"5,
        "senderCountname" : 2
    } ]
  }, {
"name",
        "configurationautoCompact" : {true,
      "startPort" : 5,
      "gatewayTransportFiltersdirectories" : [ {
          "initPropertiesdirSize" : {6,
          "keyname" : { }"name"
        }, {
        "className"  "dirSize" : 6,
          "name" : "classNamename"
        } ], {
        "initPropertiestimeInterval" : {7,
          "keywriteBufferSize" : 9,
 { }
      "compactionThreshold" : }0,
        "classNamegroup" : "classNamegroup"
      } ],
      "manualStartruntimeInfo" : true,[ {
        "maximumTimeBetweenPingsmemberName" : 6,
"memberName"
      }, {
        "endPortmemberName" : 0,"memberName"
      } ]
   "socketBufferSize" :} 1],
      "groupid" : "groupid"
    }, {
    "runtimeInfogroups" : [ {
      "connectedSendersconfiguration" : [ "connectedSenders", "connectedSenders" ],
{
        "runningdiskUsageCriticalPercentage" : true1.4658129,
        "portqueueSize" : 52,
        "hostnameForSendersallowForceCompaction" : "hostnameForSenders"true,
        "memberNamediskUsageWarningPercentage" : "memberName"5.962134,
        "bindAddressmaxOplogSizeInBytes" : "bindAddress"5,
        "senderCountname" : 2
"name",
        "autoCompact" : }true,
 {
       "connectedSendersdirectories" : [ "connectedSenders", "connectedSenders" ],
{
          "dirSize" : 6,
          "runningname" : true,
 "name"
        }, {
          "portdirSize" : 56,
          "hostnameForSendersname" : "hostnameForSendersname",
       "memberName" :} "memberName"],
        "bindAddresstimeInterval" : "bindAddress"7,
        "senderCountwriteBufferSize" : 29,
      } ]
 "compactionThreshold" }: ]0,
     "links" : { "selfgroup" : "uri"group"
      },
      "statusMessageruntimeInfo" : "statusMessage",
[ {
        "statusCodememberName" : "OKmemberName"
      }
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" : {
    "configurationByGroup" : [, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "iddiskUsageCriticalPercentage" : "id"1.4658129,
        "groupqueueSize" : "group"2,
      },
      "runtimeInfoallowForceCompaction" : [ {true,
        "cpuUsagediskUsageWarningPercentage" : 5.637376656633329962134,
        "servermaxOplogSizeInBytes" : true5,
        "httpServiceBindAddressname" : "httpServiceBindAddressname",
        "memberNameautoCompact" : "memberName"true,
        "locatorsdirectories" : "locators", [ {
          "processIddirSize" : 46,
          "webSSLname" : true,"name"
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
}, {
            "hostdirSize" : "host"6,
          "maxHeapSizename" : 2,"name"
        "workingDirPath" : "workingDirPath"} ],
        "idtimeInterval" : "id"7,
        "clientCountwriteBufferSize" : 59,
        "httpServicePortcompactionThreshold" : 70,
        "cacheServerInfogroup" : [ {
"group"
      },
      "runningruntimeInfo" : true,[ {
          "portmemberName" : 1,"memberName"
          "maxThreads" : 6,}, {
          "bindAddressmemberName" : "bindAddressmemberName",
      } ]
   "maxConnections" :} 0],
    "id" : "id"
  } ], {
  "links" : { "self" : "uri" },
  "runningstatusMessage" : true"statusMessage",
          "port"statusCode" : "OK"
}
Responses
200
 OK ClusterManagementListResult_DiskStore_DiskStoreInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
Versions
GET /management
get documentation-links
Return type
 DocLinks 
Example data
Content-Type: application/json
{
  "latest" : "latest",
  "supported" : [ "supported", "supported" ]
}
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" : [ {
      "configuration" :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"
      }, {
        "cpuUsagestartPort" : 5.637376656633329,
        "servergatewayTransportFilters" : [ true,{
          "httpServiceBindAddressinitProperties" : "httpServiceBindAddress",{
            "memberNamekey" : "memberName",{ }
        "locators" : "locators"},
          "processIdclassName" : 4,"className"
        "webSSL" : true,
}, {
          "hostedRegionsinitProperties" : [ "hostedRegions", "hostedRegions" ],
{
            "hostkey" : "host",{ }
        "maxHeapSize" : 2},
          "workingDirPathclassName" : "workingDirPathclassName",
        "id" : "id"} ],
        "clientCountmanualStart" : 5true,
        "httpServicePortmaximumTimeBetweenPings" : 76,
        "cacheServerInfoendPort" : [ {0,
          "runningsocketBufferSize" : true1,
        "group" : "portgroup"
 : 1,
    },
      "maxThreadsruntimeInfo" : [ 6,{
          "bindAddressconnectedSenders" : [ "bindAddressconnectedSenders",
 "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"
      } ]
{
      }, {
      "configurationkey" : { }
        "id" : "id"},
          "groupclassName" : "groupclassName"
        }, {
          "runtimeInfoinitProperties" : [ {
            "cpuUsagekey" : 5.637376656633329, { }
        "server" : true},
          "httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
        "memberName" : "memberName"} ],
        "locatorsmanualStart" : "locators"true,
        "processIdmaximumTimeBetweenPings" : 46,
        "webSSLendPort" : true0,
        "hostedRegionssocketBufferSize" : [ "hostedRegions", "hostedRegions" ],1,
        "hostgroup" : "hostgroup",
      },
      "maxHeapSizeruntimeInfo" : [ 2,{
        "workingDirPathconnectedSenders" : [ "connectedSenders", "workingDirPathconnectedSenders" ],
        "idrunning" : "id"true,
        "clientCountport" : 5,
        "httpServicePorthostnameForSenders" : 7"hostnameForSenders",
        "cacheServerInfomemberName" : [ {"memberName",
          "runningbindAddress" : true"bindAddress",
          "portsenderCount" : 1,2
          "maxThreads" : 6,}, {
          "bindAddressconnectedSenders" : [ "bindAddressconnectedSenders",
 "connectedSenders" ],
        "maxConnectionsrunning" : 0
        }, {
 true,
         "runningport" : true5,
          "porthostnameForSenders" : 1"hostnameForSenders",
          "maxThreadsmemberName" : 6"memberName",
          "bindAddress" : "bindAddress",
          "maxConnectionssenderCount" : 02
        } ],
    } ],
    "coordinatorid" : true,"id"
  },
  "links" :  { "groupsself" : "groupsuri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/gateways/receivers
list gateway-receivers
Query parameters
group (optional)
Query Parameter -- group 
Return type
 ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo 
Example data
Content-Type: application/json
GET /management/v1/members
list members
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
ClusterManagementListResult_Member_MemberInformation
Example data
Content-Type: application/json
{
  "result" : [ {
serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePathgroups" : "cacheXmlFilePath",
  [ {
      "locatorPortconfiguration" : 3,{
        "heapUsagestartPort" : 25,
        "initHeapSizegatewayTransportFilters" : 9,[ {
          "logFilePathinitProperties" : "logFilePath",{
        "offHeapMemorySize" :   "offHeapMemorySize",key" : { }
        "secured" : true},
          "statArchiveFilePathclassName" : "statArchiveFilePath",
className"
        }, {
          "statusinitProperties" : {
            "status"key" : { }
          },
  {
        "cpuUsageclassName" : 5.637376656633329 "className"
        } ],
        "servermanualStart" : true,
        "httpServiceBindAddressmaximumTimeBetweenPings" : "httpServiceBindAddress"6,
        "memberNameendPort" : "memberName"0,
        "locatorssocketBufferSize" : "locators"1,
        "processIdgroup" : 4,"group"
      },
      "webSSLruntimeInfo" : true,[ {
        "hostedRegionsconnectedSenders" : [ "hostedRegionsconnectedSenders", "hostedRegionsconnectedSenders" ],
        "hostrunning" : "host"true,
        "maxHeapSizeport" : 25,
        "workingDirPathhostnameForSenders" : "workingDirPathhostnameForSenders",
        "idmemberName" : "idmemberName",
        "clientCountbindAddress" : 5"bindAddress",
        "httpServicePortsenderCount" : 7,2
      }, {
  "cacheServerInfo      "connectedSenders" : [ {
  "connectedSenders", "connectedSenders" ],
        "running" : true,
          "port" : 15,
        "hostnameForSenders" : "maxThreadshostnameForSenders",
        "memberName" : 6"memberName",
          "bindAddress" : "bindAddress",
          "maxConnectionssenderCount" : 02
      } ]
    }, {
      "configuration" : {
        "runningstartPort" : true5,
          "portgatewayTransportFilters" : 1,[ {
          "maxThreadsinitProperties" : 6,{
            "bindAddresskey" : "bindAddress" { }
          },
          "maxConnectionsclassName" : 0"className"
        }, ],{
          "coordinatorinitProperties" : true,{
            "groupskey" : "groups",{ }
        "serverBindAddress" : "serverBindAddress"},
          "cacheXmlFilePathclassName" : "cacheXmlFilePathclassName",
        "locatorPort" : 3} ],
        "heapUsagemanualStart" : 2true,
        "initHeapSizemaximumTimeBetweenPings" : 96,
        "logFilePathendPort" : 0,
        "logFilePathsocketBufferSize" : 1,
        "offHeapMemorySizegroup" : "offHeapMemorySize",group"
      },
      "runtimeInfo" : [ {
        "securedconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
        "statArchiveFilePathrunning" : true,
 "statArchiveFilePath"       "port" : 5,
        "statushostnameForSenders" : "statushostnameForSenders",
       } ] "memberName" : "memberName",
    } ]    "bindAddress" : "bindAddress",
        "idsenderCount" : "id"
2
      }, {
        "linksconnectedSenders" : {[ "selfconnectedSenders", : "uriconnectedSenders" }],
  "statusMessage      "running" : "statusMessage"true,
        "statusCodeport" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Member_MemberInformation
401
Unauthorized
403
Forbidden
404
Not Found
{
  "result" : [ {
5,
        "configurationhostnameForSenders" : {"hostnameForSenders",
        "idmemberName" : "idmemberName",
        "groupbindAddress" : "groupbindAddress",
    },
    "runtimeInfosenderCount" : [ {2
      "cpuUsage" : 5.637376656633329,} ]
      "server" : true} ],
      "httpServiceBindAddressid" : "httpServiceBindAddressid",
  }, {
    "memberNamegroups" : "memberName",[ {
      "locatorsconfiguration" : "locators",
{
        "processIdstartPort" : 45,
        "webSSLgatewayTransportFilters" : true,[ {
      "hostedRegions"  : [ "hostedRegionsinitProperties", "hostedRegions" ],
  : {
    "host" : "host",
      "maxHeapSizekey" : 2,{ }
       "workingDirPath"  : "workingDirPath"},
          "idclassName" : "idclassName",
      "clientCount" : 5}, {
      "httpServicePort" : 7,
      "cacheServerInfoinitProperties" : [ {
        "running" : true,
        "portkey" : { 1,}
        "maxThreads" : 6},
          "bindAddressclassName" : "bindAddressclassName",
        "maxConnections" : 0
      }, {} ],
        "runningmanualStart" : true,
        "portmaximumTimeBetweenPings" : 16,
        "maxThreadsendPort" : 60,
        "bindAddresssocketBufferSize" : "bindAddress"1,
        "maxConnectionsgroup" : 0"group"
      } ],
      "coordinatorruntimeInfo" : [ true,{
        "groupsconnectedSenders" : [ "groupsconnectedSenders",
      "serverBindAddressconnectedSenders" : "serverBindAddress"],
        "cacheXmlFilePathrunning" : "cacheXmlFilePath"true,
        "locatorPortport" : 35,
        "heapUsagehostnameForSenders" : 2"hostnameForSenders",
        "initHeapSizememberName" : 9"memberName",
        "logFilePathbindAddress" : "logFilePathbindAddress",
        "offHeapMemorySizesenderCount" : "offHeapMemorySize",2
      "secured" : true,
}, {
        "statArchiveFilePathconnectedSenders" : [ "statArchiveFilePath""connectedSenders", "connectedSenders" ],
        "statusrunning" : "status"true,
    }, {
      "cpuUsageport" : 5.637376656633329,
        "serverhostnameForSenders" : true"hostnameForSenders",
        "httpServiceBindAddressmemberName" : "httpServiceBindAddressmemberName",
        "memberNamebindAddress" : "memberNamebindAddress",
        "locatorssenderCount" : "locators",2
      "processId" : 4,} ]
    }, {
      "webSSLconfiguration" : true,{
        "hostedRegionsstartPort" : [ "hostedRegions"5,
 "hostedRegions" ],
      "hostgatewayTransportFilters" : "host", [ {
          "maxHeapSizeinitProperties" : 2,{
      "workingDirPath" : "workingDirPath",
      "idkey" : "id", { }
      "clientCount"   : 5},
          "httpServicePortclassName" : 7,"className"
      "cacheServerInfo" : [}, {
          "runninginitProperties" : true,
{
            "portkey" : { 1,}
        "maxThreads" : 6},
          "bindAddressclassName" : "bindAddressclassName",
        "maxConnections" : 0
      }, {} ],
        "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",
    } ]
  }, {
    "configuration" : {
 "memberName" : "memberName",
        "idbindAddress" : "idbindAddress",
        "groupsenderCount" : "group"2
      }, ]
    "runtimeInfo" : [ {
  } ],
    "cpuUsageid" : 5.637376656633329,"id"
  }  ],
  "serverlinks" : true,
      "httpServiceBindAddress{ "self" : "httpServiceBindAddressuri" },
  "statusMessage" : "statusMessage",
  "memberNamestatusCode" : "OK"
}
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" : {memberName",
      "locators" : "locators",
      "processIdgroups" : 4,[ {
      "webSSLconfiguration" : true,{
        "hostedRegionsid" : [ "hostedRegionsid",
 "hostedRegions" ],
      "hostgroup" : "hostgroup",
      "maxHeapSize" : 2},
      "workingDirPathruntimeInfo" : "workingDirPath",
[ {
        "idcpuUsage" : "id"5.637376656633329,
        "clientCountserver" : 5true,
        "httpServicePorthttpServiceBindAddress" : 7"httpServiceBindAddress",
        "cacheServerInfomemberName" : [ {"memberName",
        "runninglocators" : true"locators",
        "portprocessId" : 14,
        "maxThreadswebSSL" : 6true,
        "bindAddresshostedRegions" : "bindAddress"[ "hostedRegions", "hostedRegions" ],
        "maxConnectionshost" : 0
"host",
        "maxHeapSize" : }2, {
        "runningworkingDirPath" : true"workingDirPath",
        "portid" : 1"id",
        "maxThreadsclientCount" : 65,
        "bindAddresshttpServicePort" : "bindAddress"7,
        "maxConnectionscacheServerInfo" : [ 0{
      } ],
      "coordinatorrunning" : true,
          "groupsport" : "groups"1,
          "serverBindAddressmaxThreads" : "serverBindAddress"6,
          "cacheXmlFilePathbindAddress" : "cacheXmlFilePathbindAddress",
          "locatorPortmaxConnections" : 3,0
      "heapUsage" : 2}, {
          "initHeapSizerunning" : 9true,
          "logFilePathport" : "logFilePath"1,
          "offHeapMemorySizemaxThreads" : "offHeapMemorySize",
 6,
     "secured" : true,
      "statArchiveFilePathbindAddress" : "statArchiveFilePathbindAddress",
          "statusmaxConnections" : "status"0
    }, {
      "cpuUsage" : 5.637376656633329,
} ],
        "servercoordinator" : true,
        "httpServiceBindAddressgroups" : "httpServiceBindAddressgroups",
        "memberNameserverBindAddress" : "memberNameserverBindAddress",
        "locatorscacheXmlFilePath" : "locatorscacheXmlFilePath",
        "processIdlocatorPort" : 43,
        "webSSLheapUsage" : true2,
        "hostedRegionsinitHeapSize" : [ "hostedRegions"9,
 "hostedRegions" ],
      "hostlogFilePath" : "hostlogFilePath",
        "maxHeapSizeoffHeapMemorySize" : 2"offHeapMemorySize",
        "workingDirPathsecured" : "workingDirPath"true,
        "idstatArchiveFilePath" : "idstatArchiveFilePath",
        "clientCountstatus" : 5,"status"
       "httpServicePort" : 7,
}, {
        "cacheServerInfocpuUsage" : [ {5.637376656633329,
        "runningserver" : true,
        "porthttpServiceBindAddress" : 1"httpServiceBindAddress",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddresslocators" : "bindAddresslocators",
        "maxConnectionsprocessId" : 04,
       }, {  "webSSL" : true,
        "runninghostedRegions" : true[ "hostedRegions", "hostedRegions" ],
        "porthost" : 1"host",
        "maxThreadsmaxHeapSize" : 62,
        "bindAddressworkingDirPath" : "bindAddressworkingDirPath",
        "maxConnectionsid" : 0
"id",
        "clientCount" }: ]5,
        "coordinatorhttpServicePort" : true7,
        "groupscacheServerInfo" : "groups",
[ {
          "serverBindAddressrunning" : "serverBindAddress"true,
          "cacheXmlFilePathport" : "cacheXmlFilePath"1,
          "locatorPortmaxThreads" : 36,
          "heapUsagebindAddress" : 2"bindAddress",
          "initHeapSizemaxConnections" : 9,0
      "logFilePath" : "logFilePath"}, {
          "offHeapMemorySizerunning" : "offHeapMemorySize"true,
          "securedport" : true1,
          "statArchiveFilePathmaxThreads" : "statArchiveFilePath"6,
          "statusbindAddress" : "statusbindAddress",
    } ]
  } ],
  "linksmaxConnections" : 0
    { "self" : "uri" } ],
        "statusMessagecoordinator" : "statusMessage"true,
        "statusCodegroups" : "OKgroups"
}
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
GET /management/v1/configurations/pdx
get pdx
Return type
ClusterManagementGetResult_Pdx_PdxInfo
Example data
Content-Type: application/json
{
  "links" : { "self,
        "serverBindAddress" : "uriserverBindAddress" },
  "statusMessage      "cacheXmlFilePath" : "statusMessagecacheXmlFilePath",
  "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.
{
  "result" : {
locatorPort" : 3,
        "configurationByGroupheapUsage" : 2,
 [ {
      "configurationinitHeapSize" : {9,
        "autoSerializerlogFilePath" : {"logFilePath",
          "patternsoffHeapMemorySize" : [ "patterns", "patterns" ]"offHeapMemorySize",
          "portablesecured" : true
        },
        "readSerializedstatArchiveFilePath" : true"statArchiveFilePath",
        "diskStoreNamestatus" : "diskStoreNamestatus",
      } ]
 "ignoreUnreadFields"  : true}, {
        "pdxSerializerconfiguration" : {
          "initPropertiesid" : {
   "id",
         "keygroup" : { }"group"
          },
          "classNameruntimeInfo" : "className"[ {
        }
"cpuUsage" : 5.637376656633329,
    },
      "runtimeInfoserver" : [ {true,
        "readSerializedhttpServiceBindAddress" : true"httpServiceBindAddress",
        "memberName" : "memberName",
        "diskStoreNamelocators" : "diskStoreNamelocators",
        "ignoreUnreadFieldsprocessId" : true4,
        "pdxSerializerwebSSL" : "pdxSerializer"true,
      }, {
 "hostedRegions" :     [ "hostedRegions", "readSerializedhostedRegions" : true],
        "memberNamehost" : "memberNamehost",
        "diskStoreNamemaxHeapSize" : "diskStoreName"2,
        "ignoreUnreadFieldsworkingDirPath" : true"workingDirPath",
        "pdxSerializerid" : "pdxSerializerid",
      } ]
 "clientCount" : 5,
 }, {
      "configurationhttpServicePort" : {7,
        "autoSerializercacheServerInfo" : [ {
          "patternsrunning" : [ "patterns", "patterns" ],true,
          "portableport" : true1,
        },
        "readSerialized""maxThreads" : true6,
          "diskStoreNamebindAddress" : "diskStoreNamebindAddress",
          "ignoreUnreadFieldsmaxConnections" : true,0
        "pdxSerializer" : }, {
          "initPropertiesrunning" : {true,
            "keyport" : 1,
 { }
        "maxThreads" : }6,
          "classNamebindAddress" : "classNamebindAddress",
         }
 "maxConnections" : 0
        } ],
        "runtimeInfocoordinator" : [ {true,
        "readSerializedgroups" : true"groups",
        "memberNameserverBindAddress" : "memberNameserverBindAddress",
        "diskStoreNamecacheXmlFilePath" : "diskStoreNamecacheXmlFilePath",
        "ignoreUnreadFieldslocatorPort" : true3,
        "pdxSerializerheapUsage" : "pdxSerializer"2,
      }, {  "initHeapSize" : 9,
        "readSerializedlogFilePath" : true"logFilePath",
        "memberNameoffHeapMemorySize" : "memberNameoffHeapMemorySize",
        "diskStoreNamesecured" : "diskStoreName"true,
        "ignoreUnreadFieldsstatArchiveFilePath" : true"statArchiveFilePath",
        "pdxSerializerstatus" : "pdxSerializerstatus"
      }, ]{
    } ],
    "idcpuUsage" : "id"5.637376656633329,
  },
   "links" : { "selfserver" : "uri" }true,
        "statusMessagehttpServiceBindAddress" : "statusMessagehttpServiceBindAddress",
  "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" : {
memberName" : "memberName",
        "rebalanceRegionResultslocators" : [ {"locators",
        "bucketCreateTimeInMillisecondsprocessId" : 64,
        "primaryTransferTimeInMillisecondswebSSL" : 7true,
        "bucketCreatesCompletedhostedRegions" : 1[ "hostedRegions", "hostedRegions" ],
        "bucketTransfersCompletedhost" : 2"host",
        "bucketCreateBytesmaxHeapSize" : 02,
        "regionNameworkingDirPath" : "regionNameworkingDirPath",
        "bucketTransferTimeInMillisecondsid" : 5"id",
        "timeInMillisecondsclientCount" : 35,
        "primaryTransfersCompletedhttpServicePort" : 97,
        "bucketTransferBytescacheServerInfo" : 5[ {
    }, {
      "bucketCreateTimeInMillisecondsrunning" : 6true,
          "primaryTransferTimeInMillisecondsport" : 71,
          "bucketCreatesCompletedmaxThreads" : 16,
          "bucketTransfersCompletedbindAddress" : 2"bindAddress",
          "bucketCreateBytesmaxConnections" : 0,
      "regionName" : "regionName"}, {
          "bucketTransferTimeInMillisecondsrunning" : 5true,
          "timeInMillisecondsport" : 31,
          "primaryTransfersCompletedmaxThreads" : 96,
          "bucketTransferBytesbindAddress" : 5"bindAddress",
    }  ],
    "successmaxConnections" : 0
        } ],
        "coordinator" : true,
        "statusMessagegroups" : "statusMessagegroups",
    },
    "operationEndedserverBindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXserverBindAddress",
  "operationStart      "cacheXmlFilePath" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXcacheXmlFilePath",
        "linkslocatorPort" : { 3,
        "selfheapUsage" : "uri" },
2,
        "initHeapSize" : 9,
        "operatorlogFilePath" : "operatorlogFilePath",
        "statusMessageoffHeapMemorySize" : "statusMessage""offHeapMemorySize",
        "secured" : true,
  "statusCode      "statArchiveFilePath" : "OKstatArchiveFilePath"
}
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,
        "status" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
status"
     "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",} ]
    "operationId" : "operationId"} ],
    "operatorid" : "operatorid",
  },
  "statusMessagelinks" : "statusMessage",
    "statusCode{ "self" : "OKuri"
  }, {
    "operationEndedstatusMessage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXstatusMessage",
    "operationStartstatusCode" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operationId" : "operationId",OK"
}
Responses
200
 OK ClusterManagementGetResult_Member_MemberInformation 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/members
list members
Query parameters
group (optional)
Query Parameter -- group 
id (optional)
Query Parameter -- id 
Return type
 ClusterManagementListResult_Member_MemberInformation 
Example data
Content-Type: application/json
{
  "result" : [ {
    "operatorgroups" : "operator", [ {
      "statusMessageconfiguration" : "statusMessage",
{
        "statusCodeid" : "OKid",
  } ],
  "links" : { "selfgroup" : "urigroup"
      },
      "statusMessageruntimeInfo" : "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
     "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",
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
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" : {
    "configurationByGroup" : [ {
      "configuration" : {
        "regionPathcacheXmlFilePath" : "regionPathcacheXmlFilePath",
        "indexTypelocatorPort" : "KEY"3,
        "expressionheapUsage" : "expression"2,
        "nameinitHeapSize" : "name"9,
      },
      "runtimeInfologFilePath" : [ {"logFilePath",
        "memberNameoffHeapMemorySize" : "memberNameoffHeapMemorySize",
      }, {  "secured" : true,
        "memberNamestatArchiveFilePath" : "memberNamestatArchiveFilePath",
        } ]
"status" : "status"
      }, {
        "configurationcpuUsage" : {5.637376656633329,
        "regionPathserver" : "regionPath"true,
        "indexTypehttpServiceBindAddress" : "KEYhttpServiceBindAddress",
        "expressionmemberName" : "expressionmemberName",
        "namelocators" : "namelocators",
         }"processId" : 4,
        "runtimeInfowebSSL" : [ {true,
        "memberNamehostedRegions" : "memberName"[ "hostedRegions", "hostedRegions" ],
      }, {  "host" : "host",
        "memberNamemaxHeapSize" : "memberName"
2,
        "workingDirPath" } ]: "workingDirPath",
    } ],
    "id" : "id",
  },
      "linksclientCount" : { 5,
        "selfhttpServicePort" : "uri" }7,
  "statusMessage      "cacheServerInfo" : "statusMessage", [ {
  "statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Index_IndexInfo
401
Unauthorized
403
Forbidden
404
Not Found
{
  "result" : {
    "configurationByGroup" : [ {
        "running" : true,
          "configurationport" : {1,
        "expirations" : [ {
          "action"maxThreads" : "DESTROY"6,
          "typebindAddress" : "ENTRY_TIME_TO_LIVEbindAddress",
          "timeInSecondsmaxConnections" : 10
        }, {
          "actionrunning" : "DESTROY"true,
          "typeport" : "ENTRY_TIME_TO_LIVE"1,
          "timeInSecondsmaxThreads" : 16,
        } ],
  "bindAddress"  :    "redundantCopiesbindAddress",
 : 5,
        "evictionmaxConnections" : {0
          "entryCount" : 0} ],
          "objectSizercoordinator" : {true,
            "initPropertiesgroups" : {"groups",
              "key"serverBindAddress" : { }"serverBindAddress",
        "cacheXmlFilePath"    }: "cacheXmlFilePath",
            "classNamelocatorPort" : "className"3,
        "heapUsage" : }2,
          "actioninitHeapSize" : "LOCAL_DESTROY"9,
          "typelogFilePath" : "ENTRY_COUNTlogFilePath",
        "offHeapMemorySize" : "memorySizeMboffHeapMemorySize",
 : 6
      "secured" : }true,
        "keyConstraintstatArchiveFilePath" : "keyConstraintstatArchiveFilePath",
        "namestatus" : "namestatus",
      } ]
 "valueConstraint"  : "valueConstraint"}, {
        "typeconfiguration" : "PARTITION",{
        "diskStoreNameid" : "diskStoreNameid",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCountcpuUsage" : 5.637376656633329,
        "memberNameserver" : "memberName"true,
      }, {
         "entryCounthttpServiceBindAddress" : 5"httpServiceBindAddress",
        "memberName" : "memberName",
      } ]
 "locators" : "locators",
 }, {
      "configurationprocessId" : {4,
        "expirationswebSSL" : [ {true,
          "actionhostedRegions" : [ "DESTROYhostedRegions",
 "hostedRegions" ],
        "typehost" : "ENTRY_TIME_TO_LIVEhost",
          "timeInSecondsmaxHeapSize" : 1
        }, {2,
          "actionworkingDirPath" : "DESTROYworkingDirPath",
          "typeid" : "ENTRY_TIME_TO_LIVEid",
          "timeInSecondsclientCount" : 15,
        } ]"httpServicePort" : 7,
        "redundantCopiescacheServerInfo" : 5,
[ {
          "evictionrunning" : {true,
          "entryCountport" : 01,
          "objectSizermaxThreads" : {6,
            "initPropertiesbindAddress" : {"bindAddress",
              "keymaxConnections" : { }
   0
         }, {
            "className"running" : "className"
true,
          "port" : }1,
          "actionmaxThreads" : "LOCAL_DESTROY"6,
          "typebindAddress" : "ENTRY_COUNTbindAddress",
          "memorySizeMbmaxConnections" : 60
        } ],
        "keyConstraintcoordinator" : "keyConstraint"true,
        "namegroups" : "namegroups",
        "valueConstraintserverBindAddress" : "valueConstraintserverBindAddress",
        "typecacheXmlFilePath" : "PARTITIONcacheXmlFilePath",
        "diskStoreNamelocatorPort" : "diskStoreName"3,
        "groupheapUsage" : "group"2,
      },
      "runtimeInfoinitHeapSize" : [ {9,
        "entryCountlogFilePath" : 5"logFilePath",
        "memberNameoffHeapMemorySize" : "memberNameoffHeapMemorySize",
        "secured" : }true, {
        "entryCountstatArchiveFilePath" : 5"statArchiveFilePath",
        "memberNamestatus" : "memberNamestatus"
      }, ]{
    } ],
    "idcpuUsage" : "id"5.637376656633329,
  },
   "links" : { "selfserver" : "uri" }true,
  "statusMessage      "httpServiceBindAddress" : "statusMessagehttpServiceBindAddress",
  "statusCode      "memberName" : "OKmemberName"
}
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" : [ {
    "configuration" : {
,
        "locators" : "locators",
        "regionPathprocessId" : "regionPath"4,
        "indexTypewebSSL" : "KEY"true,
        "expressionhostedRegions" : [ "expressionhostedRegions", "hostedRegions" ],
        "namehost" : "namehost",
    },
    "runtimeInfomaxHeapSize" : [ {
2,
        "memberNameworkingDirPath" : "memberNameworkingDirPath",
    }, {
      "memberNameid" : "memberNameid",
    } ]
  }, {
    "configuration"clientCount" : {5,
        "regionPathhttpServicePort" : "regionPath"7,
        "indexTypecacheServerInfo" : [ "KEY"{
          "running" : true,
          "expressionport" : "expression"1,
          "namemaxThreads" : "name"6,
     },
     "runtimeInfobindAddress" : [ {
"bindAddress",
          "memberNamemaxConnections" : "memberName"
0
        }, {
          "memberNamerunning" : "memberName"true,
    } ]
  } ],
  "linksport" : {1,
          "selfmaxThreads" : "uri" }6,
          "statusMessagebindAddress" : "statusMessagebindAddress",
          "statusCodemaxConnections" : "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
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" : [ {
0
        } ],
        "coordinator" : true,
        "configurationgroups" : {"groups",
        "regionPathserverBindAddress" : "regionPathserverBindAddress",
        "indexTypecacheXmlFilePath" : "KEYcacheXmlFilePath",
        "expressionlocatorPort" : "expression"3,
        "nameheapUsage" : "name"2,
    },
    "runtimeInfoinitHeapSize" : 9,
 [ {
      "memberNamelogFilePath" : "memberNamelogFilePath",
    }, {
      "memberNameoffHeapMemorySize" : "memberNameoffHeapMemorySize",
    } ]
  }, {
 "secured" : true,
        "configurationstatArchiveFilePath" : {"statArchiveFilePath",
        "regionPathstatus" : "regionPath",status"
      } ]
    } ],
    "id" : "id"
  }, {
    "indexTypegroups" : "KEY",
[ {
      "configuration" : {
        "expressionid" : "expressionid",
        "namegroup" : "namegroup"
      },
      "runtimeInfo" : [ {
        "memberNamecpuUsage" : "memberName"5.637376656633329,
    }, {
    "server" : true,
        "memberNamehttpServiceBindAddress" : "memberNamehttpServiceBindAddress",
     } ]
  } ]"memberName" : "memberName",
    "links"  : { "selflocators" : "urilocators" },
  "statusMessage      "processId" : "statusMessage"4,
  "statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Index_IndexInfo
401
Unauthorized
403
Forbidden
404
Not Found
{
  "result" : [ {
    "configuration" : {
      "expirations     "webSSL" : true,
        "hostedRegions" : [ {
        "action" : "DESTROY""hostedRegions", "hostedRegions" ],
        "typehost" : "ENTRY_TIME_TO_LIVEhost",
        "timeInSecondsmaxHeapSize" : 1
      }, {2,
        "actionworkingDirPath" : "DESTROYworkingDirPath",
        "typeid" : "ENTRY_TIME_TO_LIVEid",
        "timeInSecondsclientCount" : 15,
      } ]  "httpServicePort" : 7,
        "redundantCopiescacheServerInfo" : [ 5,{
          "evictionrunning" : {true,
          "entryCountport" : 01,
          "objectSizermaxThreads" : {6,
          "initPropertiesbindAddress" : {"bindAddress",
            "keymaxConnections" : { }0
          }, {
          "classNamerunning" : "className"true,
        }  "port" : 1,
          "actionmaxThreads" : "LOCAL_DESTROY"6,
          "typebindAddress" : "ENTRY_COUNTbindAddress",
          "memorySizeMbmaxConnections" : 60
        } ],
        "keyConstraintcoordinator" : "keyConstraint"true,
        "namegroups" : "namegroups",
        "valueConstraintserverBindAddress" : "valueConstraintserverBindAddress",
        "typecacheXmlFilePath" : "PARTITIONcacheXmlFilePath",
        "diskStoreNamelocatorPort" : "diskStoreName"3,
        "groupheapUsage" : "group"2,
    },
    "runtimeInfoinitHeapSize" : [ {
9,
        "entryCountlogFilePath" : 5"logFilePath",
        "memberNameoffHeapMemorySize" : "memberNameoffHeapMemorySize",
    }, {
    "secured" : true,
        "entryCountstatArchiveFilePath" : 5"statArchiveFilePath",
        "memberNamestatus" : "memberNamestatus"
    } ]
  }, {
        "configurationcpuUsage" : {
5.637376656633329,
        "expirationsserver" : [ {true,
        "actionhttpServiceBindAddress" : "DESTROYhttpServiceBindAddress",
        "typememberName" : "ENTRY_TIME_TO_LIVEmemberName",
        "timeInSecondslocators" : 1"locators",
      }, {  "processId" : 4,
        "actionwebSSL" : "DESTROY"true,
        "typehostedRegions" : "ENTRY_TIME_TO_LIVE",[ "hostedRegions", "hostedRegions" ],
        "timeInSecondshost" : 1"host",
      } ]  "maxHeapSize" : 2,
        "redundantCopiesworkingDirPath" : 5"workingDirPath",
        "evictionid" : {"id",
        "entryCountclientCount" : 05,
        "objectSizerhttpServicePort" : {7,
          "initPropertiescacheServerInfo" : [ {
            "keyrunning" : { }true,
          },"port" : 1,
          "classNamemaxThreads" : 6,
          "bindAddress" : "className"bindAddress",
          "maxConnections" : 0
        }, {
          "actionrunning" : "LOCAL_DESTROY"true,
          "typeport" : "ENTRY_COUNT"1,
          "memorySizeMbmaxThreads" : 6,
      },
      "keyConstraintbindAddress" : "keyConstraintbindAddress",
          "namemaxConnections" : "name",0
      "valueConstraint"  :} "valueConstraint"],
        "typecoordinator" : "PARTITION"true,
        "diskStoreNamegroups" : "diskStoreNamegroups",
        "groupserverBindAddress" : "groupserverBindAddress",
    },
    "runtimeInfocacheXmlFilePath" : [ {
"cacheXmlFilePath",
        "entryCountlocatorPort" : 53,
        "memberNameheapUsage" : "memberName"2,
    }, {
      "entryCountinitHeapSize" : 59,
        "memberNamelogFilePath" : "memberNamelogFilePath",
    } ]
  } ]    "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
  "links      "statArchiveFilePath" : { "statArchiveFilePath",
        "selfstatus" : "uri" },
  "statusMessagestatus"
      } ]
    }, {
      "configuration" : {
        "id" : "statusMessageid",
        "statusCodegroup" : "OKgroup"
      }
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]
,
      "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}
get rebalance
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementOperationResult_RebalanceOperation_RebalanceResult 
Example data
Content-Type: application/json
{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "simulate" : true,
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    }, {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    } ],
    "success" : true,
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementOperationResult_RebalanceOperation_RebalanceResult 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/operations/rebalances
list rebalances
Return type
 ClusterManagementListOperationsResult_RebalanceOperation_RebalanceResult 
Example data
Content-Type: application/json
{
  "result" : [ {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "simulate" : true,
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "rebalanceRegionResults" : [ {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      }, {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      } ],
      "success" : true,
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  }, {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "simulate" : true,
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "rebalanceRegionResults" : [ {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      }, {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      } ],
      "success" : true,
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementListOperationsResult_RebalanceOperation_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_RebalanceOperation_RebalanceResult 
Example data
Content-Type: application/json
{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "simulate" : true,
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    }, {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    } ],
    "success" : true,
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementOperationResult_RebalanceOperation_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 
...
RestoreRedundancy Operation
GET /management/v1/operations/restoreRedundancy/{id}
get restore-redundancy
Path parameters
id (required)
Path Parameter -- id 
Return type
 ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults 
Example data
Content-Type: application/json
{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "reassignPrimaries" : true,
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "regionResults" : {
      "key" : {
        "configuredRedundancy" : 6,
        "regionName" : "regionName",
        "actualRedundancy" : 0,
        "status" : "SATISFIED"
      }
    },
    "underRedundancyRegionResults" : { },
    "zeroRedundancyRegionResults" : { },
    "totalPrimaryTransferTime" : 1,
    "totalPrimaryTransfersCompleted" : 5,
    "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
    "success" : true,
    "satisfiedRedundancyRegionResults" : { },
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
GET /management/v1/operations/restoreRedundancy
list restore-redundancy
Return type
 ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults 
Example data
Content-Type: application/json
{
  "result" : [ {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "reassignPrimaries" : true,
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "regionResults" : {
        "key" : {
          "configuredRedundancy" : 6,
          "regionName" : "regionName",
          "actualRedundancy" : 0,
          "status" : "SATISFIED"
        }
      },
      "underRedundancyRegionResults" : { },
      "zeroRedundancyRegionResults" : { },
      "totalPrimaryTransferTime" : 1,
      "totalPrimaryTransfersCompleted" : 5,
      "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
      "success" : true,
      "satisfiedRedundancyRegionResults" : { },
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  }, {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "reassignPrimaries" : true,
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "regionResults" : {
        "key" : {
          "configuredRedundancy" : 6,
          "regionName" : "regionName",
          "actualRedundancy" : 0,
          "status" : "SATISFIED"
        }
      },
      "underRedundancyRegionResults" : { },
      "zeroRedundancyRegionResults" : { },
      "totalPrimaryTransferTime" : 1,
      "totalPrimaryTransfersCompleted" : 5,
      "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
      "success" : true,
      "satisfiedRedundancyRegionResults" : { },
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 
...
POST /management/v1/operations/restoreRedundancy
start restore-redundancy
Consumes
 This API call consumes the following media types via the Content-Type request header: 
  • application/json
Request body
body RestoreRedundancyRequest (required)
Body Parameter -- operation 
Return type
 ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults 
Example data
Content-Type: application/json
{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "reassignPrimaries" : true,
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "regionResults" : {
      "key" : {
        "configuredRedundancy" : 6,
        "regionName" : "regionName",
        "actualRedundancy" : 0,
        "status" : "SATISFIED"
      }
    },
    "underRedundancyRegionResults" : { },
    "zeroRedundancyRegionResults" : { },
    "totalPrimaryTransferTime" : 1,
    "totalPrimaryTransfersCompleted" : 5,
    "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
    "success" : true,
    "satisfiedRedundancyRegionResults" : { },
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}
Responses
200
 OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults 
201
 Created 
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_DiskStore_DiskStoreInfo 
links (optional)
Links 
result (optional)
EntityInfo_DiskStore_DiskStoreInfo 
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_RebalanceOperation_RebalanceResult 
links (optional)
Links 
result (optional)
array[ClusterManagementOperationResult_RebalanceOperation_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 
ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults 
ClusterManagementGetResult_Deployment_DeploymentInfo
links (optional)
Links 
result (optional)
ConfigurationInfoarray[ClusterManagementOperationResult_DeploymentRestoreRedundancyRequest_DeploymentInfoRestoreRedundancyResults] 
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
ClusterManagementListResult_
GatewayReceiver
Deployment_
GatewayReceiverInfo
DeploymentInfo
links (optional)
Links 
result (optional)
ConfigurationInfoarray[EntityInfo_GatewayReceiverDeployment_GatewayReceiverInfoDeploymentInfo] 
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
ClusterManagementListResult_
Index
DiskStore_
IndexInfo
DiskStoreInfo
links (optional)
Links 
result (optional)
ConfigurationInfoarray[EntityInfo_IndexDiskStore_IndexInfoDiskStoreInfo] 
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
ClusterManagementListResult_
Member
GatewayReceiver_
MemberInformation
GatewayReceiverInfo
links (optional)
Links 
result (optional)
ConfigurationInfoarray[EntityInfo_MemberGatewayReceiver_MemberInformationGatewayReceiverInfo] 
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
ClusterManagementListResult_
Pdx
Index_
PdxInfo
IndexInfo
links (optional)
Links 
result (optional)
ConfigurationInfoarray[EntityInfo_PdxIndex_PdxInfoIndexInfo] 
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
ClusterManagementListResult_
Region
Member_
RuntimeRegionInfo
MemberInformation
links (optional)
Links 
result (optional)
ConfigurationInfoarray[EntityInfo_RegionMember_RuntimeRegionInfoMemberInformation] 
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
ClusterManagementListResult_Region_
RebalanceResult
RuntimeRegionInfo
links (optional)
Links 
result (optional)
array[ClusterManagementOperationResultEntityInfo_Region_RebalanceResultRuntimeRegionInfo] 
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
ClusterManagementOperationResult_
Deployment
RebalanceOperation_
DeploymentInfo
RebalanceResult
links (optional)
Links
operation (optional)
RebalanceOperation 
operationEnd (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String 
operationResult (optional)
RebalanceResult 
operationStart result (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXXarray[ConfigurationResult_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
throwable (optional)
Throwable 
ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults 
ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo
links (optional)
Links
result (optional)
operation (optional)
RestoreRedundancyRequest 
operationEnd (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String 
operationResult (optional)
RestoreRedundancyResults 
operationStart (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXXarray[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_IndexInfo
links throwable (optional)
Links
Throwable 
ClusterManagementResult 
result links (optional)
array[ConfigurationResult_Index_IndexInfo]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 
ClusterManagementListResult_Member_MemberInformation
Deployment 
deployedBy links (optional)
LinksString
result deployedTime (optional)
array[ConfigurationResult_Member_MemberInformation]
String 
fileName statusCode (optional)
String 
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
group (optional)
String 
DeploymentInfo 
jarLocation (optional)
String 
lastModified (optional)
String 
memberName (optional)
String 
DiskDir 
dirSize (optional)
Integer format: int32
name statusMessage (optional)
String 
ClusterManagementListResult_Region_RuntimeRegionInfo
DiskStore 
allowForceCompaction links (optional)
LinksBoolean
result autoCompact (optional)
array[ConfigurationResult_Region_RuntimeRegionInfo]
Boolean 
compactionThreshold statusCode (optional)
String
Enum
Integer format: int32
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
directories (optional)
array[DiskDir] 
diskUsageCriticalPercentage (optional)
Float format: float
diskUsageWarningPercentage (optional)
Float format: float
group statusMessage (optional)
String 
ClusterManagementOperationResult_RebalanceResult
links maxOplogSizeInBytes (optional)
Links
Long format: int64
name operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
queueSize (optional)
Integer format: int32
timeInterval (optional)
Long format: int64
writeBufferSize operationId (optional)
String
Integer format: int32
DiskStoreInfo 
memberName operationStart (optional)
String 
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
latest operator (optional)
String 
statusCode supported (optional)
array[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
ClusterManagementResult
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
]
EntityGroupInfo_Deployment_DeploymentInfo 
configuration (optional)
Deployment 
runtimeInfo (optional)
array[DeploymentInfo] 
EntityGroupInfo_DiskStore_DiskStoreInfo 
configuration (optional)
DiskStore 
runtimeInfo (optional)
array[DiskStoreInfo] 
EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo 
configuration (optional)
GatewayReceiver 
runtimeInfo (optional)
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_DiskStore_DiskStoreInfo 
groups (optional)
array[EntityGroupInfo_DiskStore_DiskStoreInfo
ConfigurationInfo_Deployment_DeploymentInfo
configurationByGroup (optional)
array[ConfigurationResult_Deployment_DeploymentInfo]
id (optional)
String
links (optional)
Links 
EntityInfo
ConfigurationInfo
_GatewayReceiver_GatewayReceiverInfo
configurationByGroup groups (optional)
array[ConfigurationResultEntityGroupInfo_GatewayReceiver_GatewayReceiverInfo] 
id (optional)
String
links (optional)
Links 
EntityInfo
ConfigurationInfo
_Index_IndexInfo
configurationByGroup groups (optional)
array[ConfigurationResultEntityGroupInfo_Index_IndexInfo] 
id (optional)
String 
links (optional)
Links 
EntityInfo
ConfigurationInfo
_Member_MemberInformation
configurationByGroup groups (optional)
array[ConfigurationResultEntityGroupInfo_Member_MemberInformation] 
id (optional)
String 
links (optional)
Links 
EntityInfo
ConfigurationInfo
_Pdx_PdxInfo
configurationByGroup groups (optional)
array[ConfigurationResultEntityGroupInfo_Pdx_PdxInfo] 
id (optional)
String
links (optional)
Links 
EntityInfo
ConfigurationInfo
_Region_RuntimeRegionInfo
configurationByGroup groups (optional)
array[ConfigurationResultEntityGroupInfo_Region_RuntimeRegionInfo] 
id (optional)
String 
ConfigurationResult_Deployment_DeploymentInfo
links (optional)
Links 
Eviction 
action (optional)
String 
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount (optional)
Integer format: int32
memorySizeMb configuration (optional)
Deployment
Integer format: int32
objectSizer links (optional)
LinksClassName
runtimeInfo type (optional)
array[DeploymentInfo]
ConfigurationResult_GatewayReceiver_GatewayReceiverInfo
configuration (optional)
GatewayReceiver
links (optional)
Links
runtimeInfo (optional)
array[GatewayReceiverInfo]
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 
ConfigurationResult_Index_IndexInfo
configuration (optional)
Index
links (optional)
Links
runtimeInfo (optional)
array[IndexInfoClassName] 
ConfigurationResult_Member_MemberInformation
group (optional)
String 
manualStart configuration (optional)
MemberBoolean
links maximumTimeBetweenPings (optional)
Links
Integer format: int32
socketBufferSize runtimeInfo (optional)
array[MemberInformation]
ConfigurationResult_Pdx_PdxInfo
Integer format: int32
startPort configuration (optional)
Integer format: int32
GatewayReceiverInfo 
bindAddress 
Pdx
links (optional)
LinksString
runtimeInfo connectedSenders (optional)
array[PdxInfoString] 
ConfigurationResult_Region_RuntimeRegionInfo
configuration hostnameForSenders (optional)
RegionString
links memberName (optional)
LinksString
runtimeInfo port (optional)
array[RuntimeRegionInfo]
Deployment
Integer format: int32
running deployedBy (optional)
StringBoolean
deployedTime senderCount (optional)
Integer format: int32
Index 
expression 
String
group (optional)
String 
jarFileName indexType (optional)
String 
DeploymentInfo
Enum:
KEY
RANGE
HASH_DEPRECATED
name jarLocation (optional)
String 
lastModified regionPath (optional)
String 
IndexInfo 
memberName (optional)
String 
DocLinks
Member 
latest group (optional)
String 
supported id (optional)
array[String] 
Eviction
MemberInformation 
action cacheServerInfo (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
array[CacheServerInfo] 
cacheXmlFilePath entryCount (optional)
Integer format: int32
String 
clientCount memorySizeMb (optional)
Integer format: int32
objectSizer coordinator (optional)
ClassNameBoolean
type cpuUsage (optional)
String
Enum
Double format: 
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE
Expiration
double
groups action (optional)
String 
Enum:
DESTROY
INVALIDATE
LEGACY
timeInSeconds heapUsage (optional)
Integer Long format: int32int64
type host (optional)
String 
Enum:
ENTRY_TIME_TO_LIVE
ENTRY_IDLE_TIME
LEGACY
GatewayReceiver
endPort hostedRegions (optional)
Integer format: int32
array[String] 
httpServiceBindAddress gatewayTransportFilters (optional)
array[ClassName]
String 
httpServicePort group (optional)
String
Integer format: int32
id manualStart (optional)
BooleanString
maximumTimeBetweenPings initHeapSize (optional)
Integer Long format: int32int64
socketBufferSize locatorPort (optional)
Integer format: int32
startPort locators (optional)
Integer format: int32
GatewayReceiverInfo
String 
logFilePath bindAddress (optional)
String 
connectedSenders maxHeapSize (optional)
array[String]
Long format: int64
memberName hostnameForSenders (optional)
String 
memberName offHeapMemorySize (optional)
String 
port processId (optional)
Integer format: int32
running secured (optional)
Boolean 
senderCount server (optional)
Integer format: int32
Index
Boolean 
serverBindAddress expression (optional)
String 
indexType statArchiveFilePath (optional)
String 
Enum:
KEY
RANGE
HASH_DEPRECATED
status (optional)
String 
webSSL name (optional)
StringBoolean
regionPath workingDirPath (optional)
String 
IndexInfo
Pdx
memberName autoSerializer (optional)
String
AutoSerializer 
diskStoreName 
Member
group (optional)
String 
id ignoreUnreadFields (optional)
StringBoolean
MemberInformation
cacheServerInfo pdxSerializer (optional)
array[CacheServerInfo]
ClassName 
readSerialized cacheXmlFilePath (optional)
Boolean String
PdxInfo 
clientCount diskStoreName (optional)
Integer format: int32
String 
ignoreUnreadFields coordinator (optional)
Boolean 
cpuUsage memberName (optional)
Double format: double
String 
pdxSerializer groups (optional)
String 
heapUsage readSerialized (optional)
Long format: int64
Boolean 
RebalanceOperation 
excludeRegions host (optional)
array[String] 
hostedRegions includeRegions (optional)
array[String] 
httpServiceBindAddress operator (optional)
String 
httpServicePort simulate (optional)
Integer format: int32
Boolean 
RebalanceRegionResult 
bucketCreateBytes id (optional)
String
Long format: int64
bucketCreateTimeInMilliseconds initHeapSize (optional)
Long format: int64
locatorPort bucketCreatesCompleted (optional)
Integer format: int32
locators bucketTransferBytes (optional)
String
logFilePath (optional)
String
Long format: int64
bucketTransferTimeInMilliseconds maxHeapSize (optional)
Long format: int64
memberName bucketTransfersCompleted (optional)
String
Integer format: int32
numOfMembers offHeapMemorySize (optional)
String
processId (optional)
Integer format: int32
secured primaryTransferTimeInMilliseconds (optional)
Boolean
server (optional)
Boolean
Long format: int64
primaryTransfersCompleted serverBindAddress (optional)
String
Integer format: int32
regionName statArchiveFilePath (optional)
String 
status timeInMilliseconds (optional)
String
Long format: int64
RebalanceResult 
rebalanceRegionResults webSSL (optional)
Boolean
array[RebalanceRegionResult] 
statusMessage workingDirPath (optional)
String 
Pdx
autoSerializer success (optional)
AutoSerializer
Boolean 
Region 
diskStoreName (optional)
String 
ignoreUnreadFields eviction (optional)
BooleanEviction
pdxSerializer expirations (optional)
ClassName
array[Expiration] 
group readSerialized (optional)
BooleanString
PdxInfo
diskStoreName keyConstraint (optional)
String 
ignoreUnreadFields name (optional)
BooleanString
memberName redundantCopies (optional)
String
Integer format: int32
type pdxSerializer (optional)
String 
readSerialized (optional)
Boolean
RebalanceOperation
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
valueConstraint 
excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
simulate (optional)
BooleanString
RebalanceRegionResult
RegionRedundancyStatus
bucketCreateBytes actualRedundancy (optional)
Long Integer format: int64int32
bucketCreateTimeInMilliseconds configuredRedundancy (optional)
Long Integer format: int64int32
bucketCreatesCompleted regionName (optional)
Integer format: int32
String 
status bucketTransferBytes (optional)
Long format: int64
String 
Enum:
SATISFIED
NOT_SATISFIED
NO_REDUNDANT_COPIES
RestoreRedundancyRequest 
excludeRegions bucketTransferTimeInMilliseconds (optional)
Long format: int64
array[String] 
includeRegions bucketTransfersCompleted (optional)
Integer format: int32
array[String] 
operator primaryTransferTimeInMilliseconds (optional)
Long format: int64
String 
reassignPrimaries primaryTransfersCompleted (optional)
Boolean 
RestoreRedundancyResults 
includedRegionsWithNoMembers 
Integer format: int32
regionName (optional)
array[String] 
timeInMilliseconds regionResults (optional)
Long format: int64
RebalanceResult
map[String, RegionRedundancyStatus] 
satisfiedRedundancyRegionResults rebalanceRegionResults (optional)
arraymap[RebalanceRegionResultString, RegionRedundancyStatus] 
statusMessage (optional)
String 
success (optional)
Boolean 
Region
totalPrimaryTransferTime (optional)
Long format: int64
totalPrimaryTransfersCompleted diskStoreName (optional)
String
Integer format: int32
underRedundancyRegionResults eviction (optional)
Eviction
map[String, RegionRedundancyStatus] 
zeroRedundancyRegionResults expirations (optional)
arraymap[Expiration]String, RegionRedundancyStatus]
RuntimeRegionInfo 
entryCount (optional)
Long format: int64
memberName group (optional)
String 
StackTraceElement 
keyConstraint className (optional)
String 
name fileName (optional)
String 
redundantCopies lineNumber (optional)
Integer format: int32
type methodName (optional)
String 
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
nativeMethod (optional)
Boolean 
Throwable 
cause (optional)
Throwable 
localizedMessage (optional)
String 
message valueConstraint (optional)
String 
RuntimeRegionInfo
entryCount stackTrace (optional)
Long format: int64
array[StackTraceElement] 
suppressed memberName (optional)
array[Throwable] 
body 
file 
byte[] filePath format: binaryString