Versions Compared

Old Version 29

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version Current

changes.mady.by.user Jinmei Liao

Saved on

Key

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

Table of Contents
maxLevel2
excludeFoo

Apache Geode Management REST API

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

...

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

...

Deployment Management

...

GET /management/v1/

...

deployments/

...

{id}

get

...

deployed

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_Deployment_DeploymentInfo

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "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" : "id"
  }, {
    "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" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

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

Responses

200

OK DocLinks

401

Unauthorized

403

Forbidden

404

Not Found

...

Gateway Management

POST /management/v1/gateways/receivers

create gateway-receiver

Consumes

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

Request body

body GatewayReceiver (required)
Request Body

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.

...

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

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "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
      } ]
    }, {
      "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
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "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" : [ {
    "groups" : [ {
      "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
      } ]
    }, {
      "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
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "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
      } ]
    }, {
      "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
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "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" : {
    "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 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" : [ {
    "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"
  }, {
    "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

...

Member Management

Pdx Management

Ping

Rebalance Operation

Region Management

Gateway Management

Up 
post /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)
Body Parameter -- gatewayReceiverConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "linksautoSerializer" : { },

          "statusMessagepatterns" : [ "patterns", "statusMessagepatterns" ],
    "statusCode      "portable" : "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. 
true
        },
        "readSerialized" : true,
Up 
get /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
Up 
get /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" : {
        "configurationdiskStoreName" : {"diskStoreName",
        "startPortignoreUnreadFields" : 5true,
        "gatewayTransportFilterspdxSerializer" : [ {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        }
      },
      "runtimeInfo" : [ {
        "readSerialized" : true,
        "memberName" : "memberName",
        "initPropertiesdiskStoreName" : {
  "diskStoreName",
        "ignoreUnreadFields" : true,
        "keypdxSerializer" : { "pdxSerializer"
      }, {
        "readSerialized" :  }true,
        "classNamememberName" : "classNamememberName",
      } ],
      "manualStartdiskStoreName" : true"diskStoreName",
        "maximumTimeBetweenPingsignoreUnreadFields" : 6true,
        "endPortpdxSerializer" : 0,"pdxSerializer"
      } ]
  "socketBufferSize" : 1}, {
      "groupconfiguration" : "group"{
    },
    "runtimeInfoautoSerializer" : [ {
          "connectedSenderspatterns" : [ "connectedSenderspatterns", "connectedSenderspatterns" ],
      "running" : true,
      "portportable" : 5,true
      "hostnameForSenders" : "hostnameForSenders"},
        "memberNamereadSerialized" : "memberName"true,
        "bindAddressdiskStoreName" : "bindAddressdiskStoreName",
        "senderCountignoreUnreadFields" : 2true,
    }, {
      "connectedSenderspdxSerializer" : [ "connectedSenders", "connectedSenders" ],
{
          "runninginitProperties" : true,{
      "port" : 5,
      "hostnameForSenderskey" : "hostnameForSenders", { }
      "memberName"   : "memberName"},
          "bindAddressclassName" : "bindAddressclassName",
      "senderCount" : 2}
    } ]
  },
      "linksruntimeInfo" : [ { },

        "statusMessagereadSerialized" : "statusMessage"true,
        "statusCodememberName" : "OK"
}

Responses

200

OK ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found 
{
  "result" : [ {
    "configuration" : {
memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      }, {
        "readSerialized" : true,
        "startPortmemberName" : 5"memberName",
        "gatewayTransportFiltersdiskStoreName" : [ {"diskStoreName",
        "initPropertiesignoreUnreadFields" : {true,
        "pdxSerializer" : "key" : { }pdxSerializer"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "classNamestatusMessage" : "classNamestatusMessage",
  "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" : [ {   }, {
        "initProperties" : {
          "key" : { }
        },
        "className" : "className"
      } ],
      "manualStart" : true,
      "maximumTimeBetweenPings"bucketCreateTimeInMilliseconds" : 6,
      "endPortprimaryTransferTimeInMilliseconds" : 07,
      "socketBufferSizebucketCreatesCompleted" : 1,
      "groupbucketTransfersCompleted" : "group"
    },
    "runtimeInfo" : [ {2,
      "connectedSendersbucketCreateBytes" : [ "connectedSenders", "connectedSenders" ],0,
      "runningregionName" : true,
      "portregionName" : 5,
      "hostnameForSendersbucketTransferTimeInMilliseconds" : "hostnameForSenders"5,
      "memberNametimeInMilliseconds" : "memberName"3,
      "bindAddressprimaryTransfersCompleted" : "bindAddress"9,
      "senderCountbucketTransferBytes" : 25
    }, {
      "connectedSendersbucketCreateTimeInMilliseconds" : [ 6,
      "connectedSendersprimaryTransferTimeInMilliseconds", "connectedSenders": ]7,
      "runningbucketCreatesCompleted" : true1,
      "portbucketTransfersCompleted" : 52,
      "hostnameForSendersbucketCreateBytes" : "hostnameForSenders"0,
      "memberNameregionName" : "memberNameregionName",
      "bindAddressbucketTransferTimeInMilliseconds" : "bindAddress"5,
      "senderCounttimeInMilliseconds" : 23,
    } ]
  }, {
  "primaryTransfersCompleted" : 9,
      "configurationbucketTransferBytes" : {5
    } ],
    "startPortsuccess" : 5true,
      "gatewayTransportFiltersstatusMessage" : [ {"statusMessage"
  },
  "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "initPropertiesoperationStart" : {
        "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "keylinks" : { }
"self" :       "uri" },
        "classNameoperator" : "classNameoperator",
  "statusMessage"    }, {: "statusMessage",
        "initProperties" : {
          "key" : { }
        },
    "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" : [ {
    "classNameoperationEnded" : "className"
      } ]yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "manualStartoperationStart" : true"yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "maximumTimeBetweenPingsoperationId" : 6"operationId",
      "endPortoperator" : 0"operator",
      "socketBufferSizestatusMessage" : 1"statusMessage",
      "groupstatusCode" : "groupOK"
    },
    "runtimeInfo" : [ {
      "connectedSendersoperationEnded" : [ "connectedSenders", "connectedSenders" ],yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operationStart" : "running" : trueyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "portoperationId" : 5"operationId",
      "hostnameForSendersoperator" : "hostnameForSendersoperator",
      "memberNamestatusMessage" : "memberNamestatusMessage",
      "bindAddressstatusCode" : "bindAddressOK",
  }  ],
  "senderCountlinks" : 2
{ "self" : "uri" }, {
  "statusMessage" : "statusMessage",
  "connectedSendersstatusCode" : [ "connectedSenders", "connectedSenders" ],
      "running" : true,
      "port" : 5,
      "hostnameForSenders" : "hostnameForSenders",
      "memberName" : "memberName",
      "bindAddress" : "bindAddress",
      "senderCount" : 2
    } ]
  } ],
  "links" : { } "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 ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» ClusterManagementOperationResult_RebalanceResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Region Management

Up get

POST /management/v1/

members

regions/{

id

regionName}

/indexes

create region indexget member

Path parameters

id 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 -- id indexConfig

Return type

ClusterManagementGetResult«Member,MemberInformation» ClusterManagementResult

Example data

Content-Type: application/json
{
  "result" : {
    "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
      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" : [}, {
        "runningconfiguration" : true,{
        "portregionPath" : 1"regionPath",
        "maxThreadsindexType" : 6"KEY",
        "bindAddressexpression" : "bindAddressexpression",
        "maxConnectionsname" : 0"name"
      } ],
      "coordinatorruntimeInfo" : true,
[ {
        "groupsmemberName" : "groups",memberName"
      }, {
        "serverBindAddressmemberName" : "serverBindAddressmemberName",
      } ]
  "cacheXmlFilePath" : "cacheXmlFilePath"}, {
      "locatorPortconfiguration" : 3,{
        "heapUsageregionPath" : 2"regionPath",
        "initHeapSizeindexType" : 9"KEY",
        "logFilePathexpression" : "logFilePathexpression",
        "offHeapMemorySizename" : "offHeapMemorySizename",
      "secured" : true},
      "statArchiveFilePathruntimeInfo" : "statArchiveFilePath",
 [ {
        "statusmemberName" : "statusmemberName"
      }, {
        "cpuUsagememberName" : 5.637376656633329,
"memberName"
       "server" : true} ]
    } ],
      "httpServiceBindAddressid" : "httpServiceBindAddressid"
  },
  "links" : {  "memberNameself" : "memberNameuri" },
  "statusMessage" : "statusMessage",
  "locatorsstatusCode" : "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" : {locators",
      "processId" : 4,
      "webSSL" : true,
      "hostedRegionsgroups" : [ "hostedRegions", "hostedRegions" ],{
      "hostconfiguration" : "host",
{
        "maxHeapSizeexpirations" : 2,
  [ {
    "workingDirPath" : "workingDirPath",
      "idaction" : "idDESTROY",
      "clientCount" : 5,
      "httpServicePorttype" : 7,
      "cacheServerInfo" : [ {
        "running" : true,
"ENTRY_TIME_TO_LIVE",
          "porttimeInSeconds" : 1,
        "maxThreads" : 6,
}, {
          "bindAddressaction" : "bindAddressDESTROY",
          "maxConnectionstype" : 0
      }, {
"ENTRY_TIME_TO_LIVE",
          "runningtimeInSeconds" : true,1
        "port" : 1} ],
        "maxThreadsredundantCopies" : 65,
        "bindAddresseviction" : "bindAddress",{
          "maxConnectionsentryCount" : 0,
      } ],
      "coordinatorobjectSizer" : true,{
      "groups" : "groups",
      "serverBindAddressinitProperties" : "serverBindAddress",{
      "cacheXmlFilePath" : "cacheXmlFilePath",
      "locatorPortkey" : 3,
{ }
          "heapUsage" : 2},
      "initHeapSize" : 9,
      "logFilePathclassName" : "logFilePathclassName",
      "offHeapMemorySize" : "offHeapMemorySize",
     },
          "securedaction" : true"LOCAL_DESTROY",
          "statArchiveFilePathtype" : "statArchiveFilePathENTRY_COUNT",
          "statusmemorySizeMb" : "status"6
    }  ]
  },
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode"keyConstraint" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /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" : [ {
keyConstraint",
        "configurationname" : {"name",
        "idvalueConstraint" : "idvalueConstraint",
        "grouptype" : "groupPARTITION",
    },
    "runtimeInfodiskStoreName" : [ {
"diskStoreName",
        "cpuUsagegroup" : 5.637376656633329,"group"
      "server" : true},
      "httpServiceBindAddressruntimeInfo" : "httpServiceBindAddress",
[ {
        "memberNameentryCount" : "memberName"5,
        "locatorsmemberName" : "locatorsmemberName",
       "processId" : 4,
}, {
        "webSSLentryCount" : true5,
        "hostedRegionsmemberName" : [ "hostedRegionsmemberName",
  "hostedRegions" ],
   } ]
  "host" : "host"}, {
      "maxHeapSizeconfiguration" : 2,{
        "workingDirPathexpirations" : "workingDirPath",
 [ {
          "idaction" : "idDESTROY",
          "clientCounttype" : 5"ENTRY_TIME_TO_LIVE",
          "httpServicePorttimeInSeconds" : 7,1
      "cacheServerInfo" : [}, {
          "runningaction" : true"DESTROY",
          "porttype" : 1"ENTRY_TIME_TO_LIVE",
          "maxThreadstimeInSeconds" : 6,1
        "bindAddress" : "bindAddress"} ],
        "maxConnectionsredundantCopies" : 05,
        },"eviction" : {
          "runningentryCount" : true0,
          "portobjectSizer" : 1,{
            "maxThreadsinitProperties" : 6,{
        "bindAddress" :      "bindAddresskey",
 : { }
     "maxConnections" : 0
      } ],
      "coordinator" : true,
      "groupsclassName" : "groupsclassName",
        "serverBindAddress" : "serverBindAddress"},
          "cacheXmlFilePathaction" : "cacheXmlFilePathLOCAL_DESTROY",
          "locatorPorttype" : 3"ENTRY_COUNT",
          "heapUsagememorySizeMb" : 2,6
      "initHeapSize" : 9},
        "logFilePathkeyConstraint" : "logFilePathkeyConstraint",
        "offHeapMemorySizename" : "offHeapMemorySizename",
        "securedvalueConstraint" : true"valueConstraint",
        "statArchiveFilePathtype" : "statArchiveFilePathPARTITION",
        "statusdiskStoreName" : "statusdiskStoreName",
    }, {
    "group" : "cpuUsagegroup"
   : 5.637376656633329   },
      "serverruntimeInfo" : true,
[ {
        "httpServiceBindAddressentryCount" : "httpServiceBindAddress"5,
        "memberName" : "memberName",
       "locators" : "locators",
}, {
        "processIdentryCount" : 45,
        "webSSLmemberName" : true,"memberName"
      } "hostedRegions"]
 : [ "hostedRegions", "hostedRegions" } ],
      "hostid" : "hostid",
    },
  "maxHeapSizelinks" : 2,
      "workingDirPath{ "self" : "workingDirPathuri" },
      "idstatusMessage" : "idstatusMessage",
  "statusCode" :   "clientCount" : 5,
      "httpServicePort" : 7,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" : [ {
      "cacheServerInfogroups" : [ {
        "runningconfiguration" : true,{
        "portregionPath" : 1"regionPath",
        "maxThreadsindexType" : 6"KEY",
        "bindAddressexpression" : "bindAddressexpression",
        "maxConnectionsname" : 0"name"
      }, {
        "runningruntimeInfo" : true,
        "port" : 1,[ {
        "maxThreadsmemberName" : 6,
        "bindAddress" : "bindAddress",
        "maxConnections" : 0"memberName"
      }, ],
      "coordinator" : true,
{
        "groupsmemberName" : "groupsmemberName",
      "serverBindAddress" : "serverBindAddress",
   } ]
  "cacheXmlFilePath" : "cacheXmlFilePath"}, {
      "locatorPortconfiguration" : 3,{
        "heapUsageregionPath" : 2"regionPath",
        "initHeapSizeindexType" : 9"KEY",
        "logFilePathexpression" : "logFilePathexpression",
        "offHeapMemorySizename" : "offHeapMemorySizename",
      "secured" : true},
      "statArchiveFilePathruntimeInfo" : "statArchiveFilePath",[ {
        "statusmemberName" : "statusmemberName"
    } ]
  }, {
    "configuration" : {
      "idmemberName" : "idmemberName",
      "group" : "group"} ]
    } ],
    "runtimeInfoid" : [ "id"
  }, {
      "cpuUsagegroups" : 5.637376656633329, [ {
      "serverconfiguration" : true,{
        "httpServiceBindAddressregionPath" : "httpServiceBindAddressregionPath",
        "memberNameindexType" : "memberNameKEY",

        "locatorsexpression" : "locatorsexpression",
        "processIdname" : 4,"name"
      "webSSL" : true},
      "hostedRegionsruntimeInfo" : [ "hostedRegions", "hostedRegions" ],
{
        "hostmemberName" : "hostmemberName",
      "maxHeapSize" : 2,
}, {
        "workingDirPathmemberName" : "workingDirPathmemberName",
      } ]
  "id" : "id"}, {
      "clientCountconfiguration" : 5,{
        "httpServicePortregionPath" : 7"regionPath",
        "cacheServerInfoindexType" : [ {"KEY",
        "runningexpression" : true"expression",
        "portname" : 1,"name"
      },
      "maxThreadsruntimeInfo" : 6,[ {
        "bindAddressmemberName" : "bindAddress",memberName"
      }, {
        "maxConnectionsmemberName" : 0 "memberName"
      }, {]
    } ],
    "runningid" : true,"id"
  } ],
  "links" : { "portself" : 1"uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "maxThreads" : 6,
   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" : [ {     "bindAddress" : "bindAddress",
        "maxConnections" : 0
      } ],
      "coordinatorconfiguration" : true,{
        "groupsregionPath" : "groupsregionPath",
        "serverBindAddressindexType" : "serverBindAddressKEY",
        "cacheXmlFilePathexpression" : "cacheXmlFilePathexpression",
        "locatorPortname" : 3,"name"
      "heapUsage" : 2},
      "initHeapSizeruntimeInfo" : [ 9,{
        "logFilePathmemberName" : "logFilePathmemberName",
      "offHeapMemorySize" : "offHeapMemorySize",
      "secured" : true,
}, {
        "statArchiveFilePathmemberName" : "statArchiveFilePathmemberName",
      "status" : "status"
    }, {]
      "cpuUsage" : 5.637376656633329,   }, {
      "serverconfiguration" : true,{
        "httpServiceBindAddressregionPath" : "httpServiceBindAddressregionPath",
        "memberNameindexType" : "memberNameKEY",
        "locatorsexpression" : "locatorsexpression",
        "processIdname" : 4,"name"
      "webSSL" : true},
      "hostedRegionsruntimeInfo" : [ "hostedRegions", "hostedRegions" ],
{
        "hostmemberName" : "hostmemberName",
      "maxHeapSize" : 2,
}, {
        "workingDirPathmemberName" : "workingDirPathmemberName",
      "id" : "id",} ]
      "clientCount" : 5} ],
    "id" : "httpServicePortid"
 : 7}, {
      "cacheServerInfogroups" : [ {
        "runningconfiguration" : true,{
        "portregionPath" : 1"regionPath",
        "maxThreadsindexType" : 6"KEY",
        "bindAddressexpression" : "bindAddressexpression",
        "maxConnectionsname" : 0"name"
      }, {
        "runningruntimeInfo" : true,[ {
        "portmemberName" : 1,"memberName"
        "maxThreads" : 6,}, {
        "bindAddressmemberName" : "bindAddressmemberName",
        "maxConnections" : 0
  } ]
    }, ],{
      "coordinatorconfiguration" : true,{
        "groupsregionPath" : "groupsregionPath",
        "serverBindAddressindexType" : "serverBindAddressKEY",
        "cacheXmlFilePathexpression" : "cacheXmlFilePathexpression",
        "locatorPortname" : 3,"name"
      "heapUsage" : 2},
      "initHeapSizeruntimeInfo" : 9,
[ {
        "logFilePathmemberName" : "logFilePath",memberName"
      }, {
        "offHeapMemorySizememberName" : "offHeapMemorySizememberName",
      "secured" : true,} ]
      "statArchiveFilePath" : "statArchiveFilePath"} ],
      "statusid" : "statusid"
    } ],
  } ],
 "links" : { "linksself" : {"uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Member,MemberInformation» ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

Pdx Management

...

Up post 

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

regions

list regions

Query parameters

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

Return type

ClusterManagementListResult_Region_RuntimeRegionInfo ClusterManagementResult

Example data

Content-Type: application/json
{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
  "links      "expirations" : [ { },
  "statusMessage
          "action" : "DESTROY",
          "type" : "statusMessageENTRY_TIME_TO_LIVE",
          "statusCodetimeInSeconds" : "OK"
}

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

Ping

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

1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
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
{
  "result" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds      "className" : 6 "className"
          },
          "primaryTransferTimeInMillisecondsaction" : 7"LOCAL_DESTROY",
          "bucketCreatesCompletedtype" : 1,
"ENTRY_COUNT",
          "bucketTransfersCompletedmemorySizeMb" : 2,6
      "bucketCreateBytes" : 0},
        "regionNamekeyConstraint" : "regionNamekeyConstraint",
        "bucketTransferTimeInMillisecondsname" : 5"name",
        "timeInMillisecondsvalueConstraint" : 3"valueConstraint",
        "primaryTransfersCompletedtype" : 9"PARTITION",
        "bucketTransferBytesdiskStoreName" : 5
  "diskStoreName",
  }, {
      "bucketCreateTimeInMillisecondsgroup" : 6,"group"
      "primaryTransferTimeInMilliseconds" : 7},
      "bucketCreatesCompletedruntimeInfo" : 1,[ {
        "bucketTransfersCompletedentryCount" : 25,
        "bucketCreateBytesmemberName" : 0,"memberName"
       "regionName" : "regionName",
}, {
        "bucketTransferTimeInMillisecondsentryCount" : 5,
        "timeInMillisecondsmemberName" : 3,"memberName"
      } ]
  "primaryTransfersCompleted" : 9}, {
      "bucketTransferBytesconfiguration" : 5{
    } ],
    "statusMessageexpirations" : "statusMessage"
[ {
    },
  "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operationStartaction" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXDESTROY",
   "links"   : { },
  "operatortype" : "operatorENTRY_TIME_TO_LIVE",
  "statusMessage"   : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationStatusResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
get /v1/operations/rebalances
list rebalances

Return type

ClusterManagementListOperationsResult«RebalanceResult»

Example data

Content-Type: application/json
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" : [timeInSeconds" : 1
        }, {
    "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operationStartaction" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXDESTROY",
    "operationId" : "operationId",
    "operatortype" : "operatorENTRY_TIME_TO_LIVE",
    "statusMessage" : "statusMessage",
    "statusCodetimeInSeconds" : "OK"1
  }, {
    "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
} ],
        "operationStartredundantCopies" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
5,
        "operationIdeviction" : "operationId",
{
          "operatorentryCount" : "operator"0,
    "statusMessage      "objectSizer" : "statusMessage",{
     "statusCode" : "OK"
  } ],
  "linksinitProperties" : { },

        "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListOperationsResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found
Up 
post /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

Up 
post /v1/regions
create region

Consumes

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

Request body

body Region (required)
Body Parameter -- regionConfig

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.
Up 
delete /v1/regions/{id}
delete region

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden 
{
  "resultkey" : { }
            },
            "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" : {
        "configurationexpirations" : [ {
          "regionPathaction" : "regionPathDESTROY",
          "expressiontype" : "ENTRY_TIME_TO_LIVE",
          "expression",timeInSeconds" : 1
        }, {
          "keyIndexaction" : true"DESTROY",
          "nametype" : "ENTRY_TIME_TO_LIVE",
          "name",timeInSeconds" : 1
      "group"  : "group"} ],
    },
    "runtimeInforedundantCopies" : 5,
 [ {
      "memberNameeviction" : "memberName"{
    }, {
      "memberNameentryCount" : "memberName"0,
     } ]
  },
  "linksobjectSizer" : {
 },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found Up get
/v1/regions/{id}
get region

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementGetResult«Region,RuntimeRegionInfo»

Example data

Content-Type: application/json
{
  "resultinitProperties" : {
    "configuration"   : {
      "expirationskey" : [{ {}
          "action" : "DESTROY"},
            "typeclassName" : "ENTRY_TIME_TO_LIVE",className"
        "timeInSeconds" : 0
      }, {
},
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_TIME_TO_LIVECOUNT",
          "timeInSecondsmemorySizeMb" : 06
        } ],
      "redundantCopies" : 6,
      "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
      "entryCount" : 1,
      "memberNameentryCount" : "memberName"
    }, {
      "entryCount" : 1,
5,
        "memberName" : "memberName"
    } ]
  }, {
   "links" : { },
  "statusMessageentryCount" : "statusMessage"5,
        "statusCodememberName" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found 
memberName"
      } ]
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" : [ {
    "configuration" :}, {
      "regionPathconfiguration" : "regionPath",{
      "expression" : "expressionexpirations",
 : [ {
   "keyIndex" : true,
      "nameaction" : "nameDESTROY",
          "grouptype" : "group"ENTRY_TIME_TO_LIVE",
    },
      "runtimeInfotimeInSeconds" : [ 1
        }, {
          "memberNameaction" : "memberNameDESTROY",
    }, {
      "memberNametype" : "memberName"ENTRY_TIME_TO_LIVE",
    } ]
  }, {
    "configurationtimeInSeconds" : {1
      "regionPath"  :} "regionPath"],
        "expressionredundantCopies" : "expression"5,
        "keyIndexeviction" : true,{
          "nameentryCount" : "name"0,
      "group"   : "groupobjectSizer"
 :   },{
    "runtimeInfo" : [ {
      "memberNameinitProperties" : "memberName"
{
       }, {
      "memberNamekey" : { "memberName"}
    } ]
        } ],
       "links" : { },
  "statusMessageclassName" : "statusMessageclassName",
       "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found 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«IndexContent-Type: application/json
,
RuntimeInfo»

Example data


{
  "result" : [ {
          "configurationaction" : {
"LOCAL_DESTROY",
          "regionPathtype" : "regionPathENTRY_COUNT",
          "expressionmemorySizeMb" : "expression",6
      "keyIndex" : true},
        "namekeyConstraint" : "namekeyConstraint",
        "groupname" : "groupname",
    },
    "runtimeInfovalueConstraint" : "valueConstraint",
 [ {
      "memberNametype" : "memberNamePARTITION",
    }, {
      "memberNamediskStoreName" : "memberNamediskStoreName",
    } ]
  }, {
    "configurationgroup" : {"group"
      "regionPath" : "regionPath"},
      "expressionruntimeInfo" : "expression", [ {
        "keyIndexentryCount" : true5,
        "namememberName" : "namememberName",
      "group" : "group"}, {
    },
    "runtimeInfoentryCount" : 5,
 [ {
      "memberName" : "memberName"
      }, {]
    } ],
    "memberNameid" : "memberNameid"
    } ],
  } ],
 "links" : { "linksself" : {"uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo» ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found
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" : {
      "expirations" : [ {
        "action" : "DESTROY",
        "type" : "ENTRY_TIME_TO_LIVE",
        "timeInSeconds" : 0
      }, {
        "action" : "DESTROY",
        "type" : "ENTRY_TIME_TO_LIVE",
        "timeInSeconds" : 0
      } ],
      "redundantCopies" : 6,
      "keyConstraint" : "keyConstraint",
      "name" : "name",
      "valueConstraint" : "valueConstraint",
      "type" : "PARTITION",
      "diskStoreName" : "diskStoreName",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 1,
      "memberName" : "memberName"
    }, {
      "entryCount" : 1,
      "memberName" : "memberName"
    } ]
  }, {
    "configuration" : {
      "expirations" : [ {
        "action" : "DESTROY",
        "type" : "ENTRY_TIME_TO_LIVE",
        "timeInSeconds" : 0
      }, {
        "action" : "DESTROY",
        "type" : "ENTRY_TIME_TO_LIVE",
        "timeInSeconds" : 0
      } ],
      "redundantCopies" : 6,
      "keyConstraint" : "keyConstraint",
      "name" : "name",
      "valueConstraint" : "valueConstraint",
      "type" : "PARTITION",
      "diskStoreName" : "diskStoreName",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "entryCount" : 1,
      "memberName" : "memberName"
    }, {
      "entryCount" : 1,
      "memberName" : "memberName"
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

Models

...

Table of Contents

  1. CacheServerInfo - CacheServerInfo
  2. ClassName - ClassName
  3. ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
  4. ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo»
  5. ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation»
  6. ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo»
  7. ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult»
  8. ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»
  9. ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo»
  10. ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation»
  11. ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo»
  12. ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult»
  13. ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult»
  14. ClusterManagementResult - ClusterManagementResult
  15. ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
  16. ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo»
  17. ConfigurationResult«Member,MemberInformation» - ConfigurationResult«Member,MemberInformation»
  18. ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo»
  19. Expiration - Expiration
  20. GatewayReceiver - GatewayReceiver
  21. GatewayReceiverInfo - GatewayReceiverInfo
  22. Index - Index
  23. Links - Links
  24. Member - Member
  25. MemberInformation - MemberInformation
  26. Pdx - Pdx
  27. RebalanceOperation - RebalanceOperation
  28. RebalanceRegionResult - RebalanceRegionResult
  29. RebalanceResult - RebalanceResult
  30. Region - Region
  31. RuntimeInfo - RuntimeInfo
  32. 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]

...

Models

AutoSerializer

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

CacheServerInfo

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

ClassName

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

ClusterManagementGetResult_Deployment_DeploymentInfo

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

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

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

ClusterManagementGetResult_Index_IndexInfo

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

ClusterManagementGetResult_Member_MemberInformation

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

ClusterManagementGetResult_Pdx_PdxInfo

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

ClusterManagementGetResult_Region_RuntimeRegionInfo

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

ClusterManagementListOperationsResult_RebalanceResult

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

ClusterManagementListResult_Deployment_DeploymentInfo

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

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)
Links
result (optional)
ConfigurationResult«Index,RuntimeInfo» array[EntityInfo_Index_IndexInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation» Up

ClusterManagementListResult_Member_MemberInformation

links (optional)
Links
result (optional)
ConfigurationResult«Member,MemberInformation» array[EntityInfo_Member_MemberInformation]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo» Up

ClusterManagementListResult_Region_RuntimeRegionInfo

links (optional)
Links
result (optional)
ConfigurationResult«Region,RuntimeRegionInfo» array[EntityInfo_Region_RuntimeRegionInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementOperationResult_RebalanceResult

links (optional)
Links
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)
Links
result (optional)
array[ClusterManagementOperationResult«RebalanceResult»]
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)
Links
result (optional)
array[ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»]
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)
Links
result (optional)
array[ConfigurationResult«Member,MemberInformation»]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementListResult«Region,RuntimeRegionInfo» - 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
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)
Links
operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
result (optional)
RebalanceResult
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementResult - ClusterManagementResult Up

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

EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo

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

EntityGroupInfo_Index_IndexInfo

configuration (optional)
Index
runtimeInfo (optional)
array[IndexInfo]

EntityGroupInfo_Member_MemberInformation

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

EntityGroupInfo_Pdx_PdxInfo

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

EntityGroupInfo_Region_RuntimeRegionInfo

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

EntityInfo_Deployment_DeploymentInfo

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

EntityInfo_GatewayReceiver_GatewayReceiverInfo

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

EntityInfo_Index_IndexInfo

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

EntityInfo_Member_MemberInformation

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

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

configuration (optional)
GatewayReceiver
links (optional)
Links

EntityInfo_Pdx_PdxInfo

groups runtimeInfo (optional)
array[GatewayReceiverInfo]

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

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

EntityInfo_Region_RuntimeRegionInfo

groups runtimeInfo (optional)
array[RuntimeInfo]

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

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

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)
Links
runtimeInfo (optional)
array[RuntimeRegionInfo]
Expiration - Expiration Up
String
Enum:
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE

Expiration

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

GatewayReceiver

- GatewayReceiver Up

endPort (optional)
Integer format: int32
gatewayTransportFilters (optional)
array[ClassName]
group (optional)
String
manualStart (optional)
Boolean
maximumTimeBetweenPings (optional)
Integer format: int32
socketBufferSize (optional)
Integer format: int32
startPort (optional)
Integer format: int32

GatewayReceiverInfo

- GatewayReceiverInfo Up

bindAddress (optional)
String
connectedSenders (optional)
array[String]
hostnameForSenders (optional)
String
memberName (optional)
String
port (optional)
Integer format: int32
running (optional)
Boolean
senderCount (optional)
Integer format: int32

Index -

Index

Up

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

IndexInfo

memberName regionPath (optional)
String
Links - Up