Versions Compared

Old Version 60

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version Current

changes.mady.by.user Jinmei Liao

Saved on

Key

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

...

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

...

Deployment Management

GET /management

get documentation-links

Return type

Object

Example data

Content-Type: application

/

json
{ }

Responses

200

OK Object

401

Unauthorized

403

Forbidden

404

Not Found

Gateway Management

v1/deployments/{id}

get deployed

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_Deployment_DeploymentInfo 

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

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

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "linksresult" : {
    "selfgroups" : "uri" },
[ {
      "statusMessageconfiguration" : "statusMessage",{
  "statusCode      "deployedTime" : "OKdeployedTime"
}

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error. 
{
  "result" : {
    "configuration" : {
,
        "deployedBy" : "deployedBy",
        "jarFileName" : "jarFileName",
        "startPortgroup" : 5 "group"
      },
      "gatewayTransportFiltersruntimeInfo" : [ {
        "initPropertiesjarLocation" : {"jarLocation",
          "keymemberName" : { }
        }"memberName",
        "classNamelastModified" : "classNamelastModified"
      }, {
        "initPropertiesjarLocation" : {"jarLocation",
          "keymemberName" : { }
        }"memberName",
        "classNamelastModified" : "classNamelastModified"
      } ]
    }, {
      "manualStartconfiguration" : true,{
        "maximumTimeBetweenPingsdeployedTime" : 6"deployedTime",
        "endPortdeployedBy" : 0"deployedBy",
        "socketBufferSizejarFileName" : 1"jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSendersjarLocation" : [ "connectedSendersjarLocation",
 "connectedSenders" ],
      "runningmemberName" : true"memberName",
      "port" : 5,
      "hostnameForSenderslastModified" : "hostnameForSenderslastModified",
      "memberName" : "memberName",
}, {
        "bindAddressjarLocation" : "bindAddressjarLocation",
      "senderCount" : 2
    }, {
      "connectedSenders"memberName" : [ "connectedSendersmemberName",
 "connectedSenders" ],
      "runninglastModified" : true,
      "portlastModified" : 5,
      "hostnameForSenders" : "hostnameForSenders",} ]
      "memberName" : "memberName"} ],
      "bindAddressid" : "bindAddress",
      "senderCount" : 2
    } ]id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_GatewayReceiverDeployment_GatewayReceiverInfoDeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/

gateways/receivers

deployments

list gateway-receiversdeployed

Query parameters

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

Return type

ClusterManagementListResult_GatewayReceiverDeployment_GatewayReceiverInfoDeploymentInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "startPortconfiguration" : 5,{
        "gatewayTransportFiltersdeployedTime" : [ {"deployedTime",
        "initPropertiesdeployedBy" : {"deployedBy",
          "keyjarFileName" : { }
        }"jarFileName",
        "classNamegroup" : "classNamegroup"
      }, {
        "initPropertiesruntimeInfo" : [ {
        "jarLocation" : "keyjarLocation",
 : { }
     "memberName" :  }"memberName",
        "classNamelastModified" : "classNamelastModified"
      }, ],{
        "manualStartjarLocation" : true"jarLocation",
        "maximumTimeBetweenPingsmemberName" : 6"memberName",
        "endPortlastModified" : 0,
"lastModified"
      } ]
 "socketBufferSize"  : 1}, {
      "groupconfiguration" : "group"{
    },
    "runtimeInfodeployedTime" : [ {
"deployedTime",
        "connectedSendersdeployedBy" : [ "connectedSendersdeployedBy",
 "connectedSenders" ],
      "runningjarFileName" : true"jarFileName",
        "portgroup" : 5"group"
      },
      "hostnameForSendersruntimeInfo" : "hostnameForSenders",[ {
        "memberNamejarLocation" : "memberNamejarLocation",
        "bindAddressmemberName" : "bindAddressmemberName",
        "senderCountlastModified" : 2"lastModified"
      }, {
        "connectedSendersjarLocation" : [ "connectedSendersjarLocation",
 "connectedSenders" ],
      "runningmemberName" : true"memberName",
        "portlastModified" : 5,"lastModified"
      "hostnameForSenders" : "hostnameForSenders",
  } ]
    } ],
    "memberNameid" : "memberNameid",
  }, {
    "bindAddressgroups" : "bindAddress",[ {
      "senderCountconfiguration" : 2{
    } ]
  }, {
 "deployedTime" : "deployedTime",
        "configurationdeployedBy" : {"deployedBy",
        "startPortjarFileName" : 5"jarFileName",
        "gatewayTransportFiltersgroup" : [ {
"group"
      },
      "initPropertiesruntimeInfo" : [ {
        "jarLocation" : "keyjarLocation" :,
 { }
      "memberName" : }"memberName",
        "classNamelastModified" : "classNamelastModified"
      }, {
        "initPropertiesjarLocation" : {"jarLocation",
          "keymemberName" : { }
        }"memberName",
        "classNamelastModified" : "classNamelastModified"
      } ],
      "manualStart" : true,}, {
      "maximumTimeBetweenPingsconfiguration" : 6,{
        "endPortdeployedTime" : 0"deployedTime",
        "socketBufferSizedeployedBy" : 1"deployedBy",
        "jarFileName" : "jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSendersjarLocation" : [ "connectedSendersjarLocation",
 "connectedSenders" ],
      "runningmemberName" : true"memberName",
        "portlastModified" : 5,
 "lastModified"
      }, {
        "hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
        "memberName" : "memberName",
        "bindAddresslastModified" : "bindAddresslastModified",
      "senderCount" : 2} ]
    } ], {
      "connectedSendersid" : [ "connectedSendersid", "connectedSenders"
  } ],
  "links" :  { "runningself" : true,
      "porturi" : 5},
      "hostnameForSendersstatusMessage" : "hostnameForSendersstatusMessage",
      "memberNamestatusCode" : "memberNameOK",
      "bindAddress" : "bindAddress",
      "senderCount" : 2
    } ]
  } ],
  "links" : { "self
}

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
{
  "latest" : "urilatest" },
  "statusMessagesupported" : [ "statusMessagesupported",
  "statusCodesupported" : "OK"]
}

