Page History

Example data

Content-Type: application/json

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

Responses

200

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.

...

ANCHOR ="getGatewayReceiverUsingGET"

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

get /v1/gateways/receivers/{id}

get gateway-receiver

Path parameters

id (required)

Path Parameter -- id

Return type

Example data

Content-Type: application/json

{
  "result" : {
    "configuration" : {
      "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
    } ]
  },
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found ANCHOR ="listGatewayReceiversUsingGET"

...

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" : [ {
    "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
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

Member Management

ANCHOR ="getMemberUsingGET"

ClusterManagementGetResult«Member,MemberInformation»

get /v1/members/{id}

get member

Path parameters

id (required)

Path Parameter -- id

Return type

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
      }, {
        "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"
    } ]
  },
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found

...

ANCHOR ="listMembersUsingGET"

ClusterManagementListResult«Member,MemberInformation»

get /v1/members

list members

Query parameters

group (optional)

Query Parameter -- group

id (optional)

Query Parameter -- id

Return type

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
      }, {
        "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"
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found

...

Pdx Management

ANCHOR ="configurePdxUsingPOST"

post /v1/configurations/pdx

configure pdx

Consumes

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

application/json

Request body

body Pdx (required)

Body Parameter -- pdxType

Return type

Example data

Content-Type: application/json

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

Responses

200

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

...

Ping

ANCHOR ="pingUsingGET"

ClusterManagementOperationStatusResult«RebalanceResult»

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

...

Up

get /v1/operations/rebalances/{id}

check rebalance

Path parameters

id (required)

Path Parameter -- id

Return type

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
    } ],
    "statusMessage" : "statusMessage"
  },
  "operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "links" : { },
  "operator" : "operator",
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationStatusResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found ANCHOR ="listRebalancesUsingGET"

...

Up

get /v1/operations/rebalances

list rebalances

Return type

ClusterManagementListOperationsResult«RebalanceResult»

Example data

Content-Type: application/json

{
  "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" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListOperationsResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found

...

ANCHOR ="startRebalanceUsingPOST"

ClusterManagementOperationResult«RebalanceResult»

post /v1/operations/rebalances

start rebalance

Consumes

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

application/json

Request body

body RebalanceOperation (required)

Body Parameter -- operation

Return type

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

application/json

Request body

body Region (required)

Body Parameter -- regionConfig

Return type

Example data

Content-Type: application/json

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

Responses

200

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

...

ANCHOR ="deleteRegionUsingDELETE"

delete /v1/regions/{id}

delete region

Path parameters

id (required)

Path Parameter -- id

Query parameters

group (optional)

Query Parameter -- group

Return type

Example data

Content-Type: application/json

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

Responses

200

204

No Content

401

Unauthorized

403

Forbidden

...

ANCHOR ="getIndexUsingGET"

ClusterManagementGetResult«Index,RuntimeInfo»

get /v1/regions/{regionName}/indexes/{id}

get index

Path parameters

id (required)

Path Parameter -- id

regionName (required)

Path Parameter -- regionName

Return type

Example data

Content-Type: application/json

{
  "result" : {
    "configuration" : {
      "regionPath" : "regionPath",
      "expression" : "expression",
      "keyIndex" : true,
      "name" : "name",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  },
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

ANCHOR ="getRegionUsingGET"

ClusterManagementGetResult«Region,RuntimeRegionInfo»

get /v1/regions/{id}

get region

Path parameters

id (required)

Path Parameter -- id

Return type

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"
    } ]
  },
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

ANCHOR ="listAllIndexUsingGET"

ClusterManagementListResult«Index,RuntimeInfo»

get /v1/indexes

list indexes

Query parameters

id (optional)

Query Parameter -- id

Return type

Example data

Content-Type: application/json

{
  "result" : [ {
    "configuration" : {
      "regionPath" : "regionPath",
      "expression" : "expression",
      "keyIndex" : true,
      "name" : "name",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  }, {
    "configuration" : {
      "regionPath" : "regionPath",
      "expression" : "expression",
      "keyIndex" : true,
      "name" : "name",
      "group" : "group"
    },
    "runtimeInfo" : [ {
      "memberName" : "memberName"
    }, {
      "memberName" : "memberName"
    } ]
  } ],
  "links" : { },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found

...

ANCHOR ="listIndexUsingGET"