THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Table of Contents | ||||
---|---|---|---|---|
|
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:
More information: http://geode.apache.org
Codegen:
brew install swagger-codegen; swagger-codegen generate -i http://locator:7070/management/v1/api-docs
More information: http://geode.apache.org
...
http://www.apache.org/licenses/
...
Deployment Management
POST
gateways
receivers
GET /management/v1/
gatewaysGET /management/v1/
deployments/
receiversdeployments/
create gateway-receiver
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
{id}
{id}
get deployed
Path parameters
Request Body Path Parameter -- id
Return type
Example data
Content-Type: application/json
GET /management/v1/gateways/receivers/{id}
GET /management/v1/gateways/receivers/{id}
get gateway-receiver
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"linksresult" : {
},
"statusMessagegroups" : "statusMessage",[ {
"statusCodeconfiguration" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Gateway receiver already exists.500
Internal error.{
"result" : {
"configuration" : {
{
"deployedTime" : "deployedTime",
"startPortdeployedBy" : 5"deployedBy",
"gatewayTransportFiltersjarFileName" : [ {"jarFileName",
"initPropertiesgroup" : {"group"
},
"keyruntimeInfo" : [ {
}
"jarLocation" : }"jarLocation",
"classNamememberName" : "classNamememberName",
}, {
"lastModified" : "lastModified"
"initProperties" :}, {
"jarLocation" : "keyjarLocation",
: { }
"memberName" : }"memberName",
"classNamelastModified" : "classNamelastModified"
} ]
}, {
"manualStartconfiguration" : true,{
"maximumTimeBetweenPingsdeployedTime" : 6"deployedTime",
"endPortdeployedBy" : 0"deployedBy",
"socketBufferSizejarFileName" : 1"jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSendersjarLocation" : [ "connectedSendersjarLocation",
"connectedSenders" ],
"runningmemberName" : true"memberName",
"portlastModified" : 5,"lastModified"
"hostnameForSenders" : "hostnameForSenders",
}, {
"memberNamejarLocation" : "memberNamejarLocation",
"bindAddressmemberName" : "bindAddressmemberName",
"senderCount" : 2
}, {
"connectedSenderslastModified" : [ "connectedSenders", "connectedSenders" ],"lastModified"
"running" : true,} ]
"port" : 5} ],
"hostnameForSendersid" : "hostnameForSendersid",
"memberName" : "memberName"},
"bindAddresslinks" : "bindAddress",
"senderCount{ "self" : 2
} ]
},
"links"uri" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Deployment_GatewayReceiverGatewayReceiverInfoDeploymentInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/
gateways/receiversGET /management/v1/
deployments
deployments
list gateway-receiversdeployed
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"configurationgroups" : [ {
"startPortconfiguration" : 5,{
"gatewayTransportFiltersdeployedTime" : [ {"deployedTime",
"initPropertiesdeployedBy" : {
"deployedBy",
"keyjarFileName" : { }
}"jarFileName",
"classNamegroup" : "classNamegroup"
}, {
"initPropertiesruntimeInfo" : [ {
"jarLocation" : "keyjarLocation",
: { }
"memberName" : }"memberName",
"classNamelastModified" : "classNamelastModified"
}, ],{
"manualStartjarLocation" : true"jarLocation",
"maximumTimeBetweenPingsmemberName" : 6"memberName",
"endPortlastModified" : 0,"lastModified"
"socketBufferSize" : 1,} ]
}, "group" : "group"
{
},
"runtimeInfoconfiguration" : [ {
"connectedSendersdeployedTime" : [ "connectedSendersdeployedTime",
"connectedSenders" ],
"runningdeployedBy" : true"deployedBy",
"portjarFileName" : 5"jarFileName",
"hostnameForSendersgroup" : "hostnameForSendersgroup",
"memberName" : "memberName"},
"bindAddressruntimeInfo" : "bindAddress",[ {
"senderCountjarLocation" : 2"jarLocation",
}, {
"connectedSendersmemberName" : [ "connectedSendersmemberName",
"connectedSenders" ],
"runninglastModified" : true,"lastModified"
"port" : 5,
}, {
"hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
"memberName" : "memberName",
"bindAddresslastModified" : "bindAddresslastModified",
"senderCount" : 2
} ]
} ]
}, {
"configurationid" : {"id"
}, {
"startPortgroups" : 5,[ {
"gatewayTransportFiltersconfiguration" : [ {
"initPropertiesdeployedTime" : {"deployedTime",
"deployedBy" : "keydeployedBy",
: { }
"jarFileName" : }"jarFileName",
"classNamegroup" : "classNamegroup"
}, {
"initPropertiesruntimeInfo" : [ {
"jarLocation" : "keyjarLocation",
: { }
"memberName" : }"memberName",
"classNamelastModified" : "classNamelastModified"
}, ],{
"manualStartjarLocation" : true"jarLocation",
"maximumTimeBetweenPingsmemberName" : 6"memberName",
"endPortlastModified" : 0,"lastModified"
"socketBufferSize" : 1,} ]
}, {
"groupconfiguration" : "group"{
},
"runtimeInfodeployedTime" : "deployedTime",
[ {
"connectedSendersdeployedBy" : [ "connectedSendersdeployedBy",
"connectedSenders" ],
"runningjarFileName" : true"jarFileName",
"port" : 5,
"hostnameForSendersgroup" : "hostnameForSendersgroup",
"memberName" : "memberName"},
"bindAddressruntimeInfo" : "bindAddress",[ {
"senderCountjarLocation" : 2"jarLocation",
}, {
"connectedSendersmemberName" : [ "connectedSendersmemberName",
"connectedSenders" ],
"runninglastModified" : true,"lastModified"
"port" : 5,
}, {
"hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
"memberName" : "memberName",
"bindAddresslastModified" : "bindAddresslastModified",
"senderCount" : 2} ]
} ],
} "id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Deployment_GatewayReceiverGatewayReceiverInfoDeploymentInfo401
Unauthorized403
Forbidden404
Not Found...
Versions
GET /management
/v1/members/{id}GET /management
get member
Path parameters
id (required)
get documentation-links
Path Parameter -- id Return type
Example data
Content-Type: application/json
{
"resultlatest" : {
"configuration" : {latest",
"idsupported" : [ "idsupported",
"groupsupported" ]
}
Responses
200
OK DocLinks401
Unauthorized403
Forbidden404
Not Found...
Gateway Management
POST /management/v1/gateways/receivers
POST /management/v1/gateways/receivers
create gateway-receiver
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Request Body
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Gateway receiver already exists.500
Internal error....
GET /management/v1/gateways/receivers/{id}
GET /management/v1/gateways/receivers/{id}
get gateway-receiver
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {: "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"hostconfiguration" : "host",{
"maxHeapSizestartPort" : 25,
"workingDirPathgatewayTransportFilters" : "workingDirPath",[ {
"idinitProperties" : "id",
{
"clientCountkey" : 5,{ }
"httpServicePort" : 7},
"cacheServerInfoclassName" : [ {"className"
"running" : true,
}, {
"portinitProperties" : 1,{
"maxThreadskey" : 6,{ }
"bindAddress" : "bindAddress"},
"maxConnectionsclassName" : 0"className"
} ], {
"runningmanualStart" : true,
"portmaximumTimeBetweenPings" : 16,
"maxThreadsendPort" : 60,
"bindAddresssocketBufferSize" : "bindAddress"1,
"maxConnectionsgroup" : 0"group"
} ],
"coordinatorruntimeInfo" : [ true,{
"groupsconnectedSenders" : [ "groupsconnectedSenders",
"serverBindAddress" : "serverBindAddress",
"connectedSenders" ],
"cacheXmlFilePathrunning" : "cacheXmlFilePath"true,
"locatorPortport" : 35,
"heapUsagehostnameForSenders" : 2"hostnameForSenders",
"initHeapSizememberName" : 9"memberName",
"logFilePathbindAddress" : "logFilePathbindAddress",
"offHeapMemorySizesenderCount" : "offHeapMemorySize",2
"secured" : true,
}, {
"statArchiveFilePathconnectedSenders" : [ "statArchiveFilePathconnectedSenders",
"statusconnectedSenders" : "status"],
}, {
"cpuUsagerunning" : 5.637376656633329true,
"serverport" : true5,
"httpServiceBindAddresshostnameForSenders" : "httpServiceBindAddresshostnameForSenders",
"memberName" : "memberName",
"locatorsbindAddress" : "locatorsbindAddress",
"processIdsenderCount" : 4,2
"webSSL" : true,} ]
}, "hostedRegions" : [ "hostedRegions", "hostedRegions" ],
{
"configuration" : {
"hoststartPort" : "host"5,
"maxHeapSizegatewayTransportFilters" : 2,
[ {
"workingDirPathinitProperties" : "workingDirPath",{
"id" : "id",
"clientCountkey" : 5,{ }
"httpServicePort" : 7},
"cacheServerInfoclassName" : [ {
"className"
"running" : true,
}, {
"portinitProperties" : 1,{
"maxThreadskey" : { 6,}
"bindAddress" : "bindAddress"},
"maxConnectionsclassName" : 0"className"
} ], {
"runningmanualStart" : true,
"portmaximumTimeBetweenPings" : 16,
"maxThreadsendPort" : 60,
"bindAddresssocketBufferSize" : "bindAddress"1,
"maxConnectionsgroup" : 0"group"
} ],
"coordinatorruntimeInfo" : [ true,{
"groupsconnectedSenders" : [ "groups""connectedSenders", "connectedSenders" ],
"serverBindAddressrunning" : "serverBindAddress"true,
"cacheXmlFilePathport" : "cacheXmlFilePath"5,
"locatorPorthostnameForSenders" : 3"hostnameForSenders",
"heapUsagememberName" : 2"memberName",
"initHeapSizebindAddress" : 9"bindAddress",
"logFilePathsenderCount" : "logFilePath", 2
}, {
"offHeapMemorySizeconnectedSenders" : [ "offHeapMemorySizeconnectedSenders", "connectedSenders" ],
"securedrunning" : true,
"statArchiveFilePathport" : "statArchiveFilePath"5,
"statushostnameForSenders" : "statushostnameForSenders",
} ]
},
"linksmemberName" : { }"memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_GatewayReceiver_MemberMemberInformationGatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/
membersGET /management/v1/
gateways/receivers
gateways/receivers
list membersgateway-receivers
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"configurationgroups" : [ {
"idconfiguration" : "id",{
"groupstartPort" : "group"5,
},
"runtimeInfogatewayTransportFilters" : [ {
"cpuUsageinitProperties" : 5.637376656633329,
{
"serverkey" : { true,}
"httpServiceBindAddress" : "httpServiceBindAddress"},
"memberNameclassName" : "memberNameclassName",
"locators" : "locators"}, {
"processIdinitProperties" : 4,{
"webSSL "key" : true,{ }
"hostedRegions" : [ "hostedRegions"},
"hostedRegions" ],
"hostclassName" : "hostclassName",
"maxHeapSize" :} 2],
"workingDirPathmanualStart" : "workingDirPath"true,
"idmaximumTimeBetweenPings" : "id"6,
"clientCountendPort" : 50,
"httpServicePortsocketBufferSize" : 71,
"cacheServerInfogroup" : [ {"group"
"running" : true},
"portruntimeInfo" : 1,[ {
"maxThreadsconnectedSenders" : 6,
"bindAddress" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
"maxConnectionsrunning" : 0
}, {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, ],{
"coordinatorconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
"groupsrunning" : "groups"true,
"serverBindAddressport" : "serverBindAddress"5,
"cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
"locatorPortmemberName" : 3"memberName",
"heapUsagebindAddress" : 2"bindAddress",
"initHeapSizesenderCount" : 9,2
} ]
"logFilePath" : "logFilePath"}, {
"offHeapMemorySizeconfiguration" : "offHeapMemorySize",{
"securedstartPort" : true5,
"statArchiveFilePathgatewayTransportFilters" : "statArchiveFilePath",
[ {
"statusinitProperties" : "status"{
}, {
"cpuUsagekey" : 5.637376656633329,
{ }
"server" : true},
"httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
"memberName" : "memberName"}, {
"locatorsinitProperties" : "locators",{
"processId" : 4,
"webSSLkey" : true,{ }
"hostedRegions" : [ "hostedRegions", "hostedRegions" ] },
"host" : "hostclassName",
: "maxHeapSizeclassName"
: 2,
"workingDirPath" : "workingDirPath"} ],
"idmanualStart" : "id"true,
"clientCountmaximumTimeBetweenPings" : 56,
"httpServicePortendPort" : 70,
"cacheServerInfosocketBufferSize" : [ {1,
"runninggroup" : true,"group"
"port" : 1},
"maxThreadsruntimeInfo" : 6,[ {
"bindAddressconnectedSenders" : [ "connectedSenders", "bindAddressconnectedSenders" ],
"maxConnectionsrunning" : 0
}, {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, ],{
"coordinatorconnectedSenders" : true,
"groups" : "groups"[ "connectedSenders", "connectedSenders" ],
"serverBindAddressrunning" : "serverBindAddress"true,
"cacheXmlFilePathport" : "cacheXmlFilePath"5,
"locatorPorthostnameForSenders" : 3"hostnameForSenders",
"heapUsagememberName" : 2"memberName",
"initHeapSize" : 9,
"logFilePathbindAddress" : "logFilePathbindAddress",
"offHeapMemorySizesenderCount" : "offHeapMemorySize",2
"secured" : true,} ]
"statArchiveFilePath" : "statArchiveFilePath"} ],
"statusid" : "statusid"
} ]
}, {
"configurationgroups" : [ {
"idconfiguration" : "id",{
"groupstartPort" : "group"5,
},
"runtimeInfogatewayTransportFilters" : [ {
"cpuUsageinitProperties" : 5.637376656633329,{
"server" : true,
"httpServiceBindAddresskey" : "httpServiceBindAddress",
{ }
"memberName" : "memberName"},
"locatorsclassName" : "locatorsclassName",
"processId" : 4}, {
"webSSLinitProperties" : true,{
"hostedRegions" : [ "hostedRegions", "hostedRegionskey" ],
: { }
"host" : "host",
},
"maxHeapSize" : 2,
"workingDirPathclassName" : "workingDirPathclassName",
"id" :} "id"],
"clientCountmanualStart" : 5true,
"httpServicePortmaximumTimeBetweenPings" : 76,
"cacheServerInfoendPort" : [ {0,
"runningsocketBufferSize" : true1,
"portgroup" : 1,"group"
},
"maxThreadsruntimeInfo" : [ 6,{
"bindAddressconnectedSenders" : [ "connectedSenders", "bindAddressconnectedSenders" ],
"maxConnectionsrunning" : 0
}, {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, ],{
"coordinatorconnectedSenders" : true[ "connectedSenders", "connectedSenders" ],
"groupsrunning" : "groups"true,
"serverBindAddressport" : "serverBindAddress"5,
"cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
"locatorPortmemberName" : 3"memberName",
"heapUsagebindAddress" : 2"bindAddress",
"initHeapSizesenderCount" : 9,2
"logFilePath" : "logFilePath",} ]
}, {
"offHeapMemorySizeconfiguration" : "offHeapMemorySize",{
"securedstartPort" : true5,
"statArchiveFilePathgatewayTransportFilters" : "statArchiveFilePath",[ {
"statusinitProperties" : "status"{
}, {
"cpuUsagekey" : 5.637376656633329,
{ }
"server" : true},
"httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
"memberName" : "memberName"}, {
"locatorsinitProperties" : "locators",{
"processId" : 4,
"webSSLkey" : true,{ }
"hostedRegions" : [ "hostedRegions"},
"hostedRegions" ],
"hostclassName" : "hostclassName",
"maxHeapSize" :} 2],
"workingDirPathmanualStart" : "workingDirPath"true,
"idmaximumTimeBetweenPings" : "id"6,
"clientCountendPort" : 50,
"httpServicePortsocketBufferSize" : 71,
"cacheServerInfogroup" : [ {"group"
"running" : true},
"portruntimeInfo" : 1,[ {
"maxThreadsconnectedSenders" : 6,
"bindAddress" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
"maxConnectionsrunning" : 0
}, {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, ],{
"coordinatorconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
"groupsrunning" : "groups"true,
"serverBindAddressport" : "serverBindAddress"5,
"cacheXmlFilePathhostnameForSenders" : "cacheXmlFilePathhostnameForSenders",
"locatorPortmemberName" : 3,
"heapUsagememberName" : 2,
"initHeapSize" : 9,
"logFilePathbindAddress" : "logFilePathbindAddress",
"offHeapMemorySizesenderCount" : "offHeapMemorySize",2
"secured" : true,} ]
"statArchiveFilePath" : "statArchiveFilePath"} ],
"statusid" : "statusid"
} ],
} ],
"links" : { "linksself" : {"uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_MemberMemberInformationGatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
Member Management
POST
configurations
pdx
GET /management/v1/
configurationsGET /management/v1/
members/
pdxmembers/
configure pdx
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
{id}
{id}
get member
Path parameters
Body Path Parameter -- pdxType id
Return type
Example data
Content-Type: application/json
GET /management/v1/operations/rebalances/{id}
GET /management/v1/operations/rebalances/{id}
check rebalance
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"linksgroups" : [ { },
"configuration" : {
"statusMessage "id" : "statusMessageid",
"statusCode "group" : "OKgroup"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Pdx already configured.500
Internal error.Ping
GET /management/v1/ping
GET /management/v1/ping
ping
Return type
String
Example data
Content-Type: application/json
""
Responses
200
OK String401
Unauthorized403
Forbidden404
Not FoundRebalance Operation
{
"result" : {
"rebalanceRegionResults" : [ {
,
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"bucketCreateTimeInMillisecondslocators" : 6"locators",
"primaryTransferTimeInMillisecondsprocessId" : 74,
"bucketCreatesCompletedwebSSL" : 1true,
"bucketTransfersCompletedhostedRegions" : 2,
"bucketCreateBytes" : 0[ "hostedRegions", "hostedRegions" ],
"regionNamehost" : "regionNamehost",
"bucketTransferTimeInMillisecondsmaxHeapSize" : 52,
"timeInMillisecondsworkingDirPath" : 3"workingDirPath",
"primaryTransfersCompletedid" : 9"id",
"bucketTransferBytesclientCount" : 5,
}, {
"bucketCreateTimeInMillisecondshttpServicePort" : 67,
"primaryTransferTimeInMillisecondscacheServerInfo" : 7,[ {
"bucketCreatesCompletedrunning" : 1true,
"bucketTransfersCompletedport" : 21,
"bucketCreateBytesmaxThreads" : 06,
"regionNamebindAddress" : "regionNamebindAddress",
"bucketTransferTimeInMillisecondsmaxConnections" : 5,0
"timeInMilliseconds" : 3}, {
"primaryTransfersCompleted" "running" : 9true,
"bucketTransferBytesport" : 51,
} ],
"statusMessagemaxThreads" : "statusMessage"
},
6,
"operationEndedbindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXbindAddress",
"operationStartmaxConnections" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links0
} ],
"coordinator" : { }true,
"operator "groups" : "operatorgroups",
"statusMessage "serverBindAddress" : "statusMessageserverBindAddress",
"statusCode "cacheXmlFilePath" : "OKcacheXmlFilePath"
}
Responses
200
OK ClusterManagementOperationStatusResult_RebalanceResult401
Unauthorized403
Forbidden404
Not FoundGET /management/v1/operations/rebalances
GET /management/v1/operations/rebalances
list rebalances
Return type
Example data
Content-Type: application/json
GET /management/v1/regions/{regionName}/indexes/{id}
GET /management/v1/regions/{regionName}/indexes/{id}
get index
Path parameters
id (required)
Path Parameter -- id
regionName (required)
Path Parameter -- regionName
Return type
Example data
Content-Type: application/json
{
"result" : [ {
,
"locatorPort" : 3,
"operationEndedheapUsage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"2,
"operationStartinitHeapSize" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
9,
"operationIdlogFilePath" : "operationIdlogFilePath",
"operatoroffHeapMemorySize" : "operatoroffHeapMemorySize",
"statusMessagesecured" : "statusMessage"true,
"statusCode" "statArchiveFilePath" : "OKstatArchiveFilePath",
}, {
"operationEndedstatus" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
status"
}, {
"operationStartcpuUsage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"5.637376656633329,
"operationIdserver" : "operationId"true,
"operatorhttpServiceBindAddress" : "operatorhttpServiceBindAddress",
"statusMessagememberName" : "statusMessagememberName",
"statusCodelocators" : "OKlocators",
} ],
"linksprocessId" : { }4,
"statusMessagewebSSL" : "statusMessage"true,
"statusCode "hostedRegions" : [ "OK"
}
Responses
200
OK ClusterManagementListOperationsResult_RebalanceResult401
Unauthorized403
Forbidden404
Not FoundPOST /management/v1/operations/rebalances
POST /management/v1/operations/rebalances
start rebalance
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- operation
Return type
Example data
Content-Type: application/json
{
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationResult_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not FoundRegion Management
POST /management/v1/regions
POST /management/v1/regions
create region
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- regionConfig
Return type
Example data
Content-Type: application/json
{
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Region already exists.500
Internal error.DELETE /management/v1/regions/{id}
DELETE /management/v1/regions/{id}
delete region
Path parameters
id (required)
Path Parameter -- id
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
{
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
ForbiddenGET /management/v1/regions/{id}
GET /management/v1/regions/{id}
get region
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"configuration" : {
"regionPath" : "regionPathhostedRegions", "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",
"expressionserverBindAddress" : "expressionserverBindAddress",
"keyIndexcacheXmlFilePath" : true"cacheXmlFilePath",
"namelocatorPort" : "name"3,
"groupheapUsage" : "group"2,
},
"runtimeInfoinitHeapSize" : [ {9,
"logFilePath" : "logFilePath",
"memberNameoffHeapMemorySize" : "memberNameoffHeapMemorySize",
"secured" : }, {
true,
"statArchiveFilePath" : "statArchiveFilePath",
"memberNamestatus" : "memberNamestatus"
} ]
}, {
"linksconfiguration" : { },
"statusMessageid" : "statusMessageid",
"statusCode "group" : "OKgroup"
}
Responses
200
OK ClusterManagementGetResult_IndexRuntimeInfo401
Unauthorized403
Forbidden404
Not Found{
"result" : {
"configuration" : {
,
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"expirationshttpServiceBindAddress" : [ {"httpServiceBindAddress",
"actionmemberName" : "DESTROYmemberName",
"typelocators" : "ENTRY_TIME_TO_LIVElocators",
"timeInSecondsprocessId" : 0
}, {4,
"actionwebSSL" : "DESTROY"true,
"typehostedRegions" : "ENTRY_TIME_TO_LIVE"[ "hostedRegions", "hostedRegions" ],
"timeInSecondshost" : 0
"host",
} ]"maxHeapSize" : 2,
"redundantCopiesworkingDirPath" : 6"workingDirPath",
"keyConstraintid" : "keyConstraintid",
"nameclientCount" : "name"5,
"valueConstrainthttpServicePort" : "valueConstraint"7,
"typecacheServerInfo" : "PARTITION", [ {
"diskStoreNamerunning" : "diskStoreName"true,
"groupport" : "group"
1,
},
"runtimeInfomaxThreads" : 6,
[ {
"entryCountbindAddress" : 1"bindAddress",
"memberNamemaxConnections" : "memberName"0
}, {
"entryCountrunning" : 1true,
"memberNameport" : "memberName"1,
} ]
},
"linksmaxThreads" : { }6,
"statusMessage" : "statusMessage",
"statusCodebindAddress" : "OK"
}
Responses
200
OK ClusterManagementGetResult_RegionRuntimeRegionInfo401
Unauthorized403
Forbidden404
Not FoundGET /management/v1/indexes
GET /management/v1/indexes
list indexes
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
bindAddress",
"configurationmaxConnections" : {0
"regionPath" :} "regionPath"],
"expressioncoordinator" : "expression"true,
"keyIndexgroups" : true"groups",
"nameserverBindAddress" : "nameserverBindAddress",
"groupcacheXmlFilePath" : "groupcacheXmlFilePath",
},
"runtimeInfolocatorPort" : 3,
[ {
"memberNameheapUsage" : "memberName"2,
}, {
"memberNameinitHeapSize" : "memberName"
} ]
}, {
9,
"configurationlogFilePath" : {
"logFilePath",
"regionPathoffHeapMemorySize" : "regionPathoffHeapMemorySize",
"expressionsecured" : "expression"true,
"keyIndexstatArchiveFilePath" : true"statArchiveFilePath",
"namestatus" : "name",
status"
}, {
"groupcpuUsage" : "group"5.637376656633329,
},
"runtimeInfoserver" : [ {
true,
"memberNamehttpServiceBindAddress" : "memberNamehttpServiceBindAddress",
}, {
"memberName" : "memberName",
} ]
} ],
"linkslocators" : { }"locators",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_IndexRuntimeInfo401
Unauthorized403
Forbidden404
Not FoundGET /management/v1/regions/{regionName}/indexes
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
Example data
Content-Type: application/json
GET /management/v1/regions
GET /management/v1/regions
list regions
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
processId" : 4,
"webSSL" : true,{
"result" : [ {
"configuration" : {
"regionPathhostedRegions" : [ "regionPath"hostedRegions", "hostedRegions" ],
"expressionhost" : "expressionhost",
"keyIndexmaxHeapSize" : true2,
"nameworkingDirPath" : "nameworkingDirPath",
"groupid" : "groupid",
},
"runtimeInfoclientCount" : [ {
5,
"memberNamehttpServicePort" : "memberName"7,
}, {
"memberNamecacheServerInfo" : [ "memberName"{
} ]
}, {
"configurationrunning" : {true,
"regionPathport" : "regionPath"1,
"expressionmaxThreads" : "expression"6,
"keyIndexbindAddress" : true"bindAddress",
"namemaxConnections" : "name",0
"group" : "group"
}, {
},
"runtimeInforunning" : [ {
true,
"memberNameport" : "memberName"1,
}, {
"memberNamemaxThreads" : "memberName"6,
} ]
} ],
"linksbindAddress" : { }"bindAddress",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_IndexRuntimeInfo401
Unauthorized403
Forbidden404
Not Found{
"result" : [ {
"configuration" : {
maxConnections" : 0
} ],
"expirationscoordinator" : [ {true,
"actiongroups" : "DESTROYgroups",
"typeserverBindAddress" : "ENTRY_TIME_TO_LIVEserverBindAddress",
"timeInSecondscacheXmlFilePath" : 0
}, {"cacheXmlFilePath",
"actionlocatorPort" : "DESTROY"3,
"typeheapUsage" : "ENTRY_TIME_TO_LIVE"2,
"timeInSecondsinitHeapSize" : 09,
} ],
"redundantCopieslogFilePath" : 6"logFilePath",
"keyConstraintoffHeapMemorySize" : "keyConstraintoffHeapMemorySize",
"namesecured" : "name"true,
"valueConstraintstatArchiveFilePath" : "valueConstraintstatArchiveFilePath",
"typestatus" : "PARTITIONstatus",
} "diskStoreName" : "diskStoreName"]
} ],
"groupid" : "groupid"
},
"runtimeInfolinks" : [ {
"self" : "uri" },
"entryCountstatusMessage" : 1"statusMessage",
"memberNamestatusCode" : "memberNameOK"
}, {
"entryCount" : 1,
"memberName" : "memberName"
} ]
}, {
}
Responses
200
OK ClusterManagementGetResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/members
GET /management/v1/members
list members
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"expirationsid" : [ {"id",
"actiongroup" : "DESTROYgroup",
},
"typeruntimeInfo" : "ENTRY_TIME_TO_LIVE", [ {
"timeInSecondscpuUsage" : 05.637376656633329,
"server" : }true, {
"actionhttpServiceBindAddress" : "DESTROYhttpServiceBindAddress",
"typememberName" : "ENTRY_TIME_TO_LIVEmemberName",
"timeInSecondslocators" : 0"locators",
} ],
"redundantCopiesprocessId" : 64,
"keyConstraintwebSSL" : "keyConstraint"true,
"namehostedRegions" : [ "hostedRegions", "namehostedRegions" ],
"valueConstrainthost" : "valueConstrainthost",
"typemaxHeapSize" : "PARTITION"2,
"diskStoreNameworkingDirPath" : "diskStoreNameworkingDirPath",
"groupid" : "groupid",
},
"runtimeInfoclientCount" : [ {
5,
"entryCounthttpServicePort" : 17,
"memberNamecacheServerInfo" : [ {
"memberName"
"running" : true,
}, {
"port" : 1,
"entryCountmaxThreads" : 16,
"memberNamebindAddress" : "memberNamebindAddress",
"maxConnections" : 0
}, ]
} ],
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_RegionRuntimeRegionInfo401
Unauthorized403
Forbidden404
Not FoundModels
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]
{
"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_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
Pdx Management
POST /management/v1/configurations/pdx
POST /management/v1/configurations/pdx
configure pdx
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- pdxType
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Pdx already configured.500
Internal error....
GET /management/v1/configurations/pdx
GET /management/v1/configurations/pdx
get pdx
Return type
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_PdxInfo401
Unauthorized403
Forbidden404
Not Found...
Ping
GET /management/v1/ping
GET /management/v1/ping
ping
Return type
String
Example data
Content-Type: application/json
""
Responses
200
OK String401
Unauthorized403
Forbidden404
Not Found...
Rebalance Operation
GET /management/v1/operations/rebalances/{id}
GET /management/v1/operations/rebalances/{id}
check rebalance
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"rebalanceRegionResults" : [ {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 7,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5
}, {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 7,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5
} ],
"success" : true,
"statusMessage" : "statusMessage"
},
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links" : { "self" : "uri" },
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationStatusResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/operations/rebalances
GET /management/v1/operations/rebalances
list rebalances
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}, {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListOperationsResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
POST /management/v1/operations/rebalances
POST /management/v1/operations/rebalances
start rebalance
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- operation
Return type
Example data
Content-Type: application/json
{
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationResult_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not Found...
Region Management
POST /management/v1/regions/{regionName}/indexes
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 Content-Type request header:application/json
Request body
Body Parameter -- indexConfig
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Index already exists.500
Internal error....
POST /management/v1/indexes
POST /management/v1/indexes
create index
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- indexConfig
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Index already exists.500
Internal error....
POST /management/v1/regions
POST /management/v1/regions
create region
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- regionConfig
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Region already exists.500
Internal error....
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
delete region index
Path parameters
indexName (required)
Path Parameter -- indexName
regionName (required)
Path Parameter -- regionName
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
DELETE /management/v1/regions/{id}
DELETE /management/v1/regions/{id}
delete region
Path parameters
id (required)
Path Parameter -- id
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
GET /management/v1/regions/{regionName}/indexes/{id}
GET /management/v1/regions/{regionName}/indexes/{id}
get index
Path parameters
id (required)
Path Parameter -- id
regionName (required)
Path Parameter -- regionName
Return type
Example data
Content-Type: application/json
{
"result" : {
"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_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{id}
GET /management/v1/regions/{id}
get region
Path parameters
id (required)
Path Parameter -- id
Return type
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_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/indexes
GET /management/v1/indexes
list indexes
Query parameters
id (optional)
Query Parameter -- id
Return type
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_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{regionName}/indexes
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
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_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions
GET /management/v1/regions
list regions
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
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_RuntimeRegionInfo401
Unauthorized403
Forbidden404
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)
result (optional)
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)
result (optional)
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)
result (optional)
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)
result (optional)
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)
result (optional)
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)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListOperationsResult_RebalanceResult
links (optional)
result (optional)
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
ClusterManagementGetResult_GatewayReceiverGatewayReceiverInfo
links (optional)
result (optional)
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_
IndexRuntimeInfoGatewayReceiverInfo
links (optional)
result (optional)
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
MemberMemberInformation
ClusterManagementGetResult
ClusterManagementListResult_Index_
MemberMemberInformationIndexInfo
links (optional)
result (optional)
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_
RegionRuntimeRegionInfoMemberInformation
links (optional)
result (optional)
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
ClusterManagementListResult
ClusterManagementListResult_Region_
RebalanceResultRuntimeRegionInfo
links (optional)
result (optional)
array[ClusterManagementOperationResultEntityInfo_Region_RebalanceResultRuntimeRegionInfo]
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_
GatewayReceiverGatewayReceiverInfoRebalanceResult
links (optional)
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 result (optional)
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
IndexRuntimeInfo
ClusterManagementOperationStatusResult_
IndexRuntimeInfoRebalanceResult
links (optional)
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)
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_MemberMemberInformation
ClusterManagementResult
links (optional)
result (optional)
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_RegionRuntimeRegionInfo
Deployment
links deployedBy (optional)
result deployedTime (optional)
String
group statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
jarFileName (optional)
String
DeploymentInfo
jarLocation statusMessage (optional)
String
ClusterManagementOperationResult_RebalanceResult
links lastModified (optional)
operationEnded memberName (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
DocLinks
latest operationId (optional)
String
operationStart supported (optional)
array[String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
]
EntityGroupInfo_GatewayReceiver_GatewayReceiverInfo
configuration
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
runtimeInfo (optional)
EntityInfo_Deployment_DeploymentInfo
ClusterManagementOperationStatusResult_RebalanceResult
links (optional)
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 links (optional)
EntityInfo_GatewayReceiver_GatewayReceiverInfo
groups statusCode (optional)
id (optional)
String
links (optional)
EntityInfo_Index_IndexInfo
groups (optional)
id
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementResult
links (optional)
EntityInfo_Member_MemberInformation
groups statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
id (optional)
String
links (optional)
EntityInfo_Region_RuntimeRegionInfo
groups runtimeInfo (optional)
array[GatewayReceiverInfoEntityGroupInfo_Region_RuntimeRegionInfo]
ConfigurationResult_IndexRuntimeInfo
Eviction
runtimeInfo action (optional)
ConfigurationResult_MemberMemberInformation
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount configuration (optional)
Integer format: int32
memorySizeMb links (optional)
Integer format: int32
objectSizer runtimeInfo (optional)
ConfigurationResult_RegionRuntimeRegionInfo
type configuration (optional)
links (optional)
runtimeInfo (optional)
array[RuntimeRegionInfo] 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)
group (optional)
String
manualStart (optional)
Boolean
maximumTimeBetweenPings (optional)
Integer format: int32
socketBufferSize (optional)
Integer format: int32
startPort (optional)
Integer format: int32
GatewayReceiverInfo
bindAddress (optional)
String
connectedSenders (optional)
array[String]
hostnameForSenders (optional)
String
memberName (optional)
String
port (optional)
Integer format: int32
running (optional)
Boolean
senderCount (optional)
Integer format: int32
Index
expression (optional)
String
group indexType (optional)
String
Enum:
KEY
RANGE
HASH_DEPRECATED
name keyIndex (optional)
Boolean String
name regionPath (optional)
String
IndexInfo
memberName regionPath (optional)
String
Member
group (optional)
String
id (optional)
String
MemberInformation
cacheServerInfo (optional)
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)
diskStoreName (optional)
String
ignoreUnreadFields (optional)
Boolean
pdxSerializer (optional)
readSerialized (optional)
Boolean
PdxInfo
diskStoreName (optional)
String
ignoreUnreadFields persistent (optional)
Boolean
memberName (optional)
String
pdxSerializer (optional)
String
readSerialized (optional)
Boolean
RebalanceOperation
excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
simulate (optional)
Boolean
RebalanceRegionResult
bucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64
RebalanceResult
rebalanceRegionResults (optional)
statusMessage (optional)
String
success (optional)
Boolean
Region
diskStoreName (optional)
String
eviction (optional)
expirations (optional)
group (optional)
String
keyConstraint (optional)
String
name (optional)
String
redundantCopies (optional)
Integer format: int32
type (optional)
String
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
valueConstraint (optional)
String
RuntimeInfo
memberName (optional)
String
RuntimeRegionInfo
entryCount (optional)
Long format: int64
memberName (optional)
String