Responses

200

OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo DocLinks

401

Unauthorized

403

Forbidden

404

Not Found

...

Gateway Management

GET

POST /management/v1/

members

gateways/

{id}
get member

Path parameters

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 id (required)
Path Parameter -- id Request Body

Return type

ClusterManagementGetResult_Member_MemberInformation ClusterManagementResult

Example data

Content-Type: application/json
{
  "resultlinks" : {
 "self"  : "configurationuri" : {
    },
  "idstatusMessage" : "idstatusMessage",
      "groupstatusCode" : "groupOK"
}

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" : [ {    },
    "runtimeInfo" : [ {
      "cpuUsage" : 5.637376656633329,
      "server" : true,
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberName" : "memberName",
      "locators" : "locators",
      "processIdconfiguration" : 4,{
        "webSSLstartPort" : true5,
        "hostedRegionsgatewayTransportFilters" : [ "hostedRegions", "hostedRegions" ],
 {
          "hostinitProperties" : "host",{
      "maxHeapSize" : 2,
      "workingDirPath"key" : "workingDirPath", { }
      "id"   : "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" : [ "connectedSenders", "groupsconnectedSenders" ],
        "serverBindAddressrunning" : "serverBindAddress"true,
        "cacheXmlFilePathport" : "cacheXmlFilePath"5,
        "locatorPorthostnameForSenders" : 3"hostnameForSenders",
        "heapUsagememberName" : 2"memberName",
      "initHeapSize" : 9,
      "logFilePath"bindAddress" : "logFilePathbindAddress",
        "offHeapMemorySizesenderCount" : "offHeapMemorySize",2
      "secured" : true,
}, {
        "statArchiveFilePathconnectedSenders" : [ "statArchiveFilePathconnectedSenders",
      "statusconnectedSenders" : "status"
    }, {
],
        "cpuUsagerunning" : 5.637376656633329true,
        "serverport" : true5,
        "httpServiceBindAddresshostnameForSenders" : "httpServiceBindAddresshostnameForSenders",
        "memberName" : "memberName",
        "locatorsbindAddress" : "locatorsbindAddress",
        "processIdsenderCount" : 4,2
      "webSSL" : true,} ]
    }, {
      "hostedRegionsconfiguration" : [ "hostedRegions", "hostedRegions" ],
{
         "hoststartPort" : "host"5,
        "maxHeapSizegatewayTransportFilters" : 2,[ {
          "workingDirPathinitProperties" : "workingDirPath",{
      "id" : "id",
      "clientCountkey" : { 5,}
      "httpServicePort"   : 7},
          "cacheServerInfoclassName" : [ {"className"
        "running" : true,
}, {
          "portinitProperties" : 1,{
            "maxThreadskey" : { 6,}
        "bindAddress" : "bindAddress"},
          "maxConnectionsclassName" : 0"className"
        } ], {
        "runningmanualStart" : true,
        "portmaximumTimeBetweenPings" : 16,
        "maxThreadsendPort" : 60,
        "bindAddresssocketBufferSize" : "bindAddress"1,
        "maxConnectionsgroup" : 0"group"
      } ],
      "coordinatorruntimeInfo" : true,[ {
        "groupsconnectedSenders" : [ "groups"connectedSenders", "connectedSenders" ],
        "serverBindAddressrunning" : "serverBindAddress"true,
        "port" : 5,
        "cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
        "locatorPortmemberName" : 3"memberName",
        "heapUsagebindAddress" : 2"bindAddress",
        "initHeapSizesenderCount" : 9, 2
      }, {
        "logFilePathconnectedSenders" : [ "logFilePath"connectedSenders", "connectedSenders" ],
        "offHeapMemorySizerunning" : "offHeapMemorySize"true,
        "securedport" : true5,
        "statArchiveFilePathhostnameForSenders" : "statArchiveFilePathhostnameForSenders",
        "statusmemberName" : "statusmemberName",
    } ]
  },
  "linksbindAddress" : { "selfbindAddress",
 :       "senderCount" : 2
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_MemberGatewayReceiver_MemberInformationGatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/

members

gateways/receivers

list membersgateway-receivers

Query parameters

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

Return type

ClusterManagementListResult_MemberGatewayReceiver_MemberInformationGatewayReceiverInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "idconfiguration" : "id",
{
        "groupstartPort" : "group"5,
    },
    "runtimeInfogatewayTransportFilters" : [ {
          "cpuUsageinitProperties" : 5.637376656633329,
{
            "serverkey" : true,{ }
      "httpServiceBindAddress"   : "httpServiceBindAddress"},
          "memberNameclassName" : "memberNameclassName",
      "locators" : "locators"}, {
          "processIdinitProperties" : 4,{
      "webSSL" : true,
      "hostedRegionskey" : [ "hostedRegions", "hostedRegions" ],
{ }
        "host" : "host"},
      "maxHeapSize" : 2,
      "workingDirPathclassName" : "workingDirPathclassName",
      "id"  :} "id"],
        "clientCountmanualStart" : 5true,
        "httpServicePortmaximumTimeBetweenPings" : 76,
        "cacheServerInfoendPort" : [ {0,
        "runningsocketBufferSize" : true1,
        "portgroup" : 1,"group"
      },
      "maxThreadsruntimeInfo" : 6,[ {
        "bindAddressconnectedSenders" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
        "maxConnectionsrunning" : 0
      }, {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, ],{
        "coordinatorconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
        "groupsrunning" : "groups"true,
        "serverBindAddressport" : "serverBindAddress"5,
        "cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
        "locatorPortmemberName" : 3"memberName",
        "heapUsagebindAddress" : 2"bindAddress",
        "initHeapSizesenderCount" : 9,2
      "logFilePath" : "logFilePath",} ]
    }, {
      "offHeapMemorySizeconfiguration" : "offHeapMemorySize",
{
        "securedstartPort" : true5,
        "statArchiveFilePathgatewayTransportFilters" : "statArchiveFilePath",
[ {
          "statusinitProperties" : "status"{
    },  {
      "cpuUsagekey" : 5.637376656633329,{ }
      "server"   : true},
          "httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
      "memberName" : "memberName"}, {
          "locatorsinitProperties" : "locators",{
      "processId" : 4,
      "webSSLkey" : true,{ }
      "hostedRegions"  : [ "hostedRegions"},
 "hostedRegions" ],
         "hostclassName" : "hostclassName",
       "maxHeapSize" :} 2],
        "workingDirPathmanualStart" : "workingDirPath"true,
        "idmaximumTimeBetweenPings" : "id"6,
        "clientCountendPort" : 50,
        "httpServicePortsocketBufferSize" : 71,
        "cacheServerInfogroup" : [ {"group"
        "running" : true},
        "portruntimeInfo" : 1,[ {
        "maxThreadsconnectedSenders" : 6,
        "bindAddress" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
        "maxConnectionsrunning" : 0
      }, {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, ],{
        "coordinatorconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
        "groupsrunning" : "groups"true,
        "serverBindAddressport" : "serverBindAddress"5,
        "cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
        "locatorPortmemberName" : 3"memberName",
        "heapUsagebindAddress" : 2"bindAddress",
        "initHeapSizesenderCount" : 9, 2
      } ]
    } ],
    "logFilePathid" : "logFilePathid",
  }, {
    "offHeapMemorySizegroups" : "offHeapMemorySize",[ {
      "securedconfiguration" : true,{
        "statArchiveFilePathstartPort" : "statArchiveFilePath"5,
        "statusgatewayTransportFilters" : "status"
 [ {
   } ]
  }, {
    "configurationinitProperties" : {
      "id      "key" : "id",
 { }
        "group" : "group"},
     },
     "runtimeInfoclassName" : [ {"className"
      "cpuUsage" : 5.637376656633329}, {
          "serverinitProperties" : true,{
      "httpServiceBindAddress" : "httpServiceBindAddress",
      "memberNamekey" : "memberName"{ }
          },
          "locatorsclassName" : "locatorsclassName",
       "processId" :} 4],
        "webSSLmanualStart" : true,
        "hostedRegionsmaximumTimeBetweenPings" : [ "hostedRegions"6,
 "hostedRegions" ],
      "hostendPort" : "host"0,
        "maxHeapSizesocketBufferSize" : 21,
        "workingDirPathgroup" : "workingDirPathgroup",
      "id" : "id"},
      "clientCountruntimeInfo" : 5,[ {
        "httpServicePortconnectedSenders" : 7 [ "connectedSenders", "connectedSenders" ],
        "cacheServerInforunning" : [ {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, {
        "runningconnectedSenders" : true,
  [ "connectedSenders", "connectedSenders" ],
        "portrunning" : 1true,
        "maxThreadsport" : 65,
        "bindAddresshostnameForSenders" : "bindAddresshostnameForSenders",
        "maxConnectionsmemberName" : 0"memberName",
      } ]  "bindAddress" : "bindAddress",
        "coordinatorsenderCount" : true,2
      } ]
  "groups" : "groups"}, {
      "serverBindAddressconfiguration" : "serverBindAddress",{
        "cacheXmlFilePathstartPort" : "cacheXmlFilePath"5,
        "locatorPortgatewayTransportFilters" : 3,
[ {
          "heapUsageinitProperties" : 2,{
            "initHeapSizekey" : { 9,}
      "logFilePath"   : "logFilePath"},
          "offHeapMemorySizeclassName" : "offHeapMemorySizeclassName",
      "secured" : true}, {
          "statArchiveFilePathinitProperties" : "statArchiveFilePath",
{
            "key" : { }
          },
          "statusclassName" : "statusclassName"
        } ],
 {
       "cpuUsagemanualStart" : 5.637376656633329true,
        "servermaximumTimeBetweenPings" : true6,
        "httpServiceBindAddressendPort" : "httpServiceBindAddress"0,
        "memberNamesocketBufferSize" : "memberName"1,
        "locatorsgroup" : "locatorsgroup",
      "processId" : 4},
      "webSSLruntimeInfo" : [ true,{
        "hostedRegionsconnectedSenders" : [ "hostedRegionsconnectedSenders", "hostedRegionsconnectedSenders" ],
        "hostrunning" : "host"true,
        "maxHeapSizeport" : 25,
        "workingDirPathhostnameForSenders" : "workingDirPathhostnameForSenders",
        "idmemberName" : "idmemberName",
        "clientCountbindAddress" : 5"bindAddress",
        "httpServicePortsenderCount" : 7,2
      "cacheServerInfo" : [ }, {
        "runningconnectedSenders" : true,
       [ "portconnectedSenders" : 1,
        "maxThreads"connectedSenders" : 6],
        "bindAddressrunning" : "bindAddress"true,
        "maxConnectionsport" : 0
      }, {5,
        "runninghostnameForSenders" : true"hostnameForSenders",
        "portmemberName" : 1,
        "maxThreadsmemberName" : 6,
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      } ],
      "coordinator" : true} ],
      "groupsid" : "groups"id"
  } ],
  "links" :  { "serverBindAddressself" : "serverBindAddressuri" },
      "cacheXmlFilePathstatusMessage" : "cacheXmlFilePathstatusMessage",
  "statusCode" : "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
{
  "locatorPortresult" : 3,{
      "heapUsagegroups" : 2,[ {
      "initHeapSizeconfiguration" : 9,{
        "logFilePathid" : "logFilePathid",
        "offHeapMemorySizegroup" : "offHeapMemorySize"group"
      },
      "securedruntimeInfo" : [ true,{
        "statArchiveFilePathcpuUsage" : "statArchiveFilePath"5.637376656633329,
        "statusserver" : "status"true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
    }   ]
 "memberName" }: ]"memberName",
        "linkslocators" : { "locators",
        "selfprocessId" : 4,
        "uriwebSSL" : }true,
  "statusMessage      "hostedRegions" : "statusMessage",
[ "hostedRegions", "hostedRegions" ],
        "statusCodehost" : "OKhost"
}

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" : {
    "configuration" : {
      "autoSerializer" : {
,
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "patternsbindAddress" : [ "patternsbindAddress",
 "patterns" ],
        "portablemaxConnections" : true0
        }, {
          "readSerializedrunning" : true,
          "diskStoreNameport" : "diskStoreName"1,
      "ignoreUnreadFields" : true,
      "pdxSerializermaxThreads" : {6,
          "initPropertiesbindAddress" : {"bindAddress",
          "keymaxConnections" : { }0
        } ],
        "classNamecoordinator" : "className"
      }true,
    },
    "runtimeInfogroups" : [ {
      "readSerializedgroups",
 : true,
      "memberNameserverBindAddress" : "memberNameserverBindAddress",
        "diskStoreNamecacheXmlFilePath" : "diskStoreNamecacheXmlFilePath",
        "ignoreUnreadFieldslocatorPort" : true3,
        "pdxSerializerheapUsage" : "pdxSerializer"2,
    }, {
      "readSerializedinitHeapSize" : true9,
        "memberNamelogFilePath" : "memberNamelogFilePath",
        "diskStoreNameoffHeapMemorySize" : "diskStoreNameoffHeapMemorySize",
        "ignoreUnreadFieldssecured" : true,
        "pdxSerializerstatArchiveFilePath" : "pdxSerializerstatArchiveFilePath",
    } ]
  },
  "linksstatus" : { "self" : "uri" },
  "statusMessage "status"
      }, {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "statusMessagehttpServiceBindAddress",
        "statusCodememberName" : "OKmemberName"
}

Responses

200

OK ClusterManagementGetResult_Pdx_PdxInfo

401

Unauthorized

403

Forbidden

404

Not Found

Ping

GET /management/v1/ping

ping

Return type

String

Example data

Content-Type: application/json
""

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

Rebalance Operation

GET /management/v1/operations/rebalances/{id}

check rebalance

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementOperationStatusResult_RebalanceResult

Example data

Content-Type: application/json
{
  "result" : {
    "rebalanceRegionResults" : [ {
,
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "bucketCreateTimeInMillisecondshostedRegions" : [ 6,
     "hostedRegions", "primaryTransferTimeInMillisecondshostedRegions" : 7],
        "bucketCreatesCompletedhost" : 1"host",
        "bucketTransfersCompletedmaxHeapSize" : 2,
        "bucketCreateBytesworkingDirPath" : 0"workingDirPath",
        "regionNameid" : "regionNameid",
        "bucketTransferTimeInMillisecondsclientCount" : 5,
        "timeInMillisecondshttpServicePort" : 37,
        "primaryTransfersCompletedcacheServerInfo" : 9,[ {
          "bucketTransferBytesrunning" : 5true,
    }, {
      "bucketCreateTimeInMillisecondsport" : 61,
          "primaryTransferTimeInMillisecondsmaxThreads" : 76,
          "bucketCreatesCompletedbindAddress" : 1"bindAddress",
          "bucketTransfersCompletedmaxConnections" : 2,0
      "bucketCreateBytes" : 0}, {
          "regionNamerunning" : "regionName"true,
          "bucketTransferTimeInMillisecondsport" : 51,
          "timeInMillisecondsmaxThreads" : 36,
          "primaryTransfersCompletedbindAddress" : 9"bindAddress",
          "bucketTransferBytesmaxConnections" : 50
        } ],
        "successcoordinator" : true,
        "statusMessagegroups" : "statusMessagegroups",
      },
  "operationEndedserverBindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXserverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
  "operationStart      "locatorPort" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "links" : { "self3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "urilogFilePath" },
  "operator      "offHeapMemorySize" : "offHeapMemorySize",
        "operatorsecured" : true,
  "statusMessage      "statArchiveFilePath" : "statusMessagestatArchiveFilePath",
        "statusCodestatus" : "OKstatus"
      }

Responses

200

OK ClusterManagementOperationStatusResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found 

GET /management/v1/operations/rebalances

list rebalances

Return type

ClusterManagementListOperationsResult_RebalanceResult

Example data

Content-Type: application/json

GET /management/v1/regions/{regionName}/indexes/{id}

get index

Path parameters

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

Return type

ClusterManagementGetResult_Index_RuntimeInfo

Example data

Content-Type: application/json
{
  "result ]
    }, {
      "configuration" : [ {
        "operationEndedid" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXid",
        "operationStartgroup" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",group"
    "operationId" : "operationId"},
      "operatorruntimeInfo" : "operator",
 [ {
        "statusMessagecpuUsage" : "statusMessage"5.637376656633329,
        "statusCodeserver" : "OK"true,
  },  {
    "operationEndedhttpServiceBindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXhttpServiceBindAddress",
        "operationStartmemberName" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXmemberName",
        "operationIdlocators" : "operationIdlocators",
        "operatorprocessId" : "operator"4,
        "statusMessagewebSSL" : "statusMessage"true,
        "statusCodehostedRegions" : [ "OKhostedRegions"
  }, "hostedRegions" ],
  "links      "host" : { "selfhost" :,
        "urimaxHeapSize" : }2,
  "statusMessage      "workingDirPath" : "statusMessageworkingDirPath",
        "statusCodeid" : "OKid"
}

Responses

200

OK ClusterManagementListOperationsResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found 

POST /management/v1/operations/rebalances

start rebalance

Consumes

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

Request body

body RebalanceOperation (required)
Body Parameter -- operation

Return type

ClusterManagementOperationResult_RebalanceResult

Example data

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

Responses

200

OK ClusterManagementOperationResult_RebalanceResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Region Management

POST /management/v1/regions

create region

Consumes

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

Request body

body Region (required)
Body Parameter -- regionConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "links" : { "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/{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/{id}

get region

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_Region_RuntimeRegionInfo

Example data

Content-Type: application/json
{
  "result" : {
    "configuration" : {
      "regionPath" : "regionPath,
        "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",
        "expressionoffHeapMemorySize" : "expressionoffHeapMemorySize",
        "keyIndexsecured" : true,
        "namestatArchiveFilePath" : "namestatArchiveFilePath",
        "groupstatus" : "groupstatus"
      }, {
        "runtimeInfocpuUsage" : [ {5.637376656633329,
        "server" : true,
        "memberNamehttpServiceBindAddress" : "memberNamehttpServiceBindAddress",
        "memberName" : }"memberName",
  {
      "memberNamelocators" : "memberNamelocators",
       } ]
"processId" : }4,
  "links      "webSSL" : { true,
        "selfhostedRegions" : [ "hostedRegions", "urihostedRegions" }],
        "statusMessagehost" : "host",
        "statusMessagemaxHeapSize" : 2,
        "statusCodeworkingDirPath" : "OKworkingDirPath"
}

Responses

200

OK ClusterManagementGetResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found 
{
  "result" : {
    "configuration" : {
,
        "id" : "id",
        "expirationsclientCount" : [ {5,
        "actionhttpServicePort" : "DESTROY"7,
        "typecacheServerInfo" : "ENTRY_TIME_TO_LIVE", [ {
          "timeInSecondsrunning" : 0true,
      }, {
        "actionport" : "DESTROY"1,
          "typemaxThreads" : "ENTRY_TIME_TO_LIVE"6,
          "timeInSecondsbindAddress" : 0"bindAddress",
      } ],
      "redundantCopiesmaxConnections" : 6,0
      "keyConstraint" : "keyConstraint"}, {
          "namerunning" : "name"true,
          "valueConstraintport" : "valueConstraint"1,
          "typemaxThreads" : "PARTITION"6,
          "diskStoreNamebindAddress" : "diskStoreNamebindAddress",
          "groupmaxConnections" : "group"0
    },
    "runtimeInfo" : [ {
} ],
        "entryCountcoordinator" : 1true,
        "memberNamegroups" : "memberNamegroups",
    }, {
      "entryCountserverBindAddress" : 1"serverBindAddress",
        "memberNamecacheXmlFilePath" : "memberNamecacheXmlFilePath",
    } ]
  },
  "linkslocatorPort" : { "self" : "uri" }3,
  "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_RuntimeInfo

Example data

Content-Type: application/json
{
  "result" : [ {
heapUsage" : 2,
        "configurationinitHeapSize" : {9,
        "regionPathlogFilePath" : "regionPathlogFilePath",
        "expressionoffHeapMemorySize" : "expressionoffHeapMemorySize",
        "keyIndexsecured" : true,
        "namestatArchiveFilePath" : "namestatArchiveFilePath",
        "groupstatus" : "groupstatus"
    },
    "runtimeInfo" : [ {} ]
      "memberName" : "memberName"
    }, {} ],
      "memberNameid" : "memberName"
    } ]id"
  }, {
    "configurationlinks" : {
      "regionPathself" : "regionPathuri",
      "expression" : "expression" },
      "keyIndex" : true,
      "name""statusMessage" : "namestatusMessage",
      "groupstatusCode" : "groupOK"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo 
}

Responses

200

OK ClusterManagementGetResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/

regions/{regionName}/indexes

members

list region indexesmembers
Path

Query parameters

regionName group (requiredoptional)
Path Query Parameter -- regionName
Query parameters
group
id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult_IndexMember_RuntimeInfoMemberInformation

Example data

Content-Type: application/json
{
  "result" : [ {
    "configurationgroups" : [ {
      "regionPathconfiguration" : "regionPath",{
        "expressionid" : "expressionid",
        "keyIndexgroup" : true,"group"
      "name" : "name"},
      "groupruntimeInfo" : "group"[ {
    },
    "runtimeInfocpuUsage" : 5.637376656633329,
 [ {
      "memberNameserver" : "memberName"true,
    }, {
      "memberNamehttpServiceBindAddress" : "memberNamehttpServiceBindAddress",
    } ]
  }, {
    "configuration" : {
 "memberName" : "memberName",
        "regionPathlocators" : "regionPathlocators",
        "expressionprocessId" : "expression"4,
        "keyIndexwebSSL" : true,
        "namehostedRegions" : [ "hostedRegions", "namehostedRegions" ],
        "grouphost" : "grouphost",
    },
    "runtimeInfomaxHeapSize" : 2,
 [ {
      "memberNameworkingDirPath" : "memberNameworkingDirPath",
        }, {"id" : "id",
        "clientCount" : 5,
        "memberNamehttpServicePort" : "memberName"7,
        "cacheServerInfo" : [ {
    } ]
  } ],
  "linksrunning" : {true,
          "selfport" : 1,
          "urimaxThreads" }: 6,
    "statusMessage      "bindAddress" : "statusMessagebindAddress",
          "statusCodemaxConnections" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo

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" : [ {
    "configuration" : {
0
        }, {
          "running" : true,
          "expirationsport" : 1,
 [ {
        "actionmaxThreads" : "DESTROY"6,
          "typebindAddress" : "ENTRY_TIME_TO_LIVEbindAddress",
          "timeInSecondsmaxConnections" : 0
        } ], {
        "actioncoordinator" : "DESTROY"true,
        "typegroups" : "ENTRY_TIME_TO_LIVE",groups",
        "timeInSecondsserverBindAddress" : 0"serverBindAddress",
      } ]  "cacheXmlFilePath" : "cacheXmlFilePath",
        "redundantCopieslocatorPort" : 63,
        "keyConstraintheapUsage" : "keyConstraint"2,
        "nameinitHeapSize" : "name"9,
        "valueConstraintlogFilePath" : "valueConstraintlogFilePath",
        "typeoffHeapMemorySize" : "PARTITIONoffHeapMemorySize",
        "diskStoreNamesecured" : "diskStoreName"true,
        "groupstatArchiveFilePath" : "groupstatArchiveFilePath",
    },
    "runtimeInfostatus" : [ "status"
      }, {
        "entryCountcpuUsage" : 15.637376656633329,
        "memberNameserver" : "memberName"true,
    }, {
      "entryCounthttpServiceBindAddress" : 1"httpServiceBindAddress",
        "memberName" : "memberName",
    } ]
  }, {
    "configurationlocators" : {"locators",
        "expirationsprocessId" : [ {4,
        "actionwebSSL" : "DESTROY"true,
        "typehostedRegions" : [ "ENTRY_TIME_TO_LIVE"hostedRegions", "hostedRegions" ],
        "timeInSecondshost" : 0"host",
        "maxHeapSize" : }2, {
        "actionworkingDirPath" : "DESTROYworkingDirPath",
        "typeid" : "ENTRY_TIME_TO_LIVEid",
        "timeInSecondsclientCount" : 05,
      } ],
      "redundantCopieshttpServicePort" : 67,
        "keyConstraintcacheServerInfo" : "keyConstraint", [ {
          "namerunning" : "name"true,
          "valueConstraintport" : "valueConstraint"1,
          "typemaxThreads" : "PARTITION"6,
          "diskStoreNamebindAddress" : "diskStoreNamebindAddress",
          "groupmaxConnections" : "group"0
     },   }, {
    "runtimeInfo      "running" : [ {
true,
          "entryCountport" : 1,
          "memberNamemaxThreads" : "memberName"6,
    }, {
      "entryCountbindAddress" : 1"bindAddress",
          "memberNamemaxConnections" : "memberName"0
        } ],
     } ],
   "coordinator" : true,
        "linksgroups" : { "groups",
        "selfserverBindAddress" : "uriserverBindAddress" },
        "statusMessagecacheXmlFilePath" : "statusMessagecacheXmlFilePath",
        "statusCodelocatorPort" : 3,
        "OK"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

Models

AutoSerializer

portable (optional)
Boolean
patterns (optional)
array[String]

CacheServerInfo

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

ClassName

className (optional)
String
initProperties (optional)
map[String, Object] 
heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      } ]
    }, {
      "configuration" : {
        "id" : "id",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
        "memberName" : "memberName",
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "host",
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        } ],
        "coordinator" : true,
        "groups" : "groups",
        "serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
        "locatorPort" : 3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      }, {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
        "memberName" : "memberName",
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "host",
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        } ],
        "coordinator" : true,
        "groups" : "groups",
        "serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
        "locatorPort" : 3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "id" : "id",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
        "memberName" : "memberName",
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "host",
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        } ],
        "coordinator" : true,
        "groups" : "groups",
        "serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
        "locatorPort" : 3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      }, {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
        "memberName" : "memberName",
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "host",
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        } ],
        "coordinator" : true,
        "groups" : "groups",
        "serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
        "locatorPort" : 3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      } ]
    }, {
      "configuration" : {
        "id" : "id",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
        "memberName" : "memberName",
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "host",
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        } ],
        "coordinator" : true,
        "groups" : "groups",
        "serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
        "locatorPort" : 3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      }, {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "httpServiceBindAddress" : "httpServiceBindAddress",
        "memberName" : "memberName",
        "locators" : "locators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "host",
        "maxHeapSize" : 2,
        "workingDirPath" : "workingDirPath",
        "id" : "id",
        "clientCount" : 5,
        "httpServicePort" : 7,
        "cacheServerInfo" : [ {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        }, {
          "running" : true,
          "port" : 1,
          "maxThreads" : 6,
          "bindAddress" : "bindAddress",
          "maxConnections" : 0
        } ],
        "coordinator" : true,
        "groups" : "groups",
        "serverBindAddress" : "serverBindAddress",
        "cacheXmlFilePath" : "cacheXmlFilePath",
        "locatorPort" : 3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "logFilePath",
        "offHeapMemorySize" : "offHeapMemorySize",
        "secured" : true,
        "statArchiveFilePath" : "statArchiveFilePath",
        "status" : "status"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

Pdx Management

POST /management/v1/configurations/pdx

configure pdx

Consumes

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

Request body

body Pdx (required)
Body Parameter -- pdxType

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

...

GET /management/v1/configurations/pdx

get pdx

Return type

ClusterManagementGetResult_Pdx_PdxInfo

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "autoSerializer" : {
          "patterns" : [ "patterns", "patterns" ],
          "portable" : true
        },
        "readSerialized" : true,
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        }
      },
      "runtimeInfo" : [ {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      }, {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      } ]
    }, {
      "configuration" : {
        "autoSerializer" : {
          "patterns" : [ "patterns", "patterns" ],
          "portable" : true
        },
        "readSerialized" : true,
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        }
      },
      "runtimeInfo" : [ {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      }, {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Pdx_PdxInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Ping

GET /management/v1/ping

ping

Return type

String

Example data

Content-Type: application/json
""

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

...

Rebalance Operation

GET /management/v1/operations/rebalances/{id}

check rebalance

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementOperationStatusResult_RebalanceResult

Example data

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

Responses

200

OK ClusterManagementOperationStatusResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/operations/rebalances

list rebalances

Return type

ClusterManagementListOperationsResult_RebalanceResult

Example data

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

Responses

200

OK ClusterManagementListOperationsResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

...

POST /management/v1/operations/rebalances

start rebalance

Consumes

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

Request body

body RebalanceOperation (required)
Body Parameter -- operation

Return type

ClusterManagementOperationResult_RebalanceResult

Example data

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

Responses

200

OK ClusterManagementOperationResult_RebalanceResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Region Management

POST /management/v1/regions/{regionName}/indexes

create region index

Path parameters

regionName (required)
Path Parameter -- regionName

Consumes

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

Request body

body Index (required)
Body Parameter -- indexConfig

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Index already exists.

500

Internal error.

...

POST /management/v1/indexes

create index

Consumes

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

Request body

body Index (required)
Body Parameter -- indexConfig

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Index already exists.

500

Internal error.

...

POST /management/v1/regions

create region

Consumes

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

Request body

body Region (required)
Body Parameter -- regionConfig

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

...

DELETE /management/v1/regions/{regionName}/indexes/{indexName}

delete region index

Path parameters

indexName (required)
Path Parameter -- indexName
regionName (required)
Path Parameter -- regionName

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

...

DELETE /management/v1/regions/{id}

delete region

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

...

GET /management/v1/regions/{regionName}/indexes/{id}

get index

Path parameters

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

Return type

ClusterManagementGetResult_Index_IndexInfo

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions/{id}

get region

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_Region_RuntimeRegionInfo

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/indexes

list indexes

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult_Index_IndexInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions/{regionName}/indexes

list region indexes

Path parameters

regionName (required)
Path Parameter -- regionName

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult_Index_IndexInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions

list regions

Query parameters

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

Return type

ClusterManagementListResult_Region_RuntimeRegionInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Models

AutoSerializer

portable (optional)
Boolean
patterns (optional)
array[String]

CacheServerInfo

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

ClassName

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

ClusterManagementGetResult_Deployment_DeploymentInfo

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

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

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

ClusterManagementGetResult_Index_IndexInfo

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

ClusterManagementGetResult_Member_MemberInformation

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

ClusterManagementGetResult_Pdx_PdxInfo

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

ClusterManagementGetResult_Region_RuntimeRegionInfo

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

ClusterManagementListOperationsResult_RebalanceResult

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

links (optional)
Links
result (optional)
ConfigurationResult_GatewayReceiver_GatewayReceiverInfo array[ClusterManagementOperationResult_RebalanceResult]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult

ClusterManagementListResult_

Index

Deployment_

RuntimeInfo

DeploymentInfo

links (optional)
Links
result (optional)
ConfigurationResultarray[EntityInfo_IndexDeployment_RuntimeInfoDeploymentInfo]
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)
ConfigurationResultarray[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)
ConfigurationResultarray[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)
ConfigurationResultarray[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_

GatewayReceiver_GatewayReceiverInfo

RebalanceResult

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

ClusterManagementOperationStatusResult_

Index_RuntimeInfo

RebalanceResult

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

ClusterManagementListResult_Member_MemberInformation

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

ClusterManagementResult

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

ClusterManagementOperationResult_RebalanceResult

Deployment

deployedBy (optional)
String
deployedTime (optional)
String
group (optional)
String
jarFileName (optional)
String

DeploymentInfo

jarLocation (optional)
String
lastModified links (optional)
Links String
operationEnded memberName (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
latest operationId (optional)
String
operationStart supported (optional)
array[String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
]

EntityGroupInfo_Deployment_DeploymentInfo

configuration (optional)
Deployment
runtimeInfo (optional)
array[DeploymentInfo]

EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo

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

EntityGroupInfo_Index_IndexInfo

configuration operator (optional)
String Index
statusCode runtimeInfo (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementOperationStatusResult_RebalanceResult

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

EntityGroupInfo_Member_MemberInformation

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

EntityGroupInfo_Pdx_PdxInfo

configuration (optional)
Pdx
runtimeInfo (optional)
array[PdxInfo]

EntityGroupInfo_Region_RuntimeRegionInfo

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

EntityInfo_Deployment_DeploymentInfo

groups (optional)
array[EntityGroupInfo_Deployment_DeploymentInfo]
id (optional)
String
links (optional)
Links

EntityInfo_GatewayReceiver_GatewayReceiverInfo

groups (optional)
array[EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo]
id (optional)
String
ClusterManagementResult
links (optional)
Links

EntityInfo_Index_IndexInfo

groups statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
array[EntityGroupInfo_Index_IndexInfo]
id (optional)
String
links (optional)
Links

EntityInfo_Member_MemberInformation

groups (optional)
array[EntityGroupInfo_Member_MemberInformation]
id (optional)
String

ConfigurationResult_GatewayReceiver_GatewayReceiverInfo

configuration (optional)
GatewayReceiver
links (optional)
Links

EntityInfo_Pdx_PdxInfo

groups runtimeInfo (optional)
array[GatewayReceiverInfo]

ConfigurationResult_Index_RuntimeInfo

EntityGroupInfo_Pdx_PdxInfo]
id configuration (optional)
Index String
links (optional)
Links

EntityInfo_Region_RuntimeRegionInfo

groups runtimeInfo (optional)
array[RuntimeInfo]

ConfigurationResult_Member_MemberInformation

EntityGroupInfo_Region_RuntimeRegionInfo]
id configuration (optional)
Member String
links (optional)
Links

Eviction

action runtimeInfo (optional)
array[MemberInformation]

ConfigurationResult_Pdx_PdxInfo

String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount configuration (optional)
Pdx
Integer format: int32
memorySizeMb links (optional)
Links
Integer format: int32
objectSizer runtimeInfo (optional)
array[PdxInfo]

ConfigurationResult_Region_RuntimeRegionInfo

ClassName
type configuration (optional)
Region
links (optional)
Links
runtimeInfo (optional)
array[RuntimeRegionInfo]
String
Enum:
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE

Expiration

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

...

Index

expression (optional)
String
group indexType (optional)
String
Enum:
KEY
RANGE
HASH_DEPRECATED
name keyIndex (optional)
Boolean String
name regionPath (optional)
String

IndexInfo

regionPath memberName (optional)
String

Member

group (optional)
String
id (optional)
String

...

Region

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

RuntimeInfo

memberName (optional)
String

RuntimeRegionInfo

entryCount (optional)
Long format: int64
memberName (optional)
String