Versions Compared

Old Version 61

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

...

GET /management/v1/deployments/{id}

get deployed

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_Deployment_DeploymentInfo

Example data

Content-Type: application/json
{
  "result" : {
    "configurationByGroupgroups" : [ {
      "configuration" : {
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "jarFileName" : "jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "jarFileName" : "jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Deployment_DeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/deployments

list deployed

Query parameters

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

Return type

ClusterManagementListResult_Deployment_DeploymentInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "jarFileName" : "jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "jarFileName" : "jarFileName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    } ],
    "id" : "links"id"
  }, {
    "groups" : [ {
      "selfconfiguration" : {
        "urideployedTime" : }"deployedTime",
        "statusMessagedeployedBy" : "statusMessagedeployedBy",
        "statusCodejarFileName" : "OKjarFileName"
}

Responses

200

OK ClusterManagementListResult_Deployment_DeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

Versions

GET /management

get documentation-links

Return type

DocLinks

Example data

Content-Type: application/json

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

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "latest,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "latestjarLocation",
        "supportedmemberName" : [ "supportedmemberName",
 "supported" ]
}

Responses

200

OK DocLinks

401

Unauthorized

403

Forbidden

404

Not Found

Gateway Management

POST /management/v1/gateways/receivers

create gateway-receiver

Consumes

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

Request body

body GatewayReceiver (required)
Request Body

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error. 
{
  "result" : {
    "configurationByGroup" : [ {
       "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "jarFileName" : "jarFileName",
        "configurationgroup" : {"group"
        "startPort" : 5},
        "gatewayTransportFiltersruntimeInfo" : [ {
          "initPropertiesjarLocation" : {"jarLocation",
            "keymemberName" : { }
          }"memberName",
          "classNamelastModified" : "classNamelastModified"
        }, {
          "initPropertiesjarLocation" : {
    "jarLocation",
        "keymemberName" : { }
          }"memberName",
          "classNamelastModified" : "classNamelastModified"
        } ],
        "manualStart" : true} ],
        "maximumTimeBetweenPingsid" : 6,"id"
        "endPort" : 0,
        "socketBufferSize} ],
  "links" : 1,
        "group{ "self" : "groupuri"
      },
      "runtimeInfostatusMessage" : [ {"statusMessage",
        "connectedSenders"statusCode" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSendersOK"
}

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" : "hostnameForSenderslatest",
        "memberName"supported" : [ "supported", "supported" ]
}

Responses

200

OK DocLinks

401

Unauthorized

403

Forbidden

404

Not Found

...

Gateway Management

POST /management/v1/gateways/receivers

create gateway-receiver

Consumes

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

Request body

body GatewayReceiver (required)
Request Body

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.

...

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

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : ["memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      }, {
        "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : "hostnameForSenders",
        "memberName" : "memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      } ]
    }, {
      "configuration" : {
        "startPort" : 5,
        "gatewayTransportFilters" : [ {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        }, {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        } ],
        "manualStart" : true,
        "maximumTimeBetweenPings" : 6,
        "endPort" : 0,
        "socketBufferSize" : 1,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : "hostnameForSenders",
        "memberName" : "memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      }, {
        "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : "hostnameForSenders",
        "memberName" : "memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      } ]
    }, ],{
      "idconfiguration" : "id"{
  },
      "linksstartPort" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found 

GET /management/v1/gateways/receivers

list gateway-receivers

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "result" : [ {
5,
        "gatewayTransportFilters" : [ {
          "configurationinitProperties" : {
      "startPort" : 5,
      "gatewayTransportFilterskey" : [{ {}
        "initProperties" : {},
          "keyclassName" : { }"className"
        }, {
          "classNameinitProperties" : "className"{
      }, {
         "initPropertieskey" : { }
          "key" : { },
        },
        "className" : "className"
        } ],
        "manualStart" : true,
        "maximumTimeBetweenPings" : 6,
        "endPort" : 0,
        "socketBufferSize" : 1,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : "hostnameForSenders",
        "memberName" : "memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      }, {
        "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : "hostnameForSenders",
        "memberName" : "memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      } ]
    } ], {
    "configurationid" : {
      "startPortid"
 : 5},
      "gatewayTransportFilterslinks" : [ {
        "initProperties"self" : {
          "keyuri" : { },
  "statusMessage"      }: "statusMessage",
        "className"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/gateways/receivers

list gateway-receivers

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "result" : [ {
className"
      }, {
        "initPropertiesgroups" : [ {
          "keyconfiguration" : {
 }
       "startPort" : }5,
        "classNamegatewayTransportFilters" : "className"[ {
      } ],
      "manualStartinitProperties" : true,{
      "maximumTimeBetweenPings" : 6,
      "endPortkey" : { 0,}
      "socketBufferSize"   : 1},
       "group   "className" : "groupclassName"
        }, {
          "runtimeInfoinitProperties" : [ {
            "connectedSenderskey" : [ "connectedSenders", "connectedSenders" ],
 { }
          },
          "className" : "className"
        } ],
        "runningmanualStart" : true,
        "portmaximumTimeBetweenPings" : 56,
        "hostnameForSendersendPort" : "hostnameForSenders"0,
        "memberNamesocketBufferSize" : "memberName"1,
        "bindAddressgroup" : "bindAddress"group"
      },
      "senderCountruntimeInfo" : [ 2{
    }, {
      "connectedSenders" : [ "connectedSenders", "connectedSenders" ],
        "running" : true,
        "port" : 5,
        "hostnameForSenders" : "hostnameForSenders",
        "memberName" : "memberName",
        "bindAddress" : "bindAddress",
        "senderCount" : 2
      }, ]{
  } ],
  "links" : { "selfconnectedSenders" : "uri[ "connectedSenders", "connectedSenders" }],
  "statusMessage" : "statusMessage",
  "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
{
  "result" : {
running" : true,
        "configurationByGroupport" : 5,
 [ {
      "configurationhostnameForSenders" : {"hostnameForSenders",
        "idmemberName" : "idmemberName",
        "groupbindAddress" : "groupbindAddress",
      },
      "runtimeInfosenderCount" : [ {2
      } ]
  "cpuUsage" : 5.637376656633329}, {
        "serverconfiguration" : true,{
        "httpServiceBindAddressstartPort" : "httpServiceBindAddress"5,
        "memberNamegatewayTransportFilters" : "memberName", [ {
          "locatorsinitProperties" : "locators",{
            "processIdkey" : 4,{ }
        "webSSL" : true},
          "hostedRegionsclassName" : [ "hostedRegions", "hostedRegions" ],className"
        }, {
          "hostinitProperties" : "host",{
            "maxHeapSizekey" : 2,{ }
        "workingDirPath" : "workingDirPath"},
          "idclassName" : "idclassName",
        "clientCount" : 5} ],
        "httpServicePortmanualStart" : 7true,
        "cacheServerInfomaximumTimeBetweenPings" : [ {6,
          "runningendPort" : true0,
          "portsocketBufferSize" : 1,
          "maxThreadsgroup" : 6,"group"
      },
      "bindAddressruntimeInfo" : "bindAddress", [ {
        "connectedSenders" : [ "maxConnectionsconnectedSenders", : 0"connectedSenders" ],
        "running" : }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"],
        "offHeapMemorySizeid" : "offHeapMemorySizeid",
  }, {
     "securedgroups" : true,[ {
        "statArchiveFilePathconfiguration" : "statArchiveFilePath",{
        "statusstartPort" : "status"
5,
        "gatewayTransportFilters" : },[ {
          "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"
 [ {
    },
      "runningruntimeInfo" : true,[ {
        "connectedSenders" : [ "portconnectedSenders", :"connectedSenders" 1],
          "maxThreadsrunning" : 6true,
          "bindAddressport" : "bindAddress"5,
        "hostnameForSenders" : "maxConnectionshostnameForSenders",
 : 0
      "memberName" : }"memberName", {
          "runningbindAddress" : true"bindAddress",
          "portsenderCount" : 1,2
          "maxThreads" : 6,
  }, {
        "bindAddressconnectedSenders" : [ "bindAddressconnectedSenders",
 "connectedSenders" ],
        "maxConnectionsrunning" : 0true,
        "port" }: ]5,
        "coordinatorhostnameForSenders" : true"hostnameForSenders",
        "groupsmemberName" : "groupsmemberName",
        "serverBindAddressbindAddress" : "serverBindAddressbindAddress",
        "cacheXmlFilePathsenderCount" : "cacheXmlFilePath",2
      } ]
  "locatorPort" : 3}, {
        "heapUsageconfiguration" : 2,{
        "initHeapSizestartPort" : 95,
        "logFilePathgatewayTransportFilters" : "logFilePath",[ {
          "offHeapMemorySizeinitProperties" : "offHeapMemorySize",{
            "securedkey" : true,{ }
        "statArchiveFilePath" : "statArchiveFilePath"},
          "statusclassName" : "statusclassName"
        }, ]{
    }, {
      "configurationinitProperties" : {
            "idkey" : "id",{ }
        "group" : "group"},
      },
      "runtimeInfoclassName" : [ {"className"
        "cpuUsage" : 5.637376656633329} ],
        "servermanualStart" : true,
        "httpServiceBindAddressmaximumTimeBetweenPings" : "httpServiceBindAddress"6,
        "memberNameendPort" : "memberName"0,
        "locatorssocketBufferSize" : "locators"1,
        "processIdgroup" : 4,
"group"
      },
      "webSSLruntimeInfo" : [ true,{
        "hostedRegionsconnectedSenders" : [ "hostedRegionsconnectedSenders", "hostedRegionsconnectedSenders" ],
        "hostrunning" : "host"true,
        "maxHeapSizeport" : 25,
        "workingDirPathhostnameForSenders" : "workingDirPathhostnameForSenders",
        "idmemberName" : "idmemberName",
        "clientCountbindAddress" : 5"bindAddress",
        "httpServicePortsenderCount" : 7,2
        "cacheServerInfo" : [}, {
        "connectedSenders" : [ "runningconnectedSenders", :"connectedSenders" true],
          "portrunning" : 1true,
          "maxThreadsport" : 65,
          "bindAddresshostnameForSenders" : "bindAddresshostnameForSenders",
          "maxConnectionsmemberName" : 0
        }, {"memberName",
          "runningbindAddress" : true"bindAddress",
          "portsenderCount" : 1,2
      } ]
   "maxThreads" :} 6],
          "bindAddress"id" : "bindAddressid",
  } ],
  "links" : {   "maxConnectionsself" : 0
        } ]"uri" },
        "coordinatorstatusMessage" : true"statusMessage",
  "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
{
  "result" : {
      "groups" : "groups",
 : [ {
      "serverBindAddressconfiguration" : "serverBindAddress",{
        "cacheXmlFilePathid" : "cacheXmlFilePathid",
        "locatorPortgroup" : 3,
"group"
      },
      "heapUsageruntimeInfo" : 2,[ {
        "initHeapSizecpuUsage" : 95.637376656633329,
        "logFilePathserver" : "logFilePath"true,
        "offHeapMemorySizehttpServiceBindAddress" : "offHeapMemorySizehttpServiceBindAddress",
        "securedmemberName" : true"memberName",
        "statArchiveFilePath" : "statArchiveFilePath",
        "statuslocators" : "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"
      }, ]{
    } ],
    "idcpuUsage" : "id"5.637376656633329,
  },
   "links" : { "selfserver" : "uri" }true,
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found 

GET /management/v1/members

list members

Query parameters

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

Return type

ClusterManagementListResult_Member_MemberInformation

Example data

Content-Type: application/json
{
  "result" : [ {
    "configuration" : {
httpServiceBindAddress" : "httpServiceBindAddress",
        "idmemberName" : "idmemberName",
        "grouplocators" : "grouplocators",
    },
    "runtimeInfoprocessId" : [ {
4,
        "cpuUsagewebSSL" : 5.637376656633329true,
        "serverhostedRegions" : 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"
    } ]
  }, {
    "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} ],
    "id" : "serverid"
 : true},
  "links" : {  "httpServiceBindAddressself" : "httpServiceBindAddressuri" },
      "memberNamestatusMessage" : "memberNamestatusMessage",
  "statusCode"  :  "locators" : "locators",
  OK"
}

Responses

200

OK ClusterManagementGetResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/members

list members

Query parameters

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

Return type

ClusterManagementListResult_Member_MemberInformation

Example data

Content-Type: application/json
{
  "result" : [ {
    "processIdgroups" : 4,[ {
      "webSSLconfiguration" : true,{
        "hostedRegionsid" : [ "hostedRegionsid",
 "hostedRegions" ],
      "hostgroup" : "hostgroup",
      "maxHeapSize" : 2},
      "workingDirPathruntimeInfo" : "workingDirPath",
 [ {
        "idcpuUsage" : "id"5.637376656633329,
        "clientCountserver" : 5true,
        "httpServicePorthttpServiceBindAddress" : 7"httpServiceBindAddress",
        "cacheServerInfomemberName" : [ {"memberName",
        "runninglocators" : true"locators",
        "portprocessId" : 14,
        "maxThreadswebSSL" : 6true,
        "bindAddresshostedRegions" : [ "hostedRegions", "bindAddresshostedRegions" ],
        "maxConnectionshost" : 0"host",
       }, { "maxHeapSize" : 2,
        "runningworkingDirPath" : true"workingDirPath",
        "portid" : 1"id",
        "maxThreadsclientCount" : 65,
        "bindAddresshttpServicePort" : "bindAddress"7,
        "maxConnectionscacheServerInfo" : 0[ {
      } ],
      "coordinatorrunning" : true,
      "groups" :   "groupsport" : 1,
          "serverBindAddressmaxThreads" : "serverBindAddress"6,
          "cacheXmlFilePathbindAddress" : "cacheXmlFilePathbindAddress",
          "locatorPortmaxConnections" : 3,
 0
        }, {
          "heapUsagerunning" : 2true,
          "initHeapSizeport" : 91,
          "logFilePathmaxThreads" : "logFilePath"6,
          "offHeapMemorySizebindAddress" : "offHeapMemorySizebindAddress",
          "securedmaxConnections" : true 0
        } ],
        "statArchiveFilePathcoordinator" : "statArchiveFilePath"true,
        "statusgroups" : "statusgroups",
    } ]
  } ],
  "linksserverBindAddress" : { "selfserverBindAddress",
   :  "uri" },
  "statusMessagecacheXmlFilePath" : "statusMessagecacheXmlFilePath",
  "statusCode      "locatorPort" : "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

GET /management/v1/configurations/pdx

get pdx

Return type

ClusterManagementGetResult_Pdx_PdxInfo

Example data

Content-Type: application/json
{
  "links" : { "self3,
        "heapUsage" : 2,
        "initHeapSize" : 9,
        "logFilePath" : "urilogFilePath" },
  "statusMessage      "offHeapMemorySize" : "statusMessageoffHeapMemorySize",
  "statusCode      "secured" : "OK"
}

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error. 
{
  "result" : {
true,
        "configurationByGroupstatArchiveFilePath" : "statArchiveFilePath",
 [ {
      "configurationstatus" : {"status"
        "autoSerializer" : }, {
          "patternscpuUsage" : [ "patterns", "patterns" ]5.637376656633329,
          "portableserver" : true,
        "httpServiceBindAddress" : }"httpServiceBindAddress",
        "readSerializedmemberName" : true"memberName",
        "diskStoreNamelocators" : "diskStoreNamelocators",
        "ignoreUnreadFieldsprocessId" : true4,
        "pdxSerializerwebSSL" : {true,
        "hostedRegions" : [ "initPropertieshostedRegions", : {
"hostedRegions" ],
        "host" : "host",
        "keymaxHeapSize" : { }2,
        "workingDirPath" : }"workingDirPath",
          "classNameid" : "classNameid",
        }"clientCount" : 5,
      }  "httpServicePort" : 7,
        "runtimeInfocacheServerInfo" : [ {
          "readSerializedrunning" : true,
          "memberNameport" : "memberName"1,
          "diskStoreNamemaxThreads" : "diskStoreName"6,
          "ignoreUnreadFieldsbindAddress" : true"bindAddress",
          "pdxSerializermaxConnections" : "pdxSerializer"0
        }, {
          "readSerializedrunning" : true,
          "memberNameport" : "memberName"1,
          "diskStoreNamemaxThreads" : "diskStoreName"6,
          "ignoreUnreadFieldsbindAddress" : true"bindAddress",
          "pdxSerializermaxConnections" : "pdxSerializer"0
        } ],
    }, {
      "configurationcoordinator" : {true,
        "autoSerializergroups" : {"groups",
        "serverBindAddress" : "patternsserverBindAddress" : [,
        "patternscacheXmlFilePath", : "patternscacheXmlFilePath" ],
          "portablelocatorPort" : true3,
        }"heapUsage" : 2,
        "readSerializedinitHeapSize" : true9,
        "diskStoreNamelogFilePath" : "diskStoreNamelogFilePath",
        "ignoreUnreadFieldsoffHeapMemorySize" : true"offHeapMemorySize",
        "pdxSerializersecured" : {true,
          "initPropertiesstatArchiveFilePath" : {"statArchiveFilePath",
        "status" : "status"
  "key"  : { } ]
    }, {
     },
   "configuration" : {
        "classNameid" : "classNameid",
        "group" : }"group"
      },
      "runtimeInfo" : [ {
        "readSerializedcpuUsage" : true5.637376656633329,
        "memberNameserver" : "memberName"true,
        "diskStoreNamehttpServiceBindAddress" : "diskStoreNamehttpServiceBindAddress",
        "ignoreUnreadFieldsmemberName" : true"memberName",
        "pdxSerializerlocators" : "pdxSerializerlocators",
        "processId" : }4, {
        "readSerializedwebSSL" : true,
        "memberNamehostedRegions" : [ "hostedRegions", "memberNamehostedRegions" ],
        "diskStoreNamehost" : "diskStoreNamehost",
        "ignoreUnreadFieldsmaxHeapSize" : true2,
        "pdxSerializerworkingDirPath" : "pdxSerializerworkingDirPath",
        "id" } ]
: "id",
        } ]"clientCount" : 5,
        "idhttpServicePort" : "id"
7,
      },
  "linkscacheServerInfo" : [ {
 "self         "running" : true,
          "uriport" : }1,
          "statusMessagemaxThreads" : "statusMessage"6,
          "statusCodebindAddress" : "OKbindAddress"
}

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" : [,
          "maxConnections" : 0
        }, {
          "bucketCreateTimeInMillisecondsrunning" : 6true,
       "primaryTransferTimeInMilliseconds" : 7,
      "bucketCreatesCompletedport" : 1,
          "bucketTransfersCompletedmaxThreads" : 26,
      "bucketCreateBytes" : 0,
      "regionNamebindAddress" : "regionNamebindAddress",
          "bucketTransferTimeInMillisecondsmaxConnections" : 5,0
       "timeInMilliseconds" :} 3],
        "primaryTransfersCompletedcoordinator" : 9true,
        "bucketTransferBytesgroups" : 5"groups",
    }, {
      "bucketCreateTimeInMillisecondsserverBindAddress" : 6"serverBindAddress",
        "primaryTransferTimeInMillisecondscacheXmlFilePath" : 7"cacheXmlFilePath",
        "bucketCreatesCompletedlocatorPort" : 13,
        "bucketTransfersCompletedheapUsage" : 2,
        "bucketCreateBytesinitHeapSize" : 09,
        "regionNamelogFilePath" : "regionNamelogFilePath",
        "bucketTransferTimeInMillisecondsoffHeapMemorySize" : 5"offHeapMemorySize",
        "timeInMillisecondssecured" : 3true,
        "primaryTransfersCompletedstatArchiveFilePath" : 9"statArchiveFilePath",
        "bucketTransferBytesstatus" : 5"status"
      }, ],{
        "successcpuUsage" : true5.637376656633329,
        "statusMessageserver" : true,
        "statusMessagehttpServiceBindAddress"
 : }"httpServiceBindAddress",
        "operationEndedmemberName" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXmemberName",
        "operationStartlocators" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "links" : { "self" : "uri" },
  "operatorlocators",
        "processId" : 4,
        "webSSL" : true,
        "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
        "host" : "operatorhost",
        "statusMessagemaxHeapSize" : "statusMessage"2,
  "statusCode      "workingDirPath" : "OKworkingDirPath"
}

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,
        "id" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXid",
        "operationStartclientCount" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"5,
        "operationIdhttpServicePort" : "operationId"7,
        "operatorcacheServerInfo" : "operator",[ {
    "statusMessage" : "statusMessage",
    "statusCoderunning" : "OK"true,
  }, {
        "operationEndedport" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
1,
          "operationStartmaxThreads" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"6,
          "operationIdbindAddress" : "operationIdbindAddress",
          "operatormaxConnections" : "operator",
 0
        }, {
          "statusMessagerunning" : "statusMessage"true,
          "statusCodeport" : "OK"
1,
    } ],
  "links" : { "selfmaxThreads" : "uri" }6,
          "statusMessagebindAddress" : "statusMessagebindAddress",
   "statusCode       "maxConnections" : "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. 
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"
  },

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. 
Responses
200
 OK ClusterManagementGetResult_Region_RuntimeRegionInfo 
401
 Unauthorized 
403
 Forbidden 
404
 Not Found 409 Index already exists. 
500

...

Internal error. POST

GET /management/v1/

regions

indexes

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

list indexes

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult_Index_IndexInfo ClusterManagementResult

Example data

Content-Type: application/json
{
  "links" : { "self  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "uriexpression" },
        "statusMessagename" : "statusMessage"name"
      },
      "statusCoderuntimeInfo" : [ "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{
        "memberName" : "memberName"
      }, {
        "memberName" : "uri" },
  "statusMessagememberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "statusMessageregionPath",
        "statusCodeindexType" : "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

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
{
  "links" : { "selfKEY",
        "expression" : "expression",
        "name" : "uriname"
      },
      "statusMessageruntimeInfo" : "statusMessage",
[ {
        "statusCodememberName" : "OKmemberName"
}

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden 
{
  "result" :      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "configurationByGroupgroups" : [ {
      "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 ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions/{

id

regionName}/indexes

get list region indexes

Path parameters

id regionName (required)
Path Parameter -- regionName

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementGetResultClusterManagementListResult_RegionIndex_RuntimeRegionInfoIndexInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "configurationByGroupgroups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
  regionPath" : "regionPath",
        "actionindexType" : "DESTROYKEY",
          "typeexpression" : "ENTRY_TIME_TO_LIVEexpression",
          "timeInSecondsname" : 1"name"
        } ],
        "redundantCopiesruntimeInfo" : [ 5,{
        "evictionmemberName" : {"memberName"
      }, {
        "entryCountmemberName" : 0,"memberName"
      } ]
   "objectSizer" :}, {
            "initProperties"configuration" : {
        "regionPath" : "regionPath",
        "keyindexType" : { }"KEY",
        "expression"    }: "expression",
            "classNamename" : "classNamename"
      },
       },
  "runtimeInfo" : [ {
        "actionmemberName" : "LOCAL_DESTROY",memberName"
      }, {
          "typememberName" : "ENTRY_COUNTmemberName",
      } ]
   "memorySizeMb" :} 6],
    "id" : "id"
  }, {
        "keyConstraintgroups" : "keyConstraint",
 [ {
       "nameconfiguration" : "name",{
        "valueConstraintregionPath" : "valueConstraintregionPath",
        "typeindexType" : "PARTITIONKEY",
        "diskStoreNameexpression" : "diskStoreNameexpression",
        "groupname" : "groupname"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirationsregionPath" : [ {"regionPath",
          "actionindexType" : "DESTROYKEY",
          "typeexpression" : "ENTRY_TIME_TO_LIVEexpression",
        "name" : "timeInSecondsname"
 : 1     },
      "runtimeInfo" : },[ {
          "actionmemberName" : "DESTROYmemberName",
      }, {
        "typememberName" : "ENTRY_TIME_TO_LIVE",memberName"
      } ]
   "timeInSeconds" :} 1],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "redundantCopiesstatusMessage" : 5"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" : [ {
    "eviction" : {
          "entryCountgroups" : [ 0,{
          "objectSizerconfiguration" : {
            "initPropertiesexpirations" : [ {
              "keyaction" : { }"DESTROY",
          "type"  }: "ENTRY_TIME_TO_LIVE",
            "classNametimeInSeconds" : "className"1
          }, {
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNTTIME_TO_LIVE",
          "memorySizeMbtimeInSeconds" : 61
        } ],
        "keyConstraintredundantCopies" : "keyConstraint"5,
        "nameeviction" : "name",{
        "valueConstraint" : "valueConstraintentryCount",
        "type" : "PARTITION"0,
        "diskStoreName" : "diskStoreName",
        "group" : "group"objectSizer" : {
      },
      "runtimeInfoinitProperties" : [ {
     {
    "entryCount" : 5,
        "memberNamekey" : "memberName"{ }
      }, {
      },
  "entryCount" : 5,
        "memberNameclassName" : "memberNameclassName"
          },
 ]
    } ],
    "idaction" : "idLOCAL_DESTROY",
   },
    "links" : { "selftype" : "uriENTRY_COUNT" },
  "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" : [ {
memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "configurationname" : {"name",
        "regionPathvalueConstraint" : "regionPathvalueConstraint",
        "indexTypetype" : "KEYPARTITION",
        "expressiondiskStoreName" : "expressiondiskStoreName",
        "namegroup" : "namegroup"
      },
      "runtimeInfo" : [ {
        "memberNameentryCount" : "memberName"
  5,
  }, {
      "memberName" : "memberName"
    } ]
  }, {
        "configurationentryCount" : {5,
        "regionPathmemberName" : "regionPathmemberName",
      "indexType" : "KEY",} ]
    }, {
      "expressionconfiguration" : "expression",
{
        "nameexpirations" : "name"
[ {
      },
    "runtimeInfoaction" : [ {
 "DESTROY",
          "memberNametype" : "memberName"
 ENTRY_TIME_TO_LIVE",
   }, {
      "memberNametimeInSeconds" : "memberName"1
        }, ]{
  }   ],
  "links" : { "selfaction" : "uriDESTROY" },
          "statusMessagetype" : "statusMessageENTRY_TIME_TO_LIVE",
  "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

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" : [ {
    "configurationtimeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
      "regionPath        "key" : "regionPath",
 { }
            },
            "indexTypeclassName" : "KEY"className"
          },
          "expressionaction" : "expressionLOCAL_DESTROY",
          "nametype" : "nameENTRY_COUNT",
    },
      "runtimeInfomemorySizeMb" : [ {6
      "memberName" : "memberName"
    }, {
},
        "memberNamekeyConstraint" : "memberNamekeyConstraint",
    } ]
  }, {
    "configuration" : {
 "name" : "name",
        "regionPathvalueConstraint" : "regionPathvalueConstraint",
        "indexTypetype" : "KEYPARTITION",
        "expressiondiskStoreName" : "expressiondiskStoreName",
        "namegroup" : "namegroup"
      },
      "runtimeInfo" : [ {
        "memberNameentryCount" : "memberName"5,
    }, {
      "memberName" : "memberName"
      }, ]{
  } ],
      "linksentryCount" : { 5,
        "selfmemberName" : "urimemberName"
 },     } ]
  "statusMessage"  :} "statusMessage",
],
    "statusCodeid" : "OKid"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found 
{
  "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 ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

ClusterManagementGetResult_Deployment_DeploymentInfo

links (optional)
Links
result (optional)
ConfigurationInfoEntityInfo_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)
ConfigurationInfoEntityInfo_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)
ConfigurationInfoEntityInfo_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)
ConfigurationInfoEntityInfo_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)
ConfigurationInfoEntityInfo_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)
ConfigurationInfoEntityInfo_Region_RuntimeRegionInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

...

ClusterManagementListResult_Deployment_DeploymentInfo

links (optional)
Links
result (optional)
array[ConfigurationResultEntityInfo_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

ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

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

ClusterManagementListResult_Index_IndexInfo

links (optional)
Links
result (optional)
array[ConfigurationResultEntityInfo_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

ClusterManagementListResult_Member_MemberInformation

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

ClusterManagementListResult_Region_RuntimeRegionInfo

links (optional)
Links
result (optional)
array[ConfigurationResultEntityInfo_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

...

ClusterManagementResult

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

Deployment

deployedBy (optional)
String
deployedTime (optional)
String
group

ConfigurationInfo_Deployment_DeploymentInfo

configurationByGroup (optional)
array[ConfigurationResult_Deployment_DeploymentInfo]
String
jarFileName id (optional)
String

ConfigurationInfo_GatewayReceiver_GatewayReceiverInfo

DeploymentInfo

jarLocation configurationByGroup (optional)
array[ConfigurationResult_GatewayReceiver_GatewayReceiverInfo]
String
lastModified id (optional)
String

ConfigurationInfo_Index_IndexInfo

configurationByGroup memberName (optional)
array[ConfigurationResult_Index_IndexInfo]
String
latest id (optional)
String

ConfigurationInfo_Member_MemberInformation

configurationByGroup supported (optional)
array[ConfigurationResult_Member_MemberInformation]String]

EntityGroupInfo_Deployment_DeploymentInfo

configuration id (optional)
String

ConfigurationInfo_Pdx_PdxInfo

Deployment
runtimeInfo configurationByGroup (optional)
array[ConfigurationResult_Pdx_PdxInfo]DeploymentInfo]

EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo

configuration id (optional)
String

ConfigurationInfo_Region_RuntimeRegionInfo

GatewayReceiver
runtimeInfo configurationByGroup (optional)
array[ConfigurationResult_Region_RuntimeRegionInfo]GatewayReceiverInfo]

EntityGroupInfo_Index_IndexInfo

configuration id (optional)
String

ConfigurationResult_Deployment_DeploymentInfo

Index
runtimeInfo configuration (optional)
array[IndexInfo]

EntityGroupInfo_Member_MemberInformation

configuration
Deployment
links (optional)
Links Member
runtimeInfo (optional)
array[DeploymentInfoMemberInformation]
ConfigurationResult

EntityGroupInfo_

GatewayReceiver

Pdx_

GatewayReceiverInfo

PdxInfo

configuration (optional)
GatewayReceiver
links (optional)
Links
Pdx
runtimeInfo (optional)
array[GatewayReceiverInfoPdxInfo]
ConfigurationResult

EntityGroupInfo_

Index

Region_

IndexInfo

RuntimeRegionInfo

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

EntityInfo_Deployment_DeploymentInfo

groups runtimeInfo (optional)
array[IndexInfo]

ConfigurationResult_Member_MemberInformation

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

EntityInfo_GatewayReceiver_GatewayReceiverInfo

groups runtimeInfo (optional)
array[MemberInformation]

ConfigurationResult_Pdx_PdxInfo

EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo]
id configuration (optional)
Pdx String
links (optional)
Links

EntityInfo_Index_IndexInfo

groups runtimeInfo (optional)
array[PdxInfo]

ConfigurationResult_Region_RuntimeRegionInfo

EntityGroupInfo_Index_IndexInfo]
id configuration (optional)
Region String
links (optional)
Links

EntityInfo_Member_MemberInformation

groups runtimeInfo (optional)
array[RuntimeRegionInfoEntityGroupInfo_Member_MemberInformation]

Deployment

deployedBy id (optional)
String
deployedTime links (optional)
String
Links

EntityInfo_Pdx_PdxInfo

groups group (optional)
String
array[EntityGroupInfo_Pdx_PdxInfo]
id jarFileName (optional)
String

DeploymentInfo

jarLocation links (optional)
Links

EntityInfo_Region_RuntimeRegionInfo

groups
String
lastModified (optional)
String
memberName (optional)
String
array[EntityGroupInfo_Region_RuntimeRegionInfo]
id latest (optional)
String
supported links (optional)
array[String] Links

Eviction

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount (optional)
Integer format: int32
memorySizeMb (optional)
Integer format: int32
objectSizer (optional)
ClassName
type (optional)
String
Enum:
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE

...