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

Contact Info: user@geode.apache.org

Version: v1

Apache License, version 2.0

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

Deployment Management

PUT /management/v1/deployments

deploy

Consumes

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

multipart/form-data

Query parameters

config (optional)

Query Parameter -- deployment json configuration

Form parameters

file (required)

Form Parameter -- format: binary

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

500

Internal error.

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" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "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" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      }, {
        "jarLocation" : "jarLocation",
        "memberName" : "memberName",
        "lastModified" : "lastModified"
      } ]
    }, {
      "configuration" : {
        "fileName" : "fileName",
        "deployedTime" : "deployedTime",
        "deployedBy" : "deployedBy",
        "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

DiskStoreController

POST /management/v1/diskstores

create disk-store

Consumes

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

application/json

Request body

body DiskStore (required)

Body Parameter -- diskStoreConfig

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

Diskstore already exists.

500

Internal error.

DELETE /management/v1/diskstores/{id}

delete disk-store

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/diskstores/{id}

get disk-store

Path parameters

id (required)

Path Parameter -- id

Return type

ClusterManagementGetResult_DiskStore_DiskStoreInfo

Example data

Content-Type: application/json

{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "diskUsageCriticalPercentage" : 1.4658129,
        "queueSize" : 2,
        "allowForceCompaction" : true,
        "diskUsageWarningPercentage" : 5.962134,
        "maxOplogSizeInBytes" : 5,
        "name" : "name",
        "autoCompact" : true,
        "directories" : [ {
          "dirSize" : 6,
          "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 7,
        "writeBufferSize" : 9,
        "compactionThreshold" : 0,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "diskUsageCriticalPercentage" : 1.4658129,
        "queueSize" : 2,
        "allowForceCompaction" : true,
        "diskUsageWarningPercentage" : 5.962134,
        "maxOplogSizeInBytes" : 5,
        "name" : "name",
        "autoCompact" : true,
        "directories" : [ {
          "dirSize" : 6,
          "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 7,
        "writeBufferSize" : 9,
        "compactionThreshold" : 0,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_DiskStore_DiskStoreInfo

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/diskstores

list disk-stores

Query parameters

group (optional)

Query Parameter -- group

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult_DiskStore_DiskStoreInfo

Example data

Content-Type: application/json

{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "diskUsageCriticalPercentage" : 1.4658129,
        "queueSize" : 2,
        "allowForceCompaction" : true,
        "diskUsageWarningPercentage" : 5.962134,
        "maxOplogSizeInBytes" : 5,
        "name" : "name",
        "autoCompact" : true,
        "directories" : [ {
          "dirSize" : 6,
          "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 7,
        "writeBufferSize" : 9,
        "compactionThreshold" : 0,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "diskUsageCriticalPercentage" : 1.4658129,
        "queueSize" : 2,
        "allowForceCompaction" : true,
        "diskUsageWarningPercentage" : 5.962134,
        "maxOplogSizeInBytes" : 5,
        "name" : "name",
        "autoCompact" : true,
        "directories" : [ {
          "dirSize" : 6,
          "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 7,
        "writeBufferSize" : 9,
        "compactionThreshold" : 0,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "diskUsageCriticalPercentage" : 1.4658129,
        "queueSize" : 2,
        "allowForceCompaction" : true,
        "diskUsageWarningPercentage" : 5.962134,
        "maxOplogSizeInBytes" : 5,
        "name" : "name",
        "autoCompact" : true,
        "directories" : [ {
          "dirSize" : 6,
          "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 7,
        "writeBufferSize" : 9,
        "compactionThreshold" : 0,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "diskUsageCriticalPercentage" : 1.4658129,
        "queueSize" : 2,
        "allowForceCompaction" : true,
        "diskUsageWarningPercentage" : 5.962134,
        "maxOplogSizeInBytes" : 5,
        "name" : "name",
        "autoCompact" : true,
        "directories" : [ {
          "dirSize" : 6,
          "name" : "name"
        }, {
          "dirSize" : 6,
          "name" : "name"
        } ],
        "timeInterval" : 7,
        "writeBufferSize" : 9,
        "compactionThreshold" : 0,
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_DiskStore_DiskStoreInfo

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

application/json

Request body

body Pdx (required)

Body Parameter -- pdxType

Return type

ClusterManagementResult

Example data

Content-Type: application/json

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

GET /management/v1/configurations/pdx

get pdx

Return type

ClusterManagementGetResult_Pdx_PdxInfo

Example data

Content-Type: application/json

{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "autoSerializer" : {
          "patterns" : [ "patterns", "patterns" ],
          "portable" : true
        },
        "readSerialized" : true,
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        }
      },
      "runtimeInfo" : [ {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      }, {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      } ]
    }, {
      "configuration" : {
        "autoSerializer" : {
          "patterns" : [ "patterns", "patterns" ],
          "portable" : true
        },
        "readSerialized" : true,
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : {
          "initProperties" : {
            "key" : { }
          },
          "className" : "className"
        }
      },
      "runtimeInfo" : [ {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      }, {
        "readSerialized" : true,
        "memberName" : "memberName",
        "diskStoreName" : "diskStoreName",
        "ignoreUnreadFields" : true,
        "pdxSerializer" : "pdxSerializer"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Pdx_PdxInfo

401

Unauthorized

403

Forbidden

404

Not Found

Ping

GET /management/v1/ping

ping

Return type

String

Example data

Content-Type: application/json

""

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

Rebalance Operation

GET /management/v1/operations/rebalances/{id}

get rebalance

Path parameters

id (required)

Path Parameter -- id

Return type

ClusterManagementOperationResult_RebalanceOperation_RebalanceResult

Example data

Content-Type: application/json

{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "simulate" : true,
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    }, {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    } ],
    "success" : true,
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationResult_RebalanceOperation_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/operations/rebalances

list rebalances

Return type

ClusterManagementListOperationsResult_RebalanceOperation_RebalanceResult

Example data

Content-Type: application/json

{
  "result" : [ {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "simulate" : true,
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "rebalanceRegionResults" : [ {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      }, {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      } ],
      "success" : true,
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  }, {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "simulate" : true,
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "rebalanceRegionResults" : [ {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      }, {
        "bucketCreateTimeInMilliseconds" : 6,
        "primaryTransferTimeInMilliseconds" : 9,
        "bucketCreatesCompleted" : 1,
        "bucketTransfersCompleted" : 2,
        "numOfMembers" : 7,
        "bucketCreateBytes" : 0,
        "regionName" : "regionName",
        "bucketTransferTimeInMilliseconds" : 5,
        "timeInMilliseconds" : 2,
        "primaryTransfersCompleted" : 3,
        "bucketTransferBytes" : 5
      } ],
      "success" : true,
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListOperationsResult_RebalanceOperation_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

POST /management/v1/operations/rebalances

start rebalance

Consumes

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

application/json

Request body

body RebalanceOperation (required)

Body Parameter -- operation

Return type

ClusterManagementOperationResult_RebalanceOperation_RebalanceResult

Example data

Content-Type: application/json

{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "simulate" : true,
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "rebalanceRegionResults" : [ {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    }, {
      "bucketCreateTimeInMilliseconds" : 6,
      "primaryTransferTimeInMilliseconds" : 9,
      "bucketCreatesCompleted" : 1,
      "bucketTransfersCompleted" : 2,
      "numOfMembers" : 7,
      "bucketCreateBytes" : 0,
      "regionName" : "regionName",
      "bucketTransferTimeInMilliseconds" : 5,
      "timeInMilliseconds" : 2,
      "primaryTransfersCompleted" : 3,
      "bucketTransferBytes" : 5
    } ],
    "success" : true,
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationResult_RebalanceOperation_RebalanceResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Region Management

POST /management/v1/regions/{regionName}/indexes

create region index

Path parameters

regionName (required)

Path Parameter -- regionName

Consumes

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

application/json

Request body

body Index (required)

Body Parameter -- indexConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Index already exists.

500

Internal error.

POST /management/v1/indexes

create index

Consumes

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

application/json

Request body

body Region (required)

Body Parameter -- regionConfig

Return type

ClusterManagementResult

Example data

Content-Type: application/json

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

DELETE /management/v1/regions/{regionName}/indexes/{indexName}

delete region index

Path parameters

indexName (required)

Path Parameter -- indexName

regionName (required)

Path Parameter -- regionName

Return type

ClusterManagementResult

Example data

Content-Type: application/json

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

DELETE /management/v1/regions/{id}

delete region

Path parameters

id (required)

Path Parameter -- id

Query parameters

group (optional)

Query Parameter -- group

Return type

ClusterManagementResult

Example data

Content-Type: application/json

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

GET /management/v1/regions/{regionName}/indexes/{id}

get index

Path parameters

id (required)

Path Parameter -- id

regionName (required)

Path Parameter -- regionName

Return type

ClusterManagementGetResult_Index_IndexInfo

Example data

Content-Type: application/json

{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/regions/{id}

get region

Path parameters

id (required)

Path Parameter -- id

Return type

ClusterManagementGetResult_Region_RuntimeRegionInfo

Example data

Content-Type: application/json

{
  "result" : {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  },
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/indexes

list indexes

Query parameters

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult_Index_IndexInfo

Example data

Content-Type: application/json

{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/regions/{regionName}/indexes

list region indexes

Path parameters

regionName (required)

Path Parameter -- regionName

Query parameters

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult_Index_IndexInfo

Example data

Content-Type: application/json

{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "regionPath" : "regionPath",
        "indexType" : "KEY",
        "expression" : "expression",
        "name" : "name"
      },
      "runtimeInfo" : [ {
        "memberName" : "memberName"
      }, {
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/regions

list regions

Query parameters

group (optional)

Query Parameter -- group

id (optional)

Query Parameter -- id

Return type

ClusterManagementListResult_Region_RuntimeRegionInfo

Example data

Content-Type: application/json

{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

RestoreRedundancy Operation

GET /management/v1/operations/restoreRedundancy/{id}

get restore-redundancy

Path parameters

id (required)

Path Parameter -- id

Return type

ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

Example data

Content-Type: application/json

{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "reassignPrimaries" : true,
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "regionResults" : {
      "key" : {
        "configuredRedundancy" : 6,
        "regionName" : "regionName",
        "actualRedundancy" : 0,
        "status" : "SATISFIED"
      }
    },
    "underRedundancyRegionResults" : { },
    "zeroRedundancyRegionResults" : { },
    "totalPrimaryTransferTime" : 1,
    "totalPrimaryTransfersCompleted" : 5,
    "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
    "success" : true,
    "satisfiedRedundancyRegionResults" : { },
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/operations/restoreRedundancy

list restore-redundancy

Return type

ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults

Example data

Content-Type: application/json

{
  "result" : [ {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "reassignPrimaries" : true,
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "regionResults" : {
        "key" : {
          "configuredRedundancy" : 6,
          "regionName" : "regionName",
          "actualRedundancy" : 0,
          "status" : "SATISFIED"
        }
      },
      "underRedundancyRegionResults" : { },
      "zeroRedundancyRegionResults" : { },
      "totalPrimaryTransferTime" : 1,
      "totalPrimaryTransfersCompleted" : 5,
      "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
      "success" : true,
      "satisfiedRedundancyRegionResults" : { },
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  }, {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "reassignPrimaries" : true,
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "regionResults" : {
        "key" : {
          "configuredRedundancy" : 6,
          "regionName" : "regionName",
          "actualRedundancy" : 0,
          "status" : "SATISFIED"
        }
      },
      "underRedundancyRegionResults" : { },
      "zeroRedundancyRegionResults" : { },
      "totalPrimaryTransferTime" : 1,
      "totalPrimaryTransfersCompleted" : 5,
      "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
      "success" : true,
      "satisfiedRedundancyRegionResults" : { },
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults

401

Unauthorized

403

Forbidden

404

Not Found

POST /management/v1/operations/restoreRedundancy

start restore-redundancy

Consumes

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

application/json

Request body

body RestoreRedundancyRequest (required)

Body Parameter -- operation

Return type

ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

Example data

Content-Type: application/json

{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "reassignPrimaries" : true,
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "regionResults" : {
      "key" : {
        "configuredRedundancy" : 6,
        "regionName" : "regionName",
        "actualRedundancy" : 0,
        "status" : "SATISFIED"
      }
    },
    "underRedundancyRegionResults" : { },
    "zeroRedundancyRegionResults" : { },
    "totalPrimaryTransferTime" : 1,
    "totalPrimaryTransfersCompleted" : 5,
    "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
    "success" : true,
    "satisfiedRedundancyRegionResults" : { },
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Models

`AutoSerializer`

portable (optional)

Boolean

patterns (optional)

array[String]

`CacheServerInfo`

bindAddress (optional)

String

maxConnections (optional)

Integer format: int32

maxThreads (optional)

Integer format: int32

port (optional)

Integer format: int32

running (optional)

Boolean

`ClassName`

className (optional)

String

initProperties (optional)

map[String, Object]

`ClusterManagementGetResult_Deployment_DeploymentInfo`

links (optional)

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

links (optional)

Links

result (optional)

EntityInfo_DiskStore_DiskStoreInfo

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

links (optional)

Links

result (optional)

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

`ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults`

links (optional)

Links

result (optional)

array[ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults]

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

links (optional)

Links

result (optional)

array[EntityInfo_DiskStore_DiskStoreInfo]

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

`ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo`

links (optional)

Links

result (optional)

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

`ClusterManagementListResult_Index_IndexInfo`

links (optional)

Links

result (optional)

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

`ClusterManagementListResult_Member_MemberInformation`

links (optional)

Links

result (optional)

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

`ClusterManagementListResult_Region_RuntimeRegionInfo`

links (optional)

Links

result (optional)

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

links (optional)

Links

operation (optional)

RebalanceOperation

operationEnd (optional)

String

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

operationId (optional)

String

operationResult (optional)

RebalanceResult

operationStart (optional)

String

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

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

throwable (optional)

Throwable

`ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults`

links (optional)

Links

operation (optional)

RestoreRedundancyRequest

operationEnd (optional)

String

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

operationId (optional)

String

operationResult (optional)

RestoreRedundancyResults

operationStart (optional)

String

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

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

throwable (optional)

Throwable

`ClusterManagementResult`

links (optional)

Links

statusCode (optional)

String

Enum:

OK

ILLEGAL_ARGUMENT

UNAUTHENTICATED

UNAUTHORIZED

ENTITY_EXISTS

ENTITY_NOT_FOUND

ERROR

FAIL_TO_PERSIST

ACCEPTED

IN_PROGRESS

statusMessage (optional)

String

`Deployment`

deployedBy (optional)

String

deployedTime (optional)

String

fileName (optional)

String

group (optional)

String

`DeploymentInfo`

jarLocation (optional)

String

lastModified (optional)

String

memberName (optional)

String

`DiskDir`

dirSize (optional)

Integer format: int32

name (optional)

String

`DiskStore`

allowForceCompaction (optional)

Boolean

autoCompact (optional)

Boolean

compactionThreshold (optional)

Integer format: int32

directories (optional)

array[DiskDir]

diskUsageCriticalPercentage (optional)

Float format: float

diskUsageWarningPercentage (optional)

Float format: float

group (optional)

String

maxOplogSizeInBytes (optional)

Long format: int64

name (optional)

String

queueSize (optional)

Integer format: int32

timeInterval (optional)

Long format: int64

writeBufferSize (optional)

action (optional)

String

Enum:

LOCAL_DESTROY

OVERFLOW_TO_DISK

entryCount (optional)

Integer format: int32

memorySizeMb (optional)

Integer format: int32

objectSizer (optional)

ClassName

type (optional)

String

Enum:

ENTRY_COUNT

MEMORY_SIZE

HEAP_PERCENTAGE

`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

indexType (optional)

String

Enum:

KEY

RANGE

HASH_DEPRECATED

name (optional)

String

regionPath (optional)

String

`IndexInfo`

memberName (optional)

String

`Links`

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

autoSerializer (optional)

AutoSerializer

diskStoreName (optional)

String

ignoreUnreadFields (optional)

Boolean

pdxSerializer (optional)

ClassName

readSerialized (optional)

Boolean

`PdxInfo`

diskStoreName (optional)

String

ignoreUnreadFields (optional)

Boolean

memberName (optional)

String

pdxSerializer (optional)

String

readSerialized (optional)

Boolean

`RebalanceOperation`

excludeRegions (optional)

array[String]

includeRegions (optional)

array[String]

operator (optional)

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

numOfMembers (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

success (optional)

Boolean

`Region`

diskStoreName (optional)

String

eviction (optional)

Eviction

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

`RegionRedundancyStatus`

actualRedundancy (optional)

Integer format: int32

configuredRedundancy (optional)

Integer format: int32

regionName (optional)

String

status (optional)

String

Enum:

SATISFIED

NOT_SATISFIED

NO_REDUNDANT_COPIES

`RestoreRedundancyRequest`

excludeRegions (optional)

array[String]

includeRegions (optional)

array[String]

operator (optional)

String

reassignPrimaries (optional)

Boolean

`RestoreRedundancyResults`

includedRegionsWithNoMembers (optional)

array[String]

regionResults (optional)

map[String, RegionRedundancyStatus]

satisfiedRedundancyRegionResults (optional)

map[String, RegionRedundancyStatus]

statusMessage (optional)

String

success (optional)

Boolean

totalPrimaryTransferTime (optional)

Long format: int64

totalPrimaryTransfersCompleted (optional)

file

byte[] filePath format: binary

Space shortcuts

Page tree

1.15.0 Management REST API - v1

Apache Geode Management REST API

Deployment Management

PUT /management/v1/deployments

Consumes

Query parameters

Form parameters

Return type

Example data

Responses

200

201

400

401

403

404

500

GET /management/v1/deployments/{id}

Path parameters

Return type

Example data

Responses

200

401

403

404

GET /management/v1/deployments

Query parameters

Return type

Example data

Responses

200

401

403

404

DiskStoreController

POST /management/v1/diskstores

Consumes

Request body

Return type

Example data

Responses

200

201

400

401

403

404

409

500

DELETE /management/v1/diskstores/{id}

Path parameters

Query parameters

Return type

Example data

Responses

200

204

401

403

GET /management/v1/diskstores/{id}

Path parameters

Return type

Example data

Responses

200

401

403

404

GET /management/v1/diskstores

Query parameters

Return type

Example data

Responses

200

401

403

404

`PUT /management/v1/deployments`

`GET /management/v1/deployments/{id}`

`GET /management/v1/deployments`

`POST /management/v1/diskstores`

`DELETE /management/v1/diskstores/{id}`

`GET /management/v1/diskstores/{id}`

`GET /management/v1/diskstores`

`GET /management`

`POST /management/v1/gateways/receivers`

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

`GET /management/v1/gateways/receivers`

`GET /management/v1/members/{id}`

`GET /management/v1/members`

`POST /management/v1/configurations/pdx`