Versions Compared

Old Version 50

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version 51

changes.mady.by.user Owen Nichols

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: automatically generated from develop 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.

...

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

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

Responses

200

OK ClusterManagementGetResult$GatewayReceiver$GatewayReceiverInfo 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 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 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 ClusterManagementGetResult_Member_MemberInformation

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 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 ClusterManagementListResult_Member_MemberInformation

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 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" : { },
  "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.

...

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 ClusterManagementOperationStatusResult_RebalanceResult

Example data

Content-Type: application/json
{
  "result" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 7,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 3,
      "primaryTransfersCompleted" : 9,
      "bucketTransferBytes" : 5
    }, {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 7,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 3,
      "primaryTransfersCompleted" : 9,
      "bucketTransferBytes" : 5
    } ],
    "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 ClusterManagementOperationStatusResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/operations/rebalances

list rebalances

Return type

ClusterManagementListOperationsResult$RebalanceResult 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 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 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 ClusterManagementOperationResult_RebalanceResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Region Management

POST /management/v1/regions

create region

Consumes

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

Request body

body Region (required)
Body Parameter -- regionConfig

Return type

ClusterManagementResult

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

...

DELETE /management/v1/regions/{id}

delete region

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

ClusterManagementResult

Example data

Content-Type: application/json
{
  "links" : { },
  "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$RuntimeInfo ClusterManagementGetResult_Index_RuntimeInfo

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 ClusterManagementGetResult_Index_RuntimeInfo

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

Responses

200

OK ClusterManagementGetResult$Region$RuntimeRegionInfo ClusterManagementGetResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/indexes

list indexes

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult$Index$RuntimeInfo ClusterManagementListResult_Index_RuntimeInfo

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 ClusterManagementListResult_Index_RuntimeInfo

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$RuntimeInfo
ClusterManagementListResult_Index_RuntimeInfo

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 ClusterManagementListResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions

list regions

Query parameters

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

Return type

ClusterManagementListResult$Region$RuntimeRegionInfo 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 ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Models

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$GatewayReceiver$GatewayReceiverInfo

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

links (optional)
Links
result (optional)
ConfigurationResult$GatewayReceiver$GatewayReceiverInfo ConfigurationResult_GatewayReceiver_GatewayReceiverInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult$Index$RuntimeInfo

ClusterManagementGetResult_Index_RuntimeInfo

links (optional)
Links
result (optional)
ConfigurationResult$Index$RuntimeInfo ConfigurationResult_Index_RuntimeInfo
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

links (optional)
Links
result (optional)
ConfigurationResult$Member$MemberInformation 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
ClusterManagementGetResult$Region$RuntimeRegionInfo

ClusterManagementGetResult_Region_RuntimeRegionInfo

links (optional)
Links
result (optional)
ConfigurationResult$Region$RuntimeRegionInfo ConfigurationResult_Region_RuntimeRegionInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListOperationsResult$RebalanceResult

ClusterManagementListOperationsResult_RebalanceResult

links (optional)
Links
result (optional)
array[ClusterManagementOperationResult$RebalanceResultClusterManagementOperationResult_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$GatewayReceiver$GatewayReceiverInfo

ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

links (optional)
Links
result (optional)
array[ConfigurationResult$GatewayReceiver$GatewayReceiverInfoConfigurationResult_GatewayReceiver_GatewayReceiverInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListResult$Index$RuntimeInfo

ClusterManagementListResult_Index_RuntimeInfo

links (optional)
Links
result (optional)
array[ConfigurationResult$Index$RuntimeInfoConfigurationResult_Index_RuntimeInfo]
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

links (optional)
Links
result (optional)
array[ConfigurationResult$Member$MemberInformationConfigurationResult_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

links (optional)
Links
result (optional)
array[ConfigurationResult$Region$RuntimeRegionInfoConfigurationResult_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

ClusterManagementOperationResult_RebalanceResult

links (optional)
Links
operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
statusCode (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

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

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
ConfigurationResult$GatewayReceiver$GatewayReceiverInfo

ConfigurationResult_GatewayReceiver_GatewayReceiverInfo

configuration (optional)
GatewayReceiver
links (optional)
Links
runtimeInfo (optional)
array[GatewayReceiverInfo]
ConfigurationResult$Index$RuntimeInfo

ConfigurationResult_Index_RuntimeInfo

configuration (optional)
Index
links (optional)
Links
runtimeInfo (optional)
array[RuntimeInfo]
ConfigurationResult$Member$MemberInformation

ConfigurationResult_Member_MemberInformation

configuration (optional)
Member
links (optional)
Links
runtimeInfo (optional)
array[MemberInformation]
ConfigurationResult$Region$RuntimeRegionInfo

ConfigurationResult_Region_RuntimeRegionInfo

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

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

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

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

expression (optional)
String
group (optional)
String
keyIndex (optional)
Boolean
name (optional)
String
regionPath (optional)
String

Member

group (optional)
String
id (optional)
String

MemberInformation

cacheServerInfo (optional)
array[CacheServerInfo]
cacheXmlFilePath (optional)
String
clientCount (optional)
Integer format: int32
coordinator (optional)
Boolean
cpuUsage (optional)
Double format: double
groups (optional)
String
heapUsage (optional)
Long format: int64
host (optional)
String
hostedRegions (optional)
array[String]
httpServiceBindAddress (optional)
String
httpServicePort (optional)
Integer format: int32
id (optional)
String
initHeapSize (optional)
Long format: int64
locatorPort (optional)
Integer format: int32
locators (optional)
String
logFilePath (optional)
String
maxHeapSize (optional)
Long format: int64
memberName (optional)
String
offHeapMemorySize (optional)
String
processId (optional)
Integer format: int32
secured (optional)
Boolean
server (optional)
Boolean
serverBindAddress (optional)
String
statArchiveFilePath (optional)
String
status (optional)
String
webSSL (optional)
Boolean
workingDirPath (optional)
String

Pdx

diskStoreName (optional)
String
ignoreUnreadFields (optional)
Boolean
pdxSerializer (optional)
ClassName
persistent (optional)
Boolean
readSerialized (optional)
Boolean

RebalanceOperation

excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
simulate (optional)
Boolean

RebalanceRegionResult

bucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64

RebalanceResult

rebalanceRegionResults (optional)
array[RebalanceRegionResult]
statusMessage (optional)
String

Region

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

RuntimeInfo

memberName (optional)
String

RuntimeRegionInfo

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