You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Apache Geode Management REST API

REST API and interface to manage Geode components.
More information: http://geode.apache.org
Contact Info: dev@geode.apache.org
Version: v2
BasePath:/management/experimental/api-docs
Apache License, version 2.0
http://www.apache.org/licenses/

Access

Methods

[ Jump to Models ]

Table of Contents

GatewayManagementController

MemberManagementController

PdxManagementController

PingManagementController

RebalanceOperationController

RegionManagementController

GatewayManagementController

Up
post /experimental/gateways/receivers
create gateway-receiver (createGatewayReceiverUsingPOST)

Consumes

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

Request body

body GatewayReceiver (required)
Body Parameter — gatewayReceiverConfig

Return type

ClusterManagementResult

Example data

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

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.
Up
get /experimental/gateways/receivers/{id}
get gateway-receiver (getGatewayReceiverUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

Example data

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

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/gateways/receivers
list gateway-receivers (listGatewayReceiversUsingGET)

Query parameters

group (optional)
Query Parameter — group

Return type

ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»

Example data

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

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»

401

Unauthorized

403

Forbidden

404

Not Found

MemberManagementController

Up
get /experimental/members/{id}
get member (getMemberUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementGetResult«Member,MemberInformation»

Example data

Content-Type: application/json
{
{
"result" : {"result" : {
"configuration" : {"configuration" : {
"id" : "id","id" : "id",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,"cpuUsage" : 5.637376656633329,
"server" : true,"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress","httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName","memberName" : "memberName",
"locators" : "locators","locators" : "locators",
"processId" : 4,"processId" : 4,
"webSSL" : true,"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host","host" : "host",
"maxHeapSize" : 2,"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath","workingDirPath" : "workingDirPath",
"id" : "id","id" : "id",
"clientCount" : 5,"clientCount" : 5,
"httpServicePort" : 7,"httpServicePort" : 7,
"cacheServerInfo" : [ {"cacheServerInfo" : [ {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
}, {}, {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
} ],} ],
"coordinator" : true,"coordinator" : true,
"groups" : "groups","groups" : "groups",
"serverBindAddress" : "serverBindAddress","serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath","cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,"locatorPort" : 3,
"heapUsage" : 2,"heapUsage" : 2,
"initHeapSize" : 9,"initHeapSize" : 9,
"logFilePath" : "logFilePath","logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize","offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath","statArchiveFilePath" : "statArchiveFilePath",
"status" : "status""status" : "status"
}, {}, {
"cpuUsage" : 5.637376656633329,"cpuUsage" : 5.637376656633329,
"server" : true,"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress","httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName","memberName" : "memberName",
"locators" : "locators","locators" : "locators",
"processId" : 4,"processId" : 4,
"webSSL" : true,"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host","host" : "host",
"maxHeapSize" : 2,"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath","workingDirPath" : "workingDirPath",
"id" : "id","id" : "id",
"clientCount" : 5,"clientCount" : 5,
"httpServicePort" : 7,"httpServicePort" : 7,
"cacheServerInfo" : [ {"cacheServerInfo" : [ {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
}, {}, {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
} ],} ],
"coordinator" : true,"coordinator" : true,
"groups" : "groups","groups" : "groups",
"serverBindAddress" : "serverBindAddress","serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath","cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,"locatorPort" : 3,
"heapUsage" : 2,"heapUsage" : 2,
"initHeapSize" : 9,"initHeapSize" : 9,
"logFilePath" : "logFilePath","logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize","offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath","statArchiveFilePath" : "statArchiveFilePath",
"status" : "status""status" : "status"
} ]} ]
},},
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementGetResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/members
list members (listMembersUsingGET)

Query parameters

group (optional)
Query Parameter — group
id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«Member,MemberInformation»

Example data

Content-Type: application/json
{
{
"result" : [ {"result" : [ {
"configuration" : {"configuration" : {
"id" : "id","id" : "id",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,"cpuUsage" : 5.637376656633329,
"server" : true,"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress","httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName","memberName" : "memberName",
"locators" : "locators","locators" : "locators",
"processId" : 4,"processId" : 4,
"webSSL" : true,"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host","host" : "host",
"maxHeapSize" : 2,"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath","workingDirPath" : "workingDirPath",
"id" : "id","id" : "id",
"clientCount" : 5,"clientCount" : 5,
"httpServicePort" : 7,"httpServicePort" : 7,
"cacheServerInfo" : [ {"cacheServerInfo" : [ {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
}, {}, {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
} ],} ],
"coordinator" : true,"coordinator" : true,
"groups" : "groups","groups" : "groups",
"serverBindAddress" : "serverBindAddress","serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath","cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,"locatorPort" : 3,
"heapUsage" : 2,"heapUsage" : 2,
"initHeapSize" : 9,"initHeapSize" : 9,
"logFilePath" : "logFilePath","logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize","offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath","statArchiveFilePath" : "statArchiveFilePath",
"status" : "status""status" : "status"
}, {}, {
"cpuUsage" : 5.637376656633329,"cpuUsage" : 5.637376656633329,
"server" : true,"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress","httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName","memberName" : "memberName",
"locators" : "locators","locators" : "locators",
"processId" : 4,"processId" : 4,
"webSSL" : true,"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host","host" : "host",
"maxHeapSize" : 2,"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath","workingDirPath" : "workingDirPath",
"id" : "id","id" : "id",
"clientCount" : 5,"clientCount" : 5,
"httpServicePort" : 7,"httpServicePort" : 7,
"cacheServerInfo" : [ {"cacheServerInfo" : [ {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
}, {}, {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
} ],} ],
"coordinator" : true,"coordinator" : true,
"groups" : "groups","groups" : "groups",
"serverBindAddress" : "serverBindAddress","serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath","cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,"locatorPort" : 3,
"heapUsage" : 2,"heapUsage" : 2,
"initHeapSize" : 9,"initHeapSize" : 9,
"logFilePath" : "logFilePath","logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize","offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath","statArchiveFilePath" : "statArchiveFilePath",
"status" : "status""status" : "status"
} ]} ]
}, {}, {
"configuration" : {"configuration" : {
"id" : "id","id" : "id",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,"cpuUsage" : 5.637376656633329,
"server" : true,"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress","httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName","memberName" : "memberName",
"locators" : "locators","locators" : "locators",
"processId" : 4,"processId" : 4,
"webSSL" : true,"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host","host" : "host",
"maxHeapSize" : 2,"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath","workingDirPath" : "workingDirPath",
"id" : "id","id" : "id",
"clientCount" : 5,"clientCount" : 5,
"httpServicePort" : 7,"httpServicePort" : 7,
"cacheServerInfo" : [ {"cacheServerInfo" : [ {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
}, {}, {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
} ],} ],
"coordinator" : true,"coordinator" : true,
"groups" : "groups","groups" : "groups",
"serverBindAddress" : "serverBindAddress","serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath","cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,"locatorPort" : 3,
"heapUsage" : 2,"heapUsage" : 2,
"initHeapSize" : 9,"initHeapSize" : 9,
"logFilePath" : "logFilePath","logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize","offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath","statArchiveFilePath" : "statArchiveFilePath",
"status" : "status""status" : "status"
}, {}, {
"cpuUsage" : 5.637376656633329,"cpuUsage" : 5.637376656633329,
"server" : true,"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress","httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName","memberName" : "memberName",
"locators" : "locators","locators" : "locators",
"processId" : 4,"processId" : 4,
"webSSL" : true,"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host","host" : "host",
"maxHeapSize" : 2,"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath","workingDirPath" : "workingDirPath",
"id" : "id","id" : "id",
"clientCount" : 5,"clientCount" : 5,
"httpServicePort" : 7,"httpServicePort" : 7,
"cacheServerInfo" : [ {"cacheServerInfo" : [ {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
}, {}, {
"running" : true,"running" : true,
"port" : 1,"port" : 1,
"maxThreads" : 6,"maxThreads" : 6,
"bindAddress" : "bindAddress","bindAddress" : "bindAddress",
"maxConnections" : 0"maxConnections" : 0
} ],} ],
"coordinator" : true,"coordinator" : true,
"groups" : "groups","groups" : "groups",
"serverBindAddress" : "serverBindAddress","serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath","cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,"locatorPort" : 3,
"heapUsage" : 2,"heapUsage" : 2,
"initHeapSize" : 9,"initHeapSize" : 9,
"logFilePath" : "logFilePath","logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize","offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath","statArchiveFilePath" : "statArchiveFilePath",
"status" : "status""status" : "status"
} ]} ]
} ],} ],
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementListResult«Member,MemberInformation»

401

Unauthorized

403

Forbidden

404

Not Found

PdxManagementController

Up
post /experimental/configurations/pdx
configure pdx (configurePdxUsingPOST)

Consumes

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

Request body

body Pdx (required)
Body Parameter — pdxType

Return type

ClusterManagementResult

Example data

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

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

PingManagementController

Up
get /experimental/ping
ping (pingUsingGET)

Return type

String

Example data

Content-Type: application/json
""
""

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKString

401

Unauthorized

403

Forbidden

404

Not Found

RebalanceOperationController

Up
get /experimental/operations/rebalances/{id}
check rebalance (checkRebalanceStatusUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementOperationStatusResult«RebalanceResult»

Example data

Content-Type: application/json
{
{
"result" : {"result" : {
"rebalanceRegionResults" : [ {"rebalanceRegionResults" : [ {
"bucketCreateTimeInMilliseconds" : 6,"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 7,"primaryTransferTimeInMilliseconds" : 7,
"bucketCreatesCompleted" : 1,"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,"bucketTransfersCompleted" : 2,
"bucketCreateBytes" : 0,"bucketCreateBytes" : 0,
"regionName" : "regionName","regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 3,"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5"bucketTransferBytes" : 5
}, {}, {
"bucketCreateTimeInMilliseconds" : 6,"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 7,"primaryTransferTimeInMilliseconds" : 7,
"bucketCreatesCompleted" : 1,"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,"bucketTransfersCompleted" : 2,
"bucketCreateBytes" : 0,"bucketCreateBytes" : 0,
"regionName" : "regionName","regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 3,"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5"bucketTransferBytes" : 5
} ],} ],
"statusMessage" : "statusMessage""statusMessage" : "statusMessage"
},},
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links" : { },"links" : { },
"operator" : "operator","operator" : "operator",
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementOperationStatusResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/operations/rebalances
list rebalances (listRebalancesUsingGET)

Return type

ClusterManagementListOperationsResult«RebalanceResult»

Example data

Content-Type: application/json
{
{
"result" : [ {"result" : [ {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId","operationId" : "operationId",
"operator" : "operator","operator" : "operator",
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}, {}, {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId","operationId" : "operationId",
"operator" : "operator","operator" : "operator",
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
} ],} ],
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementListOperationsResult«RebalanceResult»

401

Unauthorized

403

Forbidden

404

Not Found
Up
post /experimental/operations/rebalances
start rebalance (startRebalanceUsingPOST)

Consumes

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

Request body

body RebalanceOperation (required)
Body Parameter — operation

Return type

ClusterManagementOperationResult«RebalanceResult»

Example data

Content-Type: application/json
{
{
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX","operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId","operationId" : "operationId",
"operator" : "operator","operator" : "operator",
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementOperationResult«RebalanceResult»

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

RegionManagementController

Up
post /experimental/regions
create region (createRegionUsingPOST)

Consumes

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

Request body

body Region (required)
Body Parameter — regionConfig

Return type

ClusterManagementResult

Example data

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

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.
Up
delete /experimental/regions/{id}
delete region (deleteRegionUsingDELETE)

Path parameters

id (required)
Path Parameter — id

Query parameters

group (optional)
Query Parameter — group

Return type

ClusterManagementResult

Example data

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

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden
Up
get /experimental/regions/{regionName}/indexes/{id}
get index (getIndexUsingGET)

Path parameters

id (required)
Path Parameter — id
regionName (required)
Path Parameter — regionName

Return type

ClusterManagementGetResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{
{
"result" : {"result" : {
"configuration" : {"configuration" : {
"regionPath" : "regionPath","regionPath" : "regionPath",
"expression" : "expression","expression" : "expression",
"keyIndex" : true,"keyIndex" : true,
"name" : "name","name" : "name",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
},},
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementGetResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/regions/{id}
get region (getRegionUsingGET)

Path parameters

id (required)
Path Parameter — id

Return type

ClusterManagementGetResult«Region,RuntimeRegionInfo»

Example data

Content-Type: application/json
{
{
"result" : {"result" : {
"configuration" : {"configuration" : {
"expirations" : [ {"expirations" : [ {
"action" : "DESTROY","action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE","type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0"timeInSeconds" : 0
}, {}, {
"action" : "DESTROY","action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE","type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0"timeInSeconds" : 0
} ],} ],
"redundantCopies" : 6,"redundantCopies" : 6,
"keyConstraint" : "keyConstraint","keyConstraint" : "keyConstraint",
"name" : "name","name" : "name",
"valueConstraint" : "valueConstraint","valueConstraint" : "valueConstraint",
"type" : "PARTITION","type" : "PARTITION",
"diskStoreName" : "diskStoreName","diskStoreName" : "diskStoreName",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"entryCount" : 1,"entryCount" : 1,
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"entryCount" : 1,"entryCount" : 1,
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
},},
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementGetResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/indexes
list indexes (listAllIndexUsingGET)

Query parameters

id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{
{
"result" : [ {"result" : [ {
"configuration" : {"configuration" : {
"regionPath" : "regionPath","regionPath" : "regionPath",
"expression" : "expression","expression" : "expression",
"keyIndex" : true,"keyIndex" : true,
"name" : "name","name" : "name",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
}, {}, {
"configuration" : {"configuration" : {
"regionPath" : "regionPath","regionPath" : "regionPath",
"expression" : "expression","expression" : "expression",
"keyIndex" : true,"keyIndex" : true,
"name" : "name","name" : "name",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
} ],} ],
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/regions/{regionName}/indexes
list region indexes (listIndexUsingGET)

Path parameters

regionName (required)
Path Parameter — regionName

Query parameters

id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«Index,RuntimeInfo»

Example data

Content-Type: application/json
{
{
"result" : [ {"result" : [ {
"configuration" : {"configuration" : {
"regionPath" : "regionPath","regionPath" : "regionPath",
"expression" : "expression","expression" : "expression",
"keyIndex" : true,"keyIndex" : true,
"name" : "name","name" : "name",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
}, {}, {
"configuration" : {"configuration" : {
"regionPath" : "regionPath","regionPath" : "regionPath",
"expression" : "expression","expression" : "expression",
"keyIndex" : true,"keyIndex" : true,
"name" : "name","name" : "name",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
} ],} ],
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementListResult«Index,RuntimeInfo»

401

Unauthorized

403

Forbidden

404

Not Found
Up
get /experimental/regions
list regions (listRegionUsingGET)

Query parameters

group (optional)
Query Parameter — group
id (optional)
Query Parameter — id

Return type

ClusterManagementListResult«Region,RuntimeRegionInfo»

Example data

Content-Type: application/json
{
{
"result" : [ {"result" : [ {
"configuration" : {"configuration" : {
"expirations" : [ {"expirations" : [ {
"action" : "DESTROY","action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE","type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0"timeInSeconds" : 0
}, {}, {
"action" : "DESTROY","action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE","type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0"timeInSeconds" : 0
} ],} ],
"redundantCopies" : 6,"redundantCopies" : 6,
"keyConstraint" : "keyConstraint","keyConstraint" : "keyConstraint",
"name" : "name","name" : "name",
"valueConstraint" : "valueConstraint","valueConstraint" : "valueConstraint",
"type" : "PARTITION","type" : "PARTITION",
"diskStoreName" : "diskStoreName","diskStoreName" : "diskStoreName",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"entryCount" : 1,"entryCount" : 1,
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"entryCount" : 1,"entryCount" : 1,
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
}, {}, {
"configuration" : {"configuration" : {
"expirations" : [ {"expirations" : [ {
"action" : "DESTROY","action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE","type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0"timeInSeconds" : 0
}, {}, {
"action" : "DESTROY","action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE","type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0"timeInSeconds" : 0
} ],} ],
"redundantCopies" : 6,"redundantCopies" : 6,
"keyConstraint" : "keyConstraint","keyConstraint" : "keyConstraint",
"name" : "name","name" : "name",
"valueConstraint" : "valueConstraint","valueConstraint" : "valueConstraint",
"type" : "PARTITION","type" : "PARTITION",
"diskStoreName" : "diskStoreName","diskStoreName" : "diskStoreName",
"group" : "group""group" : "group"
},},
"runtimeInfo" : [ {"runtimeInfo" : [ {
"entryCount" : 1,"entryCount" : 1,
"memberName" : "memberName""memberName" : "memberName"
}, {}, {
"entryCount" : 1,"entryCount" : 1,
"memberName" : "memberName""memberName" : "memberName"
} ]} ]
} ],} ],
"links" : { },"links" : { },
"statusMessage" : "statusMessage","statusMessage" : "statusMessage",
"statusCode" : "OK""statusCode" : "OK"
}
}

Produces

This API call produces the following media types according to the Accept request header;the media type will be conveyed by the Content-Type response header.
  • */*
  • */*

Responses

200

OKClusterManagementListResult«Region,RuntimeRegionInfo»

401

Unauthorized

403

Forbidden

404

Not Found

Models

[ Jump to Methods ]

Table of Contents

  1. CacheServerInfo - CacheServerInfo
  2. CacheServerInfo - CacheServerInfo

  3. ClassName - ClassName
  4. ClassName - ClassName

  5. ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
  6. ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»

  7. ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo»
  8. ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo»

  9. ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation»
  10. ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation»

  11. ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo»
  12. ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo»

  13. ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult»
  14. ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult»

  15. ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»
  16. ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»

  17. ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo»
  18. ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo»

  19. ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation»
  20. ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation»

  21. ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo»
  22. ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo»

  23. ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult»
  24. ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult»

  25. ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult»
  26. ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult»

  27. ClusterManagementResult - ClusterManagementResult
  28. ClusterManagementResult - ClusterManagementResult

  29. ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
  30. ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» - ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»

  31. ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo»
  32. ConfigurationResult«Index,RuntimeInfo» - ConfigurationResult«Index,RuntimeInfo»

  33. ConfigurationResult«Member,MemberInformation» - ConfigurationResult«Member,MemberInformation»
  34. ConfigurationResult«Member,MemberInformation» - ConfigurationResult«Member,MemberInformation»

  35. ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo»
  36. ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo»

  37. Expiration - Expiration
  38. Expiration - Expiration

  39. GatewayReceiver - GatewayReceiver
  40. GatewayReceiver - GatewayReceiver

  41. GatewayReceiverInfo - GatewayReceiverInfo
  42. GatewayReceiverInfo - GatewayReceiverInfo

  43. Index - Index
  44. Index - Index

  45. Links - Links
  46. Links - Links

  47. Member - Member
  48. Member - Member

  49. MemberInformation - MemberInformation
  50. MemberInformation - MemberInformation

  51. Pdx - Pdx
  52. Pdx - Pdx

  53. RebalanceOperation - RebalanceOperation
  54. RebalanceOperation - RebalanceOperation

  55. RebalanceRegionResult - RebalanceRegionResult
  56. RebalanceRegionResult - RebalanceRegionResult

  57. RebalanceResult - RebalanceResult
  58. RebalanceResult - RebalanceResult

  59. Region - Region
  60. Region - Region

  61. RuntimeInfo - RuntimeInfo
  62. RuntimeInfo - RuntimeInfo

  63. RuntimeRegionInfo - RuntimeRegionInfo
  64. RuntimeRegionInfo - RuntimeRegionInfo

CacheServerInfo - CacheServerInfo Up

CacheServerInfo - CacheServerInfo Up


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

ClassName - ClassName Up

ClassName - ClassName Up


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

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» Up

ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» Up


links (optional)
Links
result (optional)
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» Up

ClusterManagementGetResult«Index,RuntimeInfo» - ClusterManagementGetResult«Index,RuntimeInfo» Up


links (optional)
Links
result (optional)
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» Up

ClusterManagementGetResult«Member,MemberInformation» - ClusterManagementGetResult«Member,MemberInformation» Up


links (optional)
Links
result (optional)
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» Up

ClusterManagementGetResult«Region,RuntimeRegionInfo» - ClusterManagementGetResult«Region,RuntimeRegionInfo» Up


links (optional)
Links
result (optional)
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» Up

ClusterManagementListOperationsResult«RebalanceResult» - ClusterManagementListOperationsResult«RebalanceResult» Up


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

ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» Up

ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» - ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» Up


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

ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo» Up

ClusterManagementListResult«Index,RuntimeInfo» - ClusterManagementListResult«Index,RuntimeInfo» Up


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

ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation» Up

ClusterManagementListResult«Member,MemberInformation» - ClusterManagementListResult«Member,MemberInformation» Up


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

ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo» Up

ClusterManagementListResult«Region,RuntimeRegionInfo» - ClusterManagementListResult«Region,RuntimeRegionInfo» Up


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

ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult» Up

ClusterManagementOperationResult«RebalanceResult» - ClusterManagementOperationResult«RebalanceResult» Up


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» Up

ClusterManagementOperationStatusResult«RebalanceResult» - ClusterManagementOperationStatusResult«RebalanceResult» Up


links (optional)
Links
operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
result (optional)
RebalanceResult
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementResult - ClusterManagementResult Up

ClusterManagementResult - ClusterManagementResult Up


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

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

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


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

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

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


configuration (optional)
Index
links (optional)
Links
runtimeInfo (optional)
array[RuntimeInfo]

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

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


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

ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo» Up

ConfigurationResult«Region,RuntimeRegionInfo» - ConfigurationResult«Region,RuntimeRegionInfo» Up


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

Expiration - Expiration Up

Expiration - Expiration Up


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

GatewayReceiver - GatewayReceiver Up

GatewayReceiver - GatewayReceiver Up


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

GatewayReceiverInfo - GatewayReceiverInfo Up

GatewayReceiverInfo - GatewayReceiverInfo Up


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

Index - Index Up

Index - Index Up


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

Member - Member Up

Member - Member Up


group (optional)
String
id (optional)
String

MemberInformation - MemberInformation Up

MemberInformation - MemberInformation Up


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 - Pdx Up

Pdx - Pdx Up


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

RebalanceOperation - RebalanceOperation Up

RebalanceOperation - RebalanceOperation Up


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

RebalanceRegionResult - RebalanceRegionResult Up

RebalanceRegionResult - RebalanceRegionResult Up


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 - RebalanceResult Up

RebalanceResult - RebalanceResult Up


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

Region - Region Up

Region - Region Up


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 - RuntimeInfo Up

RuntimeInfo - RuntimeInfo Up


memberName (optional)
String

RuntimeRegionInfo - RuntimeRegionInfo Up

RuntimeRegionInfo - RuntimeRegionInfo Up


entryCount (optional)
Long format: int64
memberName (optional)
String
  • No labels