Page History

Example data

Content-Type: application/json

{
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.

ANCHOR ="getGatewayReceiverUsingGET"

Up

get /v1/gateways/receivers/{id}

get gateway-receiver

Path parameters

id (required)

Path Parameter -- id

Return type

Example data

Content-Type: application/json

{
  "result" : {
    "configuration" : {
      "startPortlastModified" : 5,"lastModified"
      "gatewayTransportFilters" : [ }, {
        "initPropertiesjarLocation" : {"jarLocation",
          "keymemberName" : { }
        }"memberName",
        "classNamelastModified" : "classNamelastModified"
      } ]
    }, {
        "initPropertiesconfiguration" : {
        "deployedTime" : "keydeployedTime",
 : { }
     "deployedBy" :  }"deployedBy",
        "classNamejarFileName" : "classNamejarFileName",
      } ],
    "group" : "group"
    "manualStart" : true},
      "maximumTimeBetweenPingsruntimeInfo" : [ 6,{
        "endPortjarLocation" : 0"jarLocation",
        "socketBufferSizememberName" : 1"memberName",
        "grouplastModified" : "grouplastModified"
      }, {
        "runtimeInfojarLocation" : "jarLocation",
 [ {
      "connectedSendersmemberName" : [ "connectedSendersmemberName",
 "connectedSenders" ],
      "runninglastModified" : true,"lastModified"
      "port" : 5,} ]
      "hostnameForSenders" : "hostnameForSenders"} ],
      "memberNameid" : "memberNameid",
      "bindAddress" : "bindAddress"},
      "senderCountlinks" : 2
    }, {
      "connectedSendersself" : [ "connectedSendersuri", "connectedSenders" ]},
      "runningstatusMessage" : true,
      "portstatusMessage" : 5,
      "hostnameForSendersstatusCode" : "hostnameForSendersOK",
      "memberName" : "memberName",
      "bindAddress" : "bindAddress",
      "senderCount" : 2
    } ]
  },
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

Responses

200

OK ClusterManagementGetResult_Deployment_DeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found ANCHOR ="listGatewayReceiversUsingGET" Up get

...

GET /management/v1/

gateways/receivers

deployments

list gateway-receiversdeployed

Query parameters

group (optional)

Query Parameter -- group

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» ClusterManagementListResult_Deployment_DeploymentInfo

Example data

Content-Type: application/json

{
  "result" : [ {
    "configurationgroups" : [ {
      "startPortconfiguration" : 5,{
        "gatewayTransportFiltersdeployedTime" : [ {"deployedTime",
        "initPropertiesdeployedBy" : {"deployedBy",
        "jarFileName" : "jarFileName",
  "key      "group" : { "group"
      },
      "runtimeInfo" : [ },{
        "classNamejarLocation" : "classNamejarLocation",
        }, {"memberName" : "memberName",
        "initPropertieslastModified" : {"lastModified"
      }, {
        "keyjarLocation" : { }
"jarLocation",
        "memberName" : }"memberName",
        "classNamelastModified" : "classNamelastModified"
      } ]
    }, {
      "manualStartconfiguration" : true,{
        "maximumTimeBetweenPingsdeployedTime" : 6"deployedTime",
        "endPortdeployedBy" : 0"deployedBy",
        "socketBufferSizejarFileName" : 1"jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSendersjarLocation" : [ "connectedSendersjarLocation",
 "connectedSenders" ],
      "runningmemberName" : true"memberName",
        "portlastModified" : 5,
 "lastModified"
      }, {
        "hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
        "memberName" : "memberName",
        "bindAddresslastModified" : "bindAddresslastModified",
      "senderCount" : 2} ]
    } ], {
      "connectedSendersid" : [ "connectedSendersid",
 "connectedSenders" ]}, {
      "runninggroups" : [ true,{
      "portconfiguration" : 5,{
        "hostnameForSendersdeployedTime" : "hostnameForSendersdeployedTime",
        "memberNamedeployedBy" : "memberNamedeployedBy",
        "bindAddressjarFileName" : "bindAddressjarFileName",
        "senderCountgroup" : 2"group"
    } ]
  },
 {
     "configurationruntimeInfo" : [ {
        "startPortjarLocation" : 5"jarLocation",
        "gatewayTransportFiltersmemberName" : [ {"memberName",
        "initPropertieslastModified" : {
          "key" : { }
  lastModified"
      }, {
        "classNamejarLocation" : "className"
      }, {jarLocation",
        "initPropertiesmemberName" : {"memberName",
        "lastModified" : "keylastModified"
 : { }
   } ]
    }, {
        "classNameconfiguration" : "className"{
      } ],
      "manualStartdeployedTime" : true"deployedTime",
        "maximumTimeBetweenPingsdeployedBy" : 6"deployedBy",
        "endPortjarFileName" : 0"jarFileName",
      "socketBufferSize" : 1,
      "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSendersjarLocation" : [ "connectedSendersjarLocation",
 "connectedSenders" ],
      "runningmemberName" : true"memberName",
        "portlastModified" : 5,
 "lastModified"
      }, {
        "hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
        "memberName" : "memberName",
        "bindAddresslastModified" : "bindAddresslastModified",
      "senderCount" : 2} ]
    } ], {
      "connectedSendersid" : [ "connectedSendersid", "connectedSenders"
  } ],
      "runninglinks" : true,
      "port{ "self" : 5,
      "hostnameForSendersuri" : "hostnameForSenders"},
      "memberNamestatusMessage" : "memberNamestatusMessage",
      "bindAddressstatusCode" : "bindAddressOK",
      "senderCount" : 2
    } ]
  } ],
  "links" : { },
  "statusMessage
}

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" : "statusMessagelatest",
  "statusCodesupported" : [ "supported", "OKsupported" ]
}

Responses

200

OK ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» DocLinks

401

Unauthorized

403

Forbidden

404

Not Found

...

Gateway Management

ANCHOR ="getMemberUsingGET" Up get

POST /management/v1/

members/{id}

get member

Path parameters

gateways/receivers

create gateway-receiver

Consumes

This API call consumes the following media types via the 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" : "OK"
}

Responses

200

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

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

Example data

Content-Type: application/json

{
  "result" : {group"
    },
    "runtimeInfogroups" : [ {
      "cpuUsageconfiguration" : 5.637376656633329,{
        "serverstartPort" : true5,
        "httpServiceBindAddressgatewayTransportFilters" : "httpServiceBindAddress",
[ {
          "memberNameinitProperties" : "memberName",{
      "locators" : "locators",
      "processIdkey" : 4,{ }
      "webSSL"   : true},
       "hostedRegions" : [ "hostedRegionsclassName", : "hostedRegionsclassName" ],
      "host" : "host"}, {
          "maxHeapSizeinitProperties" : 2,{
      "workingDirPath" : "workingDirPath",
      "idkey" : "id",{ }
      "clientCount"   : 5},
          "httpServicePortclassName" : 7,"className"
      "cacheServerInfo" : [} {],
        "runningmanualStart" : true,
        "portmaximumTimeBetweenPings" : 16,
        "maxThreadsendPort" : 60,
        "bindAddresssocketBufferSize" : "bindAddress"1,
        "maxConnectionsgroup" : 0"group"
      }, {
        "runningruntimeInfo" : true,[ {
        "portconnectedSenders" : 1 [ "connectedSenders", "connectedSenders" ],
        "maxThreadsrunning" : 6true,
        "bindAddressport" : "bindAddress"5,
        "maxConnectionshostnameForSenders" : 0
      } ],
"hostnameForSenders",
        "coordinatormemberName" : true"memberName",
        "groupsbindAddress" : "groupsbindAddress",
        "serverBindAddresssenderCount" : "serverBindAddress",
 2
      }, {
        "cacheXmlFilePathconnectedSenders" : [ "connectedSenders", "cacheXmlFilePathconnectedSenders" ],
        "locatorPortrunning" : 3true,
        "heapUsageport" : 25,
        "initHeapSizehostnameForSenders" : 9"hostnameForSenders",
        "logFilePathmemberName" : "logFilePathmemberName",
        "offHeapMemorySizebindAddress" : "offHeapMemorySizebindAddress",
      "secured" : true,
      "statArchiveFilePathsenderCount" : "statArchiveFilePath",2
      "status" : "status"} ]
    }, {
      "cpuUsageconfiguration" : 5.637376656633329,{
        "serverstartPort" : true5,
      "httpServiceBindAddress" : "httpServiceBindAddressgatewayTransportFilters",
 : [ {
   "memberName" : "memberName",
      "locatorsinitProperties" : "locators",{
      "processId" : 4,
      "webSSLkey" : true,{ }
       "hostedRegions" : [ "hostedRegions"},
  "hostedRegions" ],
        "hostclassName" : "hostclassName",
      "maxHeapSize" : 2}, {
          "workingDirPathinitProperties" : "workingDirPath",{
      "id" : "id",
      "clientCountkey" : 5,{ }
      "httpServicePort"   : 7},
          "cacheServerInfoclassName" : [ {"className"
        "running" : true} ],
        "portmanualStart" : 1true,
        "maxThreadsmaximumTimeBetweenPings" : 6,
        "bindAddressendPort" : "bindAddress"0,
        "maxConnectionssocketBufferSize" : 0
      }, {1,
        "runninggroup" : true,"group"
        "port" : 1},
        "maxThreadsruntimeInfo" : [ 6,{
        "bindAddressconnectedSenders" : [ "connectedSenders", "bindAddressconnectedSenders" ],
        "maxConnectionsrunning" : 0
      } ],
true,
        "coordinatorport" : true5,
        "groupshostnameForSenders" : "groupshostnameForSenders",
        "serverBindAddressmemberName" : "serverBindAddressmemberName",
        "cacheXmlFilePathbindAddress" : "cacheXmlFilePathbindAddress",
        "locatorPortsenderCount" : 3,2
      "heapUsage}, {
        "connectedSenders" : 2 [ "connectedSenders", "connectedSenders" ],
        "initHeapSizerunning" : 9true,
        "logFilePathport" : "logFilePath"5,
        "offHeapMemorySizehostnameForSenders" : "offHeapMemorySizehostnameForSenders",
        "securedmemberName" : true"memberName",
        "statArchiveFilePathbindAddress" : "statArchiveFilePathbindAddress",
        "statussenderCount" : "status" 2
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Member,MemberInformation» ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found ANCHOR ="listMembersUsingGET"

...

Up get

GET /management/v1/gateways/

members

receivers

list membersgateway-receivers

Query parameters

group (optional)

Query Parameter -- group

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult«Member,MemberInformation» ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json

{
  "result" : [ {
    "configurationgroups" : [ {
      "idconfiguration" : "id",{
        "groupstartPort" : "group"5,
    },
    "runtimeInfogatewayTransportFilters" : [ {
          "cpuUsageinitProperties" : 5.637376656633329,
{
            "serverkey" : { true,}
      "httpServiceBindAddress"   : "httpServiceBindAddress"},
          "memberNameclassName" : "memberNameclassName",
      "locators" : "locators"}, {
          "processIdinitProperties" : 4,
{
            "webSSLkey" : true,{ }
       "hostedRegions" : [ "hostedRegions"},
 "hostedRegions" ],
         "hostclassName" : "hostclassName",
      "maxHeapSize"  :} 2],
        "workingDirPathmanualStart" : "workingDirPath"true,
        "idmaximumTimeBetweenPings" : "id"6,
        "clientCountendPort" : 50,
        "httpServicePortsocketBufferSize" : 71,
        "cacheServerInfogroup" : [ {"group"
        "running" : true},
        "portruntimeInfo" : 1,[ {
        "maxThreadsconnectedSenders" : 6,
        "bindAddress" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
        "maxConnectionsrunning" : 0
      }, {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, ],{
        "coordinatorconnectedSenders" : true,
      "groups" : "groups",
[ "connectedSenders", "connectedSenders" ],
        "serverBindAddressrunning" : "serverBindAddress"true,
        "cacheXmlFilePathport" : "cacheXmlFilePath"5,
        "locatorPorthostnameForSenders" : 3"hostnameForSenders",
        "heapUsagememberName" : 2"memberName",
        "initHeapSizebindAddress" : 9"bindAddress",
        "logFilePathsenderCount" : "logFilePath",2
      } ]
  "offHeapMemorySize" : "offHeapMemorySize"}, {
      "securedconfiguration" : true,{
        "statArchiveFilePathstartPort" : "statArchiveFilePath"5,
        "statusgatewayTransportFilters" : [ "status"{
    }, {
      "cpuUsageinitProperties" : 5.637376656633329,{
      "server" : true,
      "httpServiceBindAddresskey" : "httpServiceBindAddress",
{ }
       "memberName"  : "memberName"},
          "locatorsclassName" : "locatorsclassName",
      "processId" : 4}, {
          "webSSLinitProperties" : true,{
      "hostedRegions"   : [ "hostedRegions", "hostedRegionskey" ],
: { }
    "host" : "host",
    },
  "maxHeapSize" : 2,
      "workingDirPathclassName" : "workingDirPathclassName",
       "id" :} "id"],
        "clientCountmanualStart" : 5true,
        "httpServicePortmaximumTimeBetweenPings" : 76,
        "cacheServerInfoendPort" : [ {0,
        "runningsocketBufferSize" : true1,
        "portgroup" : 1,
"group"
      },
      "maxThreadsruntimeInfo" : 6,[ {
        "bindAddressconnectedSenders" : [ "connectedSenders", "bindAddressconnectedSenders" ],
        "maxConnectionsrunning" : 0
      }, {true,
        "runningport" : true5,
        "porthostnameForSenders" : 1"hostnameForSenders",
        "maxThreadsmemberName" : 6"memberName",
        "bindAddress" : "bindAddress",
        "maxConnectionssenderCount" : 02
      }, {
        "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "coordinatorrunning" : true,
        "groupsport" : "groups"5,
        "serverBindAddresshostnameForSenders" : "serverBindAddresshostnameForSenders",
        "cacheXmlFilePathmemberName" : "cacheXmlFilePathmemberName",
        "locatorPortbindAddress" : 3"bindAddress",
        "heapUsagesenderCount" : 2,
      } ]
   "initHeapSize" :} 9],
      "logFilePathid" : "logFilePathid",
  }, {
    "offHeapMemorySizegroups" : "offHeapMemorySize", [ {
      "securedconfiguration" : true,{
        "statArchiveFilePathstartPort" : "statArchiveFilePath"5,
        "statusgatewayTransportFilters" : "status"[ {
    } ]
  }, {
    "configurationinitProperties" : {
      "id"   : "id",
     "key" : { }
    "group" : "group"
    },
    "runtimeInfo      "className" : [ {"className"
      "cpuUsage" : 5.637376656633329}, {
          "serverinitProperties" : true,{
            "httpServiceBindAddresskey" : "httpServiceBindAddress", { }
      "memberName"   : "memberName"},
          "locatorsclassName" : "locatorsclassName",
       "processId" :} 4],
        "webSSLmanualStart" : true,
        "hostedRegionsmaximumTimeBetweenPings" : [ "hostedRegions"6,
 "hostedRegions" ],
      "hostendPort" : "host"0,
        "maxHeapSizesocketBufferSize" : 21,
        "workingDirPathgroup" : "workingDirPath"group"
      },
      "idruntimeInfo" : "id",
[ {
        "clientCountconnectedSenders" : 5,
      "httpServicePort" : 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}, {
      "statArchiveFilePath" : "statArchiveFilePath",
      "statusinitProperties" : "status"{
    },  {
      "cpuUsagekey" : 5.637376656633329,
{ }
        "server" : true},
          "httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
       "memberName" :} "memberName"],
        "locatorsmanualStart" : "locators"true,
        "processIdmaximumTimeBetweenPings" : 46,
        "webSSLendPort" : true0,
        "hostedRegionssocketBufferSize" : [ "hostedRegions", "hostedRegions" ],
1,
        "hostgroup" : "hostgroup",
      "maxHeapSize" : 2},
      "workingDirPathruntimeInfo" : "workingDirPath",
 [ {
        "idconnectedSenders" : [ "idconnectedSenders",
      "clientCountconnectedSenders" : 5],
      "httpServicePort" : 7,
      "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",
      } ],
      "coordinatorbindAddress" : true"bindAddress",
        "groupssenderCount" : "groups",2
      "serverBindAddress" : "serverBindAddress",} ]
      "cacheXmlFilePath" : "cacheXmlFilePath"} ],
      "locatorPortid" : 3,
      "heapUsageid" : 2,
      "initHeapSize" : 9} ],
      "logFilePathlinks" : "logFilePath",
      "offHeapMemorySize{ "self" : "offHeapMemorySizeuri",
      "secured" : true },
      "statArchiveFilePathstatusMessage" : "statArchiveFilePathstatusMessage",
      "statusstatusCode" : "statusOK"
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Member,MemberInformation»

Responses
200
 OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo 401
 Unauthorized 403
 Forbidden 404
 Not Found

...

Member Management

ANCHOR ="configurePdxUsingPOST" Up post

GET /management/v1/

configurations

members/

pdx

configure pdx

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

{id}

get member

Path parameters

id body Pdx (required)

Body Path Parameter -- pdxType id

Return type

ClusterManagementResult ClusterManagementGetResult_Member_MemberInformation

Example data

Content-Type: application/json

ANCHOR ="checkRebalanceStatusUsingGET"

Up

get /v1/operations/rebalances/{id}

check rebalance

Path parameters

id (required)

Path Parameter -- id

Return type

ClusterManagementOperationStatusResult«RebalanceResult»

Example data

Content-Type: application/json

{
  "linksresult" : {
 },
   "statusMessagegroups" : [ {
      "statusMessage",configuration" : {
  "statusCode      "id" : "OKid"
}

Responses

200

OK ClusterManagementOperationStatusResult«RebalanceResult»

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

Ping

ANCHOR ="pingUsingGET"

Up

get /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

{
  "result" : {
    "rebalanceRegionResults" : [ {
,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "cpuUsage" : 5.637376656633329,
        "server" : true,
        "bucketCreateTimeInMillisecondshttpServiceBindAddress" : 6"httpServiceBindAddress",
        "primaryTransferTimeInMillisecondsmemberName" : 7"memberName",
        "bucketCreatesCompletedlocators" : 1"locators",
        "bucketTransfersCompletedprocessId" : 24,
        "bucketCreateByteswebSSL" : 0true,
        "regionNamehostedRegions" : [ "hostedRegions", "regionNamehostedRegions" ],
        "bucketTransferTimeInMillisecondshost" : 5"host",
        "timeInMillisecondsmaxHeapSize" : 32,
        "primaryTransfersCompletedworkingDirPath" : 9"workingDirPath",
        "bucketTransferBytesid" : 5"id",
    }, {
      "bucketCreateTimeInMillisecondsclientCount" : 65,
        "primaryTransferTimeInMillisecondshttpServicePort" : 7,
        "bucketCreatesCompletedcacheServerInfo" : 1,
[ {
          "bucketTransfersCompletedrunning" : 2true,
          "bucketCreateBytesport" : 01,
          "regionNamemaxThreads" : "regionName"6,
          "bucketTransferTimeInMillisecondsbindAddress" : 5"bindAddress",
          "timeInMillisecondsmaxConnections" : 3,
 0
        }, {
          "primaryTransfersCompletedrunning" : 9true,
          "bucketTransferBytesport" : 51,
     } ],
    "statusMessagemaxThreads" : "statusMessage"6,
  },
        "operationEndedbindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXbindAddress",
          "operationStartmaxConnections" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "links0
        } ],
        "coordinator" : { }true,
        "operatorgroups" : "operatorgroups",
        "statusMessageserverBindAddress" : "statusMessageserverBindAddress",
  "statusCode      "cacheXmlFilePath" : "OKcacheXmlFilePath"
}

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found ANCHOR ="listRebalancesUsingGET"

Up

get /v1/operations/rebalances

list rebalances

Return type

ClusterManagementListOperationsResult«RebalanceResult»

Example data

Content-Type: application/json

ANCHOR ="getIndexUsingGET"

Up

get /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" : [ {
,
        "locatorPort" : 3,
        "operationEndedheapUsage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"2,
        "initHeapSize" : 9,
        "operationStartlogFilePath" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXlogFilePath",
        "operationIdoffHeapMemorySize" : "operationIdoffHeapMemorySize",
        "operatorsecured" : "operator"true,
        "statusMessagestatArchiveFilePath" : "statusMessagestatArchiveFilePath",
        "statusCodestatus" : "OKstatus"
      }, {
        "operationEndedcpuUsage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
5.637376656633329,
        "operationStartserver" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"true,
        "operationIdhttpServiceBindAddress" : "operationIdhttpServiceBindAddress",
        "operatormemberName" : "operatormemberName",
        "statusMessagelocators" : "statusMessagelocators",
        "statusCodeprocessId" : 4,
 "OK"
  }       "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
  "links      "host" : { },
 "host",
        "maxHeapSize" : 2,
        "statusMessageworkingDirPath" : "statusMessageworkingDirPath",
        "statusCodeid" : "OKid"
}

Responses

200

OK ClusterManagementListOperationsResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found

ANCHOR ="startRebalanceUsingPOST"

Up

post /v1/operations/rebalances

start rebalance

Consumes

This API call consumes the following media types via the 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

ANCHOR ="createRegionUsingPOST"

Up

post /v1/regions

create region

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body Region (required)

Body Parameter -- regionConfig

Return type

Example data

Content-Type: application/json

{
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

ANCHOR ="deleteRegionUsingDELETE"

Up

delete /v1/regions/{id}

delete region

Path parameters

id (required)

Path Parameter -- id

Query parameters

group (optional)

Query Parameter -- group

Return type

Example data

Content-Type: application/json

{
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

ClusterManagementGetResult«Region,RuntimeRegionInfo»

204

No Content

401

Unauthorized

403

Forbidden

ANCHOR ="getRegionUsingGET"

Up

get /v1/regions/{id}

get region

Path parameters

id (required)

Path Parameter -- id

Return type

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"
    },
  } ]
    }, {
      "runtimeInfoconfiguration" : [ { {
        "id" : "id",
        "memberNamegroup" : "memberNamegroup"
      }, {
      "memberNameruntimeInfo" : [ "memberName"{
    } ]
  },
  "links    "cpuUsage" : 5.637376656633329,
        "server" : { }true,
  "statusMessage      "httpServiceBindAddress" : "statusMessagehttpServiceBindAddress",
        "statusCodememberName" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

{
  "result" : {
memberName",
        "locators" : "locators",
        "configurationprocessId" : {4,
        "expirationswebSSL" : [ {true,
        "actionhostedRegions" : [ "hostedRegions", "DESTROYhostedRegions" ],
        "typehost" : "ENTRY_TIME_TO_LIVEhost",
        "timeInSecondsmaxHeapSize" : 0
      }, {2,
        "actionworkingDirPath" : "DESTROYworkingDirPath",
        "typeid" : "ENTRY_TIME_TO_LIVEid",
        "timeInSecondsclientCount" : 05,
        "httpServicePort" }: ]7,
        "redundantCopiescacheServerInfo" : 6,[ {
       "keyConstraint   "running" : "keyConstraint"true,
          "nameport" : "name"1,
          "valueConstraintmaxThreads" : "valueConstraint"6,
          "typebindAddress" : "PARTITIONbindAddress",
          "diskStoreNamemaxConnections" : "diskStoreName",0
      "group" : "group"
  }, {
      },
    "runtimeInforunning" : true,
   [ {
      "entryCountport" : 1,
          "memberNamemaxThreads" : "memberName"6,
    }, {
      "entryCountbindAddress" : 1"bindAddress",
          "memberNamemaxConnections" : "memberName"0
        } ],
     },
   "linkscoordinator" : { }true,
  "statusMessage      "groups" : "statusMessagegroups",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found ANCHOR ="listAllIndexUsingGET"

Up

get /v1/indexes

list indexes

Query parameters

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json

{
  "result" : [ {
     "serverBindAddress" : "serverBindAddress",
        "configurationcacheXmlFilePath" : {
"cacheXmlFilePath",
        "regionPathlocatorPort" : "regionPath"3,
        "expressionheapUsage" : "expression"2,
        "keyIndexinitHeapSize" : true9,
        "namelogFilePath" : "namelogFilePath",
        "groupoffHeapMemorySize" : "groupoffHeapMemorySize",
    },
    "runtimeInfosecured" : [ {
true,
        "memberNamestatArchiveFilePath" : "memberNamestatArchiveFilePath",
    }, {
      "memberNamestatus" : "memberNamestatus"
    } ]
  }, {
        "configurationcpuUsage" : {5.637376656633329,
        "regionPathserver" : "regionPath"true,
        "expressionhttpServiceBindAddress" : "expressionhttpServiceBindAddress",
        "keyIndexmemberName" : true"memberName",
        "namelocators" : "namelocators",
        "groupprocessId" : "group"4,
    },
    "runtimeInfowebSSL" : [ {
true,
        "memberNamehostedRegions" : [ "memberNamehostedRegions"
, "hostedRegions" ],
  }, {
      "memberNamehost" : "memberNamehost",
    }   ]
 "maxHeapSize" }: ]2,
   "links" : { },
  "statusMessageworkingDirPath" : "statusMessageworkingDirPath",
  "statusCode      "id" : "OKid"
}

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

,
        "clientCount" : 5,
        "httpServicePort" : 7,

ANCHOR ="listIndexUsingGET"

Up

get /v1/regions/{regionName}/indexes

list region indexes

Path parameters

regionName (required)

Path Parameter -- regionName

Query parameters

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json

ANCHOR ="listRegionUsingGET"

Up

get /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" : {
        "regionPathcacheServerInfo" : "regionPath",
 [ {
          "expressionrunning" : "expression"true,
          "keyIndexport" : true1,
      "name" :   "namemaxThreads" : 6,
          "groupbindAddress" : "groupbindAddress",
     },
     "runtimeInfomaxConnections" : [0
 {
      "memberName" : "memberName"}, {
    }, {
      "memberNamerunning" : "memberName"
  true,
  } ]
  }, {
    "configurationport" : {1,
          "regionPathmaxThreads" : "regionPath"6,
          "expressionbindAddress" : "expressionbindAddress",
          "keyIndexmaxConnections" : true,0
      "name"  :} "name"],
        "groupcoordinator" : "group"true,
    },
    "runtimeInfogroups" : [ {
"groups",
        "memberNameserverBindAddress" : "memberNameserverBindAddress",
    }, {
      "memberNamecacheXmlFilePath" : "memberNamecacheXmlFilePath",
    } ]
  } ],
  "linkslocatorPort" : { }3,
  "statusMessage"   : "statusMessage",
  "statusCodeheapUsage" : "OK"
}

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

{
  "result" : [ {
 2,
        "configurationinitHeapSize" : {9,
        "expirationslogFilePath" : [ {"logFilePath",
        "actionoffHeapMemorySize" : "DESTROYoffHeapMemorySize",
        "typesecured" : "ENTRY_TIME_TO_LIVE"true,
        "timeInSeconds" : 0
      }, {
        "action"statArchiveFilePath" : "DESTROYstatArchiveFilePath",
        "typestatus" : "ENTRY_TIME_TO_LIVE",status"
        "timeInSeconds" : 0} ]
      } ],
      "redundantCopies" : 6,
      "keyConstraint""id" : "keyConstraintid",
      "name" : "name"},
      "valueConstraintlinks" : "valueConstraint",
      "type{ "self" : "PARTITIONuri" },
      "diskStoreNamestatusMessage" : "diskStoreNamestatusMessage",
      "groupstatusCode" : "group"
    },
    "runtimeInfoOK"
}

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" : [ {
      "entryCountgroups" : 1,[ {
      "memberNameconfiguration" : "memberName"
    }, {
{
        "entryCountid" : 1"id",
        "memberNamegroup" : "memberNamegroup"
    } ]
  }, {
    "configuration" : {
      "expirationsruntimeInfo" : [ {
        "actioncpuUsage" : "DESTROY"5.637376656633329,
        "typeserver" : "ENTRY_TIME_TO_LIVE"true,
        "timeInSecondshttpServiceBindAddress" : 0"httpServiceBindAddress",
       }, { "memberName" : "memberName",
        "actionlocators" : "DESTROYlocators",
        "typeprocessId" : "ENTRY_TIME_TO_LIVE"4,
        "timeInSecondswebSSL" : 0true,
        "hostedRegions" : [  }"hostedRegions", "hostedRegions" ],
        "redundantCopieshost" : 6"host",
        "keyConstraintmaxHeapSize" : "keyConstraint"2,
        "nameworkingDirPath" : "nameworkingDirPath",
        "valueConstraintid" : "valueConstraintid",
        "typeclientCount" : "PARTITION"5,
        "diskStoreNamehttpServicePort" : "diskStoreName"7,
        "groupcacheServerInfo" : [ {
          "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 1,
      "memberName" : "memberName"
    }, {
      "entryCount" : 1,
      "memberName" : "memberName"
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

Models

...

CacheServerInfo - CacheServerInfo
ClassName - ClassName
ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo»
ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation»
ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo»
ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult»
ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»
ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo»
ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation»
ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo»
ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult»
ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult»
ClusterManagementResult - ClusterManagementResult
ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo»
ConfigurationResult«Member,MemberInformation» - ConfigurationResult«Member,MemberInformation»
ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo»
Expiration - Expiration
GatewayReceiver - GatewayReceiver
GatewayReceiverInfo - GatewayReceiverInfo
Index - Index
Links - Links
Member - Member
MemberInformation - MemberInformation
Pdx - Pdx
RebalanceOperation - RebalanceOperation
RebalanceRegionResult - RebalanceRegionResult
RebalanceResult - RebalanceResult
Region - Region
RuntimeInfo - RuntimeInfo
RuntimeRegionInfo - RuntimeRegionInfo

`CacheServerInfo` - CacheServerInfo Up

bindAddress (optional)

String

maxConnections (optional)

Integer format: int32

maxThreads (optional)

Integer format: int32

port (optional)

Integer format: int32

running (optional)

Boolean

`ClassName` - ClassName Up

className (optional)

String

initProperties (optional)

map[String, Object]

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

Responses

200

OK ClusterManagementListResult_Member_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 request header:

application/json

Request body

body Pdx (required)

Body Parameter -- pdxType

Return type

Example data

Content-Type: application/json

{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

ClusterManagementGetResult_Pdx_PdxInfo

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

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 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 request header:

application/json

Request body

body Index (required)

Body Parameter -- indexConfig

Return type

Example data

Content-Type: application/json

{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

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 request header:

application/json

Request body

body Index (required)

Body Parameter -- indexConfig

Return type

Example data

Content-Type: application/json

{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

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 request header:

application/json

Request body

body Region (required)

Body Parameter -- regionConfig

Return type

Example data

Content-Type: application/json

{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

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

Example data

Content-Type: application/json

{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

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

Example data

Content-Type: application/json

{
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

ClusterManagementGetResult_Index_IndexInfo

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

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)

EntityInfo_Deployment_DeploymentInfo

result (optional)

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)

EntityInfo_GatewayReceiver_GatewayReceiverInfo

result (optional)

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)

EntityInfo_Index_IndexInfo

result (optional)

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)

EntityInfo_Member_MemberInformation

result (optional)

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)

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)

EntityInfo_Region_RuntimeRegionInfo

result (optional)

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

`ClusterManagementListOperationsResult_RebalanceResult`

links (optional)

array[ClusterManagementOperationResult_RebalanceResult]

result (optional)

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

`ClusterManagementListResult_Deployment_DeploymentInfo`

links (optional)

array[EntityInfo_Deployment_DeploymentInfo]

result (optional)

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

`ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo`

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

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

`ClusterManagementListResult_Index_IndexInfo`

links (optional)

ConfigurationResult«Index,RuntimeInfo» array[EntityInfo_Index_IndexInfo]

result (optional)

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

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

`ClusterManagementListResult_Member_MemberInformation`

links (optional)

ConfigurationResult«Member,MemberInformation» array[EntityInfo_Member_MemberInformation]

result (optional)

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

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

`ClusterManagementListResult_Region_RuntimeRegionInfo`

links (optional)

ConfigurationResult«Region,RuntimeRegionInfo» array[EntityInfo_Region_RuntimeRegionInfo]

result (optional)

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`

links (optional)

operationEnded (optional)

String

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

operationId (optional)

String

operationStart (optional)

String

`ClusterManagementListOperationsResult«RebalanceResult»` - ClusterManagementListOperationsResult«RebalanceResult» Up

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

operator links (optional)

array[ClusterManagementOperationResult«RebalanceResult»]

result (optional)

String

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

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

`ClusterManagementOperationStatusResult_RebalanceResult`

links (optional)

array[ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»]

result (optional)

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«Index,RuntimeInfo»` - ClusterManagementListResult«Index,RuntimeInfo» Up

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

operator links (optional)

Links String

result (optional)

array[ConfigurationResult«Index,RuntimeInfo»] RebalanceResult

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

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

`ClusterManagementResult`

links (optional)

array[ConfigurationResult«Member,MemberInformation»]

result (optional)

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

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

`Deployment`

deployedBy links (optional)

Links String

result deployedTime (optional)

array[ConfigurationResult«Region,RuntimeRegionInfo»]

String

group statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

jarFileName (optional)

String

`DeploymentInfo`

jarLocation statusMessage (optional)

String

`ClusterManagementOperationResult«RebalanceResult»` - ClusterManagementOperationResult«RebalanceResult» Up

links lastModified (optional)

Links String

operationEnded memberName (optional)

String

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

`DocLinks`

latest operationId (optional)

String

operationStart supported (optional)

array[String

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

]

`EntityGroupInfo_Deployment_DeploymentInfo`

configuration operator (optional)

String Deployment

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»` - ClusterManagementOperationStatusResult«RebalanceResult» Up

links (optional)

operationEnded (optional)

String

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

operationStart (optional)

String

example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

operator (optional)

String

result (optional)

RebalanceResult

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

`ClusterManagementResult` - ClusterManagementResult Up

links (optional)

array[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

array[DeploymentInfo]

`EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo`

configuration (optional)

GatewayReceiver

runtimeInfo (optional)

`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)

array[EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo]

`EntityInfo_GatewayReceiver_GatewayReceiverInfo`

groups (optional)

id (optional)

String

links (optional)

array[EntityGroupInfo_Index_IndexInfo]

`EntityInfo_Index_IndexInfo`

groups (optional)

id (optional)

String

links (optional)

array[EntityGroupInfo_Member_MemberInformation]

`EntityInfo_Member_MemberInformation`

groups (optional)

id (optional)

String

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

configuration (optional)

GatewayReceiver

links (optional)

EntityGroupInfo_Pdx_PdxInfo]

`EntityInfo_Pdx_PdxInfo`

groups runtimeInfo (optional)

array[GatewayReceiverInfo]

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

id configuration (optional)

Index String

links (optional)

EntityGroupInfo_Region_RuntimeRegionInfo]

`EntityInfo_Region_RuntimeRegionInfo`

groups runtimeInfo (optional)

array[RuntimeInfo]

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

id configuration (optional)

Member String

links (optional)

`Eviction`

action (optional)

String

Enum:

LOCAL_DESTROY

OVERFLOW_TO_DISK

entryCount runtimeInfo (optional)

array[MemberInformation]

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

Integer format: int32

memorySizeMb (optional)

Integer format: int32

objectSizer configuration (optional)

Region ClassName

links type (optional)