DUE TO SPAM, SIGN-UP IS DISABLED. Goto Selfserve wiki signup and request an account.
| Table of Contents | ||||
|---|---|---|---|---|
|
Apache Geode Management REST API
REST API to manage Geode. This is experimental. All request/response formats are subject to change.
...
http://www.apache.org/licenses/
Deployment Management
PUT /management/v1/deployments
PUT /management/v1/deploymentsdeploy
Consumes
This API call consumes the following media types via the Content-Type request header:multipart/form-data
Query parameters
config (optional)
Query Parameter -- deployment json configuration
Form parameters
file (required)
Form Parameter -- format: binary
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 Found500
Internal error....
GET /management/v1/deployments/{id}
GET /management/v1/deployments/{id}get deployed
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {
"configuration" : {
"fileName" : "fileName",
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
}, {
"configuration" : {
"fileName" : "fileName",
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_Deployment_DeploymentInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/deployments
GET /management/v1/deploymentslist deployed
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"fileName" : "fileName",
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
}, {
"configuration" : {
"fileName" : "fileName",
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"fileName" : "fileName",
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
}, {
"configuration" : {
"fileName" : "fileName",
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
}, {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
"lastModified" : "lastModified"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementListResult_Deployment_DeploymentInfo401
Unauthorized403
Forbidden404
Not FoundVersions
GET /management
GET /managementget documentation-links
Return type
Example data
Content-Type: application/json
{
"latest" : "latest",
"supported" : [ "supported", "supported" ]
}Responses
200
OK DocLinks401
Unauthorized403
Forbidden404
Not FoundGateway Management
...
DiskStoreController
POST /management/v1/
gateways/receiversPOST /management/v1/diskstores
diskstorescreate gatewaydisk-receiverstore
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Request Body Parameter -- diskStoreConfig
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 Diskstore already exists.500
Internal error. GET...
DELETE /management/v1/
gateways/receiversDELETE /management/v1/diskstores/{id}
diskstores/{id}get gatewaydelete disk-receiverstore
Path parameters
id (required)
Path Parameter -- id
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
{
"resultlinks" : {
"groupsself" : [ {
"uri" },
"configurationstatusMessage" : {
"startPortstatusMessage" : 5,
"gatewayTransportFilters"statusCode" : "OK"
}Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
GET /management/v1/diskstores/{id}
GET /management/v1/diskstores/{id}get disk-store
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
[ {
"result" : {
"initPropertiesgroups" : [ {
"key"configuration" : { }
"diskUsageCriticalPercentage" : }1.4658129,
"classNamequeueSize" : "className"
}, {
2,
"initPropertiesallowForceCompaction" : {true,
"keydiskUsageWarningPercentage" : { }5.962134,
"maxOplogSizeInBytes" : }5,
"classNamename" : "classNamename",
} ]"autoCompact" : true,
"manualStartdirectories" : [ true,{
"maximumTimeBetweenPingsdirSize" : 6,
"endPortname" : 0,"name"
"socketBufferSize" : 1,
}, {
"groupdirSize" : "group"6,
},
"runtimeInfoname" : [ {"name"
"connectedSenders" : [ "connectedSenders", "connectedSenders"} ],
"runningtimeInterval" : true7,
"portwriteBufferSize" : 59,
"hostnameForSenderscompactionThreshold" : "hostnameForSenders"0,
"memberNamegroup" : "memberNamegroup",
},
"bindAddressruntimeInfo" : "bindAddress", [ {
"senderCountmemberName" : 2"memberName"
}, {
"connectedSendersmemberName" : [ "connectedSendersmemberName",
"connectedSenders" ],
} ]
"running" :}, true,{
"portconfiguration" : 5,{
"hostnameForSendersdiskUsageCriticalPercentage" : "hostnameForSenders"1.4658129,
"memberNamequeueSize" : "memberName"2,
"bindAddressallowForceCompaction" : "bindAddress"true,
"senderCountdiskUsageWarningPercentage" : 25.962134,
} ]
"maxOplogSizeInBytes" : 5,
}, {
"configurationname" : {"name",
"startPortautoCompact" : 5true,
"gatewayTransportFiltersdirectories" : [ {
"initPropertiesdirSize" : {6,
"keyname" : { }
},
"className" : "className"name"
}, {
"initPropertiesdirSize" : {
"key" : { }
}6,
"classNamename" : "classNamename"
} ],
"manualStarttimeInterval" : true7,
"maximumTimeBetweenPingswriteBufferSize" : 69,
"endPortcompactionThreshold" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSendersmemberName" : [ "connectedSenders", "connectedSenders" ],memberName"
}, {
"runningmemberName" : true,"memberName"
} ]
"port" :} 5],
"hostnameForSendersid" : "hostnameForSendersid",
},
"links" : { "memberNameself" : "memberNameuri" },
"bindAddressstatusMessage" : "bindAddressstatusMessage",
"senderCount"statusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_DiskStore_DiskStoreInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/diskstores
GET /management/v1/diskstoreslist disk-stores
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
2
}, {
"connectedSendersconfiguration" : [ {
"connectedSenders", "connectedSenders" ]diskUsageCriticalPercentage" : 1.4658129,
"queueSize" : 2,
"runningallowForceCompaction" : true,
"portdiskUsageWarningPercentage" : 5.962134,
"hostnameForSendersmaxOplogSizeInBytes" : "hostnameForSenders"5,
"memberNamename" : "memberNamename",
"bindAddressautoCompact" : "bindAddress"true,
"senderCountdirectories" : [ 2{
} ]
"dirSize" }: ]6,
"idname" : "idname"
}, {
"links" : { "self" : "uri" },
"statusMessagedirSize" : "statusMessage"6,
"statusCodename" : "OK"
}Responses
200
OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not FoundGET /management/v1/gateways/receivers
GET /management/v1/gateways/receiverslist gateway-receivers
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
name"
} ],
"timeInterval" : 7,{
"result" : [ {
"groups" : [ {
"configuration" : {
"startPortwriteBufferSize" : 59,
"gatewayTransportFilterscompactionThreshold" : [ {0,
"initPropertiesgroup" : {"group"
},
"keyruntimeInfo" : [ { }
"memberName" : },"memberName"
}, {
"classNamememberName" : "classNamememberName"
} ]
}, {
"initPropertiesconfiguration" : {
"diskUsageCriticalPercentage" : 1.4658129,
"keyqueueSize" : { }2,
"allowForceCompaction" : }true,
"classNamediskUsageWarningPercentage" : "className"
5.962134,
"maxOplogSizeInBytes" }: ]5,
"manualStartname" : true"name",
"maximumTimeBetweenPingsautoCompact" : 6true,
"endPortdirectories" : [ 0,{
"socketBufferSizedirSize" : 16,
"groupname" : "groupname"
}, {
"runtimeInfodirSize" : 6,
[ {
"connectedSendersname" : [ "connectedSenders", "connectedSenders"name"
} ],
"runningtimeInterval" : true7,
"portwriteBufferSize" : 59,
"hostnameForSenderscompactionThreshold" : "hostnameForSenders"0,
"memberNamegroup" : "memberNamegroup",
},
"bindAddressruntimeInfo" : "bindAddress",[ {
"senderCountmemberName" : 2"memberName"
}, {
"connectedSendersmemberName" : [ "connectedSenders", "connectedSenders" ],memberName"
} ]
"running" :} true],
"portid" : 5,"id"
}, {
"hostnameForSendersgroups" : "hostnameForSenders",
[ {
"memberNameconfiguration" : "memberName",{
"bindAddressdiskUsageCriticalPercentage" : "bindAddress"1.4658129,
"senderCountqueueSize" : 2,
} ]
"allowForceCompaction" : }true,
{
"configurationdiskUsageWarningPercentage" : {5.962134,
"startPortmaxOplogSizeInBytes" : 5,
"gatewayTransportFiltersname" : [ {"name",
"initPropertiesautoCompact" : {
true,
"keydirectories" : [ {
}
"dirSize" : }6,
"classNamename" : "classNamename"
}, {
"initPropertiesdirSize" : {
"key" : { }
}6,
"classNamename" : "classNamename"
} ],
"manualStarttimeInterval" : true7,
"maximumTimeBetweenPingswriteBufferSize" : 69,
"endPortcompactionThreshold" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSendersmemberName" : [ "connectedSenders", "connectedSenders" ],memberName"
}, {
"runningmemberName" : true,"memberName"
} ]
"port" : 5}, {
"hostnameForSendersconfiguration" : "hostnameForSenders",{
"memberNamediskUsageCriticalPercentage" : "memberName"1.4658129,
"bindAddressqueueSize" : "bindAddress"2,
"senderCountallowForceCompaction" : 2
}, {true,
"connectedSendersdiskUsageWarningPercentage" : [ "connectedSenders", "connectedSenders" ],5.962134,
"runningmaxOplogSizeInBytes" : true5,
"portname" : 5"name",
"hostnameForSendersautoCompact" : "hostnameForSenders"true,
"memberNamedirectories" : "memberName", [ {
"bindAddressdirSize" : "bindAddress"6,
"senderCountname" : 2"name"
}, ]{
} ],
"iddirSize" : "id"6,
}, {
"groupsname" : [ {
"name"
"configuration" :} {],
"startPorttimeInterval" : 57,
"gatewayTransportFilterswriteBufferSize" : [ {9,
"initPropertiescompactionThreshold" : {
0,
"keygroup" : { }
"group"
},
"classNameruntimeInfo" : "className"
}, [ {
"initPropertiesmemberName" : {
"key" : { }
memberName"
}, {
"classNamememberName" : "classNamememberName"
} ],
"manualStart" : true,
} ],
"maximumTimeBetweenPingsid" : 6,"id"
"endPort" : 0,
"socketBufferSize} ],
"links" : 1,
"group{ "self" : "groupuri"
},
"runtimeInfostatusMessage" : [ {
"statusMessage",
"connectedSendersstatusCode" : [ "OK"
}Responses
200
OK ClusterManagementListResult_DiskStore_DiskStoreInfo401
Unauthorized403
Forbidden404
Not Found...
Versions
GET /management
GET /managementget documentation-links
Return type
Example data
Content-Type: application/json
{
"latest" : "latest",
"supported" : [ "supported", "supported" ]
}Responses
200
OK DocLinks401
Unauthorized403
Forbidden404
Not Found...
Gateway Management
POST /management/v1/gateways/receivers
POST /management/v1/gateways/receiverscreate 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" : [ {
connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCountconfiguration" : 2{
}, { "startPort" : 5,
"connectedSendersgatewayTransportFilters" : [ "connectedSenders", "connectedSenders" ],
{
"runninginitProperties" : true,{
"portkey" : 5,{ }
"hostnameForSenders" : "hostnameForSenders"},
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
}, {
"configuration" : {
"startPort" : 5,
"gatewayTransportFilters" : [ {
"initProperties" : {
"key" : { }
},
"className" : "className"
}, {
"initProperties" : {
"key" : { }
},
"className" : "className"
} ],
"manualStart" : true,
"maximumTimeBetweenPings" : 6,
"endPort" : 0,
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 5,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
}, ],{
"idconfiguration" : "id"{
} ],
"links" : { "selfstartPort" : "uri" }5,
"statusMessage" : "statusMessage",
"statusCodegatewayTransportFilters" : "OK"
}Responses
200
OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not FoundMember Management
GET /management/v1/members/{id}
GET /management/v1/members/{id}get member
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result[ {
"initProperties" : {
"groups" : [ {
"configurationkey" : { }
"id" : "id"},
"groupclassName" : "groupclassName"
}, {
"runtimeInfoinitProperties" : [ {
"cpuUsagekey" : 5.637376656633329, { }
"server" : true},
"httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
"memberName" : "memberName"} ],
"locatorsmanualStart" : "locators"true,
"processIdmaximumTimeBetweenPings" : 46,
"webSSLendPort" : true0,
"hostedRegionssocketBufferSize" : [ "hostedRegions", "hostedRegions" ],1,
"hostgroup" : "hostgroup",
},
"maxHeapSizeruntimeInfo" : [ 2,{
"workingDirPathconnectedSenders" : [ "connectedSenders", "workingDirPathconnectedSenders" ],
"idrunning" : "id"true,
"clientCountport" : 5,
"httpServicePorthostnameForSenders" : 7"hostnameForSenders",
"cacheServerInfomemberName" : [ {"memberName",
"runningbindAddress" : true"bindAddress",
"portsenderCount" : 1,2
"maxThreads" : 6,
}, {
"bindAddressconnectedSenders" : [ "bindAddressconnectedSenders",
"connectedSenders" ],
"maxConnectionsrunning" : 0
}, {
true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
} ],
} ],
"coordinatorid" : true,"id"
},
"links" : { "groupsself" : "groupsuri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/gateways/receivers
GET /management/v1/gateways/receiverslist gateway-receivers
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
{
"result" : [ {
serverBindAddress" : "serverBindAddress",
"cacheXmlFilePathgroups" : "cacheXmlFilePath", [ {
"locatorPortconfiguration" : 3,{
"heapUsagestartPort" : 25,
"initHeapSizegatewayTransportFilters" : 9,[ {
"logFilePathinitProperties" : "logFilePath",
{
"offHeapMemorySizekey" : "offHeapMemorySize", { }
"secured" : true},
"statArchiveFilePathclassName" : "statArchiveFilePath",
className"
}, {
"statusinitProperties" : {
"status" "key" : { }
},
{
"cpuUsageclassName" : 5.637376656633329 "className"
} ],
"servermanualStart" : true,
"httpServiceBindAddressmaximumTimeBetweenPings" : "httpServiceBindAddress"6,
"memberNameendPort" : "memberName"0,
"locatorssocketBufferSize" : "locators"1,
"processIdgroup" : 4,
"group"
},
"webSSLruntimeInfo" : [ true,{
"hostedRegionsconnectedSenders" : [ "hostedRegionsconnectedSenders", "hostedRegionsconnectedSenders" ],
"hostrunning" : "host"true,
"maxHeapSizeport" : 25,
"workingDirPathhostnameForSenders" : "workingDirPathhostnameForSenders",
"idmemberName" : "idmemberName",
"clientCountbindAddress" : 5"bindAddress",
"httpServicePortsenderCount" : 7, 2
}, {
"cacheServerInfoconnectedSenders" : [ {
"connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 15,
"maxThreadshostnameForSenders" : 6"hostnameForSenders",
"bindAddressmemberName" : "bindAddressmemberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
} ]
}, {
"runningconfiguration" : true,{
"portstartPort" : 15,
"maxThreadsgatewayTransportFilters" : [ 6,{
"bindAddressinitProperties" : "bindAddress",
{
"maxConnectionskey" : { 0}
} ],
"coordinatorclassName" : true,"className"
"groups" : "groups",
}, {
"serverBindAddressinitProperties" : "serverBindAddress",
{
"cacheXmlFilePathkey" : "cacheXmlFilePath", { }
"locatorPort" : 3},
"heapUsageclassName" : 2,"className"
"initHeapSize" : 9} ],
"logFilePathmanualStart" : "logFilePath"true,
"offHeapMemorySizemaximumTimeBetweenPings" : "offHeapMemorySize"6,
"securedendPort" : true0,
"statArchiveFilePathsocketBufferSize" : "statArchiveFilePath"1,
"statusgroup" : "statusgroup"
} ]
}, {
"configurationruntimeInfo" : [ {
"idconnectedSenders" : [ "idconnectedSenders",
"group" : "group"
}"connectedSenders" ],
"runtimeInfo" : [ {
"cpuUsagerunning" : 5.637376656633329true,
"serverport" : true5,
"httpServiceBindAddresshostnameForSenders" : "httpServiceBindAddresshostnameForSenders",
"memberName" : "memberName",
"locatorsbindAddress" : "locatorsbindAddress",
"processIdsenderCount" : 4,2
"webSSL" : true,}, {
"hostedRegionsconnectedSenders" : [ "hostedRegionsconnectedSenders", "hostedRegionsconnectedSenders" ],
"hostrunning" : "host"true,
"maxHeapSizeport" : 25,
"workingDirPathhostnameForSenders" : "workingDirPathhostnameForSenders",
"idmemberName" : "idmemberName",
"clientCountbindAddress" : 5"bindAddress",
"httpServicePortsenderCount" : 7,
2
} ]
} "cacheServerInfo],
"id" : [ "id"
}, {
"groups" : [ {
"runningconfiguration" : true,{
"portstartPort" : 15,
"maxThreadsgatewayTransportFilters" : 6,[ {
"bindAddressinitProperties" : "bindAddress",
{
"maxConnectionskey" : 0{ }
}, {
"runningclassName" : true,"className"
}, {
"portinitProperties" : 1,{
"maxThreadskey" : 6,{ }
"bindAddress" : "bindAddress"},
"maxConnectionsclassName" : 0"className"
} ],
"coordinatormanualStart" : true,
"groupsmaximumTimeBetweenPings" : 6,
"groupsendPort" : 0,
"serverBindAddresssocketBufferSize" : "serverBindAddress"1,
"cacheXmlFilePathgroup" : "cacheXmlFilePathgroup",
},
"locatorPortruntimeInfo" : [ 3,{
"heapUsageconnectedSenders" : 2[ "connectedSenders", "connectedSenders" ],
"initHeapSizerunning" : 9true,
"logFilePathport" : "logFilePath"5,
"offHeapMemorySizehostnameForSenders" : "offHeapMemorySizehostnameForSenders",
"securedmemberName" : true"memberName",
"statArchiveFilePathbindAddress" : "statArchiveFilePathbindAddress",
"statussenderCount" : "status"2
}, {
"cpuUsageconnectedSenders" : 5.637376656633329[ "connectedSenders", "connectedSenders" ],
"serverrunning" : true,
"httpServiceBindAddressport" : "httpServiceBindAddress"5,
"memberNamehostnameForSenders" : "memberNamehostnameForSenders",
"locatorsmemberName" : "locatorsmemberName",
"processIdbindAddress" : 4"bindAddress",
"webSSLsenderCount" : true,2
} ]
"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" : [ "connectedSenders", "groupsconnectedSenders" ],
"serverBindAddressrunning" : "serverBindAddress"true,
"cacheXmlFilePathport" : "cacheXmlFilePath"5,
"locatorPorthostnameForSenders" : 3"hostnameForSenders",
"memberName" : "memberName",
"heapUsagebindAddress" : 2"bindAddress",
"initHeapSizesenderCount" : 9, 2
}, {
"logFilePathconnectedSenders" : [ "connectedSenders", "logFilePathconnectedSenders" ],
"offHeapMemorySizerunning" : true,
"offHeapMemorySizeport" : 5,
"securedhostnameForSenders" : true"hostnameForSenders",
"statArchiveFilePathmemberName" : "statArchiveFilePathmemberName",
"statusbindAddress" : "status"bindAddress",
"senderCount" : 2
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementGetResultClusterManagementListResult_MemberGatewayReceiver_MemberInformationGatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
Member Management
GET /management/v1/members
GET /management/v1/members/{id}
/{id}get member
Path parameters
id (required)
Path
list members
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
ClusterManagementListResultClusterManagementGetResult_Member_MemberInformation
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
} ],
"id" : "id"
}, {
"groupslinks" : [ {
"self" : "configurationuri" : {
},
"idstatusMessage" : "idstatusMessage",
"groupstatusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/members
GET /management/v1/memberslist members
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
} ],
"id" : "id"
}, ],{
"linksgroups" : [ {
"self" : "uri" },
"statusMessageconfiguration" : "statusMessage{
"id" : "id",
"statusCodegroup" : "OKgroup"
}Responses
200
OK ClusterManagementListResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not FoundPdx Management
POST /management/v1/configurations/pdx
POST /management/v1/configurations/pdxconfigure 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
GET /management/v1/configurations/pdx
GET /management/v1/configurations/pdxget pdx
Return type
Example data
Content-Type: application/json
{
"links,
"runtimeInfo" : [ {
"self "cpuUsage" : "uri" },
5.637376656633329,
"server" : true,
"statusMessagehttpServiceBindAddress" : "statusMessagehttpServiceBindAddress",
"statusCodememberName" : "OK"
}Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Pdx already configured.500
Internal error.{
"result" : {
memberName",
"groupslocators" : [ {
"locators",
"configurationprocessId" : {4,
"autoSerializerwebSSL" : {true,
"patternshostedRegions" : [ "patternshostedRegions", "patternshostedRegions" ],
"host" : "portablehost",
: true
"maxHeapSize" : }2,
"readSerializedworkingDirPath" : true"workingDirPath",
"diskStoreNameid" : "diskStoreNameid",
"ignoreUnreadFieldsclientCount" : true5,
"pdxSerializerhttpServicePort" : {7,
"initPropertiescacheServerInfo" : [ {
"keyrunning" : true,
{ }
"port" : }1,
"classNamemaxThreads" : "className"6,
}
"bindAddress" : }"bindAddress",
"runtimeInfomaxConnections" : [ 0
}, {
"readSerializedrunning" : true,
"memberNameport" : "memberName"1,
"diskStoreNamemaxThreads" : "diskStoreName"6,
"ignoreUnreadFieldsbindAddress" : true"bindAddress",
"pdxSerializermaxConnections" : "pdxSerializer"0
} ], {
"readSerializedcoordinator" : true,
"memberNamegroups" : "memberNamegroups",
"diskStoreNameserverBindAddress" : "diskStoreNameserverBindAddress",
"ignoreUnreadFieldscacheXmlFilePath" : true"cacheXmlFilePath",
"pdxSerializerlocatorPort" : "pdxSerializer"3,
} ]
"heapUsage" : 2,
}, {
"configurationinitHeapSize" : {9,
"autoSerializerlogFilePath" : {"logFilePath",
"patternsoffHeapMemorySize" : [ "patternsoffHeapMemorySize", "patterns" ],
"portablesecured" : true
},
"readSerializedstatArchiveFilePath" : true"statArchiveFilePath",
"diskStoreNamestatus" : "diskStoreName",status"
}, {
"ignoreUnreadFieldscpuUsage" : true5.637376656633329,
"pdxSerializerserver" : {true,
"initPropertieshttpServiceBindAddress" : {"httpServiceBindAddress",
"memberName" : "memberName",
"keylocators" : { }"locators",
"processId" : }4,
"classNamewebSSL" : "className"true,
}
"hostedRegions" : [ "hostedRegions", "hostedRegions" }],
"runtimeInfohost" : [ {"host",
"readSerializedmaxHeapSize" : true2,
"memberNameworkingDirPath" : "memberNameworkingDirPath",
"diskStoreNameid" : "diskStoreNameid",
"ignoreUnreadFieldsclientCount" : true5,
"pdxSerializerhttpServicePort" : "pdxSerializer"7,
}, "cacheServerInfo" : [ {
"readSerializedrunning" : true,
"memberNameport" : "memberName"1,
"diskStoreNamemaxThreads" : "diskStoreName"6,
"ignoreUnreadFieldsbindAddress" : true"bindAddress",
"pdxSerializermaxConnections" : "pdxSerializer"0
}, ]{
} ],
"idrunning" : "id"
true,
},
"links" : { "selfport" : "uri" }1,
"statusMessage "maxThreads" : "statusMessage"6,
"statusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_Pdx_PdxInfo401
Unauthorized403
Forbidden404
Not FoundPing
GET
ping
Return type
String
Example data
Content-Type: application/json
""Responses
200
OK String401
Unauthorized403
Forbidden404
Not FoundRebalance Operation
GET
get rebalance
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
GET /management/v1/operations/rebalances
GET /management/v1/operations/rebalanceslist rebalances
Return type
Example data
Content-Type: application/json
{
"operationStartbindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXbindAddress",
"throwable" : {
"localizedMessagemaxConnections" : "localizedMessage",0
"stackTrace" : [} {],
"fileNamecoordinator" : "fileName"true,
"nativeMethodgroups" : true"groups",
"methodNameserverBindAddress" : "methodNameserverBindAddress",
"classNamecacheXmlFilePath" : "classNamecacheXmlFilePath",
"lineNumberlocatorPort" : 43,
}, {
"fileNameheapUsage" : "fileName"2,
"nativeMethodinitHeapSize" : true9,
"methodNamelogFilePath" : "methodNamelogFilePath",
"classNameoffHeapMemorySize" : "classNameoffHeapMemorySize",
"lineNumbersecured" : 4true,
} ],
"suppressedstatArchiveFilePath" : [ null, null ],
"statArchiveFilePath",
"messagestatus" : "messagestatus"
}, ]
"operationId" : "operationId"}, {
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationconfiguration" : {
"excludeRegions" : [ "excludeRegionsid", : "excludeRegionsid" ],
"includeRegions" : [ "includeRegionsgroup", : "includeRegionsgroup" ],
"simulate" : true},
"operatorruntimeInfo" : "operator"[ {
},
"statusMessagecpuUsage" : "statusMessage"5.637376656633329,
"operationResult" : {
"rebalanceRegionResultsserver" : [ {
true,
"bucketCreateTimeInMillisecondshttpServiceBindAddress" : 6"httpServiceBindAddress",
"primaryTransferTimeInMillisecondsmemberName" : 9"memberName",
"bucketCreatesCompletedlocators" : 1"locators",
"bucketTransfersCompletedprocessId" : 24,
"numOfMemberswebSSL" : 7true,
"bucketCreateByteshostedRegions" : 0 [ "hostedRegions", "hostedRegions" ],
"regionNamehost" : "regionNamehost",
"bucketTransferTimeInMillisecondsmaxHeapSize" : 52,
"timeInMillisecondsworkingDirPath" : 2"workingDirPath",
"primaryTransfersCompletedid" : 3"id",
"bucketTransferBytesclientCount" : 5,
}, {
"bucketCreateTimeInMillisecondshttpServicePort" : 67,
"primaryTransferTimeInMillisecondscacheServerInfo" : 9,[ {
"bucketCreatesCompletedrunning" : 1true,
"bucketTransfersCompletedport" : 21,
"numOfMembersmaxThreads" : 76,
"bucketCreateBytesbindAddress" : 0"bindAddress",
"regionNamemaxConnections" : "regionName",0
"bucketTransferTimeInMilliseconds" : 5}, {
"timeInMillisecondsrunning" : 2true,
"primaryTransfersCompletedport" : 31,
"bucketTransferBytesmaxThreads" : 56,
} ],
"successbindAddress" : true"bindAddress",
"statusMessage" : "statusMessage"
},
"statusCodemaxConnections" : "OK"
}Responses
200
OK ClusterManagementOperationResult_RebalanceOperation_RebalanceResult401
Unauthorized403
Forbidden404
Not Found{
"result" : [ {
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
0
} ],
"throwablecoordinator" : {true,
"localizedMessagegroups" : "localizedMessagegroups",
"stackTraceserverBindAddress" : [ {"serverBindAddress",
"fileNamecacheXmlFilePath" : "fileNamecacheXmlFilePath",
"nativeMethodlocatorPort" : true3,
"methodNameheapUsage" : "methodName"2,
"classNameinitHeapSize" : "className"9,
"lineNumberlogFilePath" : 4
}, {"logFilePath",
"fileNameoffHeapMemorySize" : "fileNameoffHeapMemorySize",
"nativeMethodsecured" : true,
"methodNamestatArchiveFilePath" : "methodNamestatArchiveFilePath",
"classNamestatus" : "classNamestatus",
}, {
"lineNumber" : 4
"cpuUsage" }: ]5.637376656633329,
"suppressedserver" : [ nulltrue,
null ],
"messagehttpServiceBindAddress" : "messagehttpServiceBindAddress",
},
"operationIdmemberName" : "operationIdmemberName",
"operationEndlocators" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXlocators",
"operationprocessId" : {4,
"excludeRegionswebSSL" : [ "excludeRegions"true,
"excludeRegions" ],
"includeRegionshostedRegions" : [ "includeRegionshostedRegions", "includeRegionshostedRegions" ],
"simulatehost" : true"host",
"operatormaxHeapSize" : "operator"2,
},
"statusMessageworkingDirPath" : "statusMessageworkingDirPath",
"operationResultid" : {"id",
"rebalanceRegionResultsclientCount" : [ {5,
"bucketCreateTimeInMillisecondshttpServicePort" : 67,
"primaryTransferTimeInMillisecondscacheServerInfo" : 9,[ {
"bucketCreatesCompletedrunning" : 1true,
"bucketTransfersCompletedport" : 21,
"numOfMembersmaxThreads" : 76,
"bucketCreateBytesbindAddress" : 0"bindAddress",
"regionNamemaxConnections" : "regionName",0
"bucketTransferTimeInMilliseconds" : 5,
}, {
"timeInMillisecondsrunning" : 2true,
"primaryTransfersCompletedport" : 31,
"bucketTransferBytesmaxThreads" : 56,
}, {
"bucketCreateTimeInMillisecondsbindAddress" : 6"bindAddress",
"primaryTransferTimeInMillisecondsmaxConnections" : 9,0
"bucketCreatesCompleted" : 1} ],
"bucketTransfersCompletedcoordinator" : 2true,
"numOfMembersgroups" : 7"groups",
"bucketCreateBytesserverBindAddress" : 0"serverBindAddress",
"regionNamecacheXmlFilePath" : "regionNamecacheXmlFilePath",
"bucketTransferTimeInMillisecondslocatorPort" : 53,
"timeInMillisecondsheapUsage" : 2,
"primaryTransfersCompletedinitHeapSize" : 39,
"bucketTransferByteslogFilePath" : 5
"logFilePath",
} ]"offHeapMemorySize" : "offHeapMemorySize",
"successsecured" : true,
"statusMessagestatArchiveFilePath" : "statusMessagestatArchiveFilePath",
},
"statusCodestatus" : "OK"
status"
} ]
} ], {
"operationStartid" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"id"
} ],
"throwablelinks" : {
"self" : "uri" },
"localizedMessagestatusMessage" : "localizedMessagestatusMessage",
"statusCode" : "stackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
OK"
}Responses
200
OK ClusterManagementListResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
Pdx Management
POST /management/v1/configurations/pdx
POST /management/v1/configurations/pdxconfigure 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/pdxget pdx
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {
"fileNameconfiguration" : "fileName",{
"nativeMethodautoSerializer" : true,{
"methodNamepatterns" : [ "methodNamepatterns",
"classNamepatterns" : "className"],
"lineNumberportable" : 4true
} ],
"suppressedreadSerialized" : [ nulltrue,
null ],
"messagediskStoreName" : "messagediskStoreName",
},
"operationIdignoreUnreadFields" : "operationId"true,
"operationEndpdxSerializer" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
{
"operationinitProperties" : {
"excludeRegions" : [ "excludeRegionskey", "excludeRegions" ], : { }
"includeRegions" : [ "includeRegions", "includeRegions" ]},
"simulate" : true,
"operatorclassName" : "operatorclassName"
},
"statusMessage" : "statusMessage",}
"operationResult" : {},
"rebalanceRegionResultsruntimeInfo" : [ {
"bucketCreateTimeInMillisecondsreadSerialized" : 6true,
"primaryTransferTimeInMillisecondsmemberName" : 9"memberName",
"bucketCreatesCompleteddiskStoreName" : 1"diskStoreName",
"bucketTransfersCompletedignoreUnreadFields" : 2true,
"numOfMemberspdxSerializer" : 7,"pdxSerializer"
}, {
"bucketCreateBytesreadSerialized" : 0true,
"regionNamememberName" : "regionNamememberName",
"bucketTransferTimeInMillisecondsdiskStoreName" : 5"diskStoreName",
"timeInMillisecondsignoreUnreadFields" : 2true,
"primaryTransfersCompletedpdxSerializer" : 3,"pdxSerializer"
"bucketTransferBytes" : 5
} ]
}, {
"bucketCreateTimeInMillisecondsconfiguration" : 6,{
"primaryTransferTimeInMillisecondsautoSerializer" : 9,{
"bucketCreatesCompletedpatterns" : 1[ "patterns", "patterns" ],
"bucketTransfersCompletedportable" : 2 true
},
"numOfMembersreadSerialized" : 7true,
"bucketCreateBytesdiskStoreName" : 0"diskStoreName",
"regionNameignoreUnreadFields" : "regionName"true,
"bucketTransferTimeInMillisecondspdxSerializer" : 5,{
"timeInMillisecondsinitProperties" : 2,{
"primaryTransfersCompletedkey" : 3 { }
},
"bucketTransferBytesclassName" : 5"className"
} ]
},
"successruntimeInfo" : [ {
"readSerialized" : true,
"statusMessagememberName" : "statusMessagememberName",
},
"statusCodediskStoreName" : "OKdiskStoreName",
} ],
"linksignoreUnreadFields" : {true,
"selfpdxSerializer" : "uripdxSerializer"
}, {
"statusMessagereadSerialized" : "statusMessage"true,
"statusCodememberName" : "OKmemberName"
}Responses
200
OK ClusterManagementListOperationsResult_RebalanceOperation_RebalanceResult401
Unauthorized403
Forbidden404
Not FoundPOST /management/v1/operations/rebalances
POST /management/v1/operations/rebalancesstart 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
{
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
"diskStoreName" : "diskStoreName",
"throwable" : {
"localizedMessageignoreUnreadFields" : "localizedMessage"true,
"stackTrace" : [ {
"fileNamepdxSerializer" : "fileNamepdxSerializer",
} "nativeMethod" : true,
]
} ],
"methodNameid" : "methodNameid"
},
"links" : { "classNameself" : "classNameuri" },
"statusMessage" : "statusMessage",
"lineNumberstatusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_Pdx_PdxInfo401
Unauthorized403
Forbidden404
Not Found...
Ping
GET /management/v1/ping
GET /management/v1/pingping
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}get rebalance
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"classNamestackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
} ],
"suppressed" : [ null, null ],
"message" : "message"
},
"operationId" : "operationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"excludeRegions" : [ "excludeRegions", "excludeRegions" ],
"includeRegions" : [ "includeRegions", "includeRegions" ],
"simulate" : true,
"operator" : "operator"
},
"statusMessage" : "statusMessage",
"operationResult" : {
"rebalanceRegionResults" : [ {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 9,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"numOfMembers" : 7,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 2,
"primaryTransfersCompleted" : 3,
"bucketTransferBytes" : 5
}, {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 9,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"numOfMembers" : 7,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 2,
"primaryTransfersCompleted" : 3,
"bucketTransferBytes" : 5
} ],
"success" : true,
"statusMessage" : "statusMessage"
},
"statusCode" : "OK"
}Responses
200
OK ClusterManagementOperationResult_RebalanceOperation_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not FoundRegion Management
...
POST
regions/{regionName}/indexes
GET /management/v1/
regions/{regionName}/indexesGET /management/v1/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/indexescreate 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/regionscreate 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.operations/rebalances
operations/rebalanceslist rebalances
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage",
"stackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
} ],
"suppressed" : [ null, null ],
"message" : "message"
},
"operationId" : "operationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"excludeRegions" : [ "excludeRegions", "excludeRegions" ],
"includeRegions" : [ "includeRegions", "includeRegions" ],
"simulate" : true,
"operator" : "operator"
},
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
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
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCodeoperationResult" : "OK"
}Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
ForbiddenDELETE /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
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" : {
"groups" : [ {
{
"rebalanceRegionResults" : [ {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 9,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"numOfMembers" : 7,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 2,
"primaryTransfersCompleted" : 3,
"configurationbucketTransferBytes" : 5
}, {
"regionPathbucketCreateTimeInMilliseconds" : "regionPath"6,
"indexTypeprimaryTransferTimeInMilliseconds" : "KEY"9,
"expressionbucketCreatesCompleted" : "expression"1,
"namebucketTransfersCompleted" : "name"
2,
}"numOfMembers" : 7,
"runtimeInfobucketCreateBytes" : [ {0,
"memberNameregionName" : "memberNameregionName",
}, {"bucketTransferTimeInMilliseconds" : 5,
"memberNametimeInMilliseconds" : "memberName"
2,
"primaryTransfersCompleted" : 3,
} ]
"bucketTransferBytes" : 5
} ], {
"configurationsuccess" : {true,
"regionPathstatusMessage" : "regionPathstatusMessage",
},
"indexTypestatusCode" : "KEYOK",
}, {
"expressionoperationStart" : "expressionyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"namethrowable" : "name"{
}"localizedMessage" : "localizedMessage",
"runtimeInfostackTrace" : [ {
"memberNamefileName" : "memberNamefileName",
"nativeMethod" : }true, {
"memberNamemethodName" : "memberNamemethodName",
"className" } ]: "className",
} ],
"idlineNumber" : "id"
4
}, {
"links" : { "selffileName" : "urifileName" },
"statusMessagenativeMethod" : "statusMessage"true,
"statusCodemethodName" : "OK"
}Responses
200
OK ClusterManagementGetResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found{
"result" : {
methodName",
"groupsclassName" : [ {
"className",
"configurationlineNumber" : {4
} ],
"expirationssuppressed" : [ {
null, null ],
"actionmessage" : "DESTROYmessage",
},
"typeoperationId" : "ENTRY_TIME_TO_LIVEoperationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"timeInSecondsoperation" : 1{
"excludeRegions" : [ }"excludeRegions", {"excludeRegions" ],
"includeRegions" : [ "actionincludeRegions" :, "DESTROYincludeRegions" ],
"simulate" : true,
"typeoperator" : "ENTRY_TIME_TO_LIVE",operator"
},
"timeInSecondsstatusMessage" : 1"statusMessage",
"operationResult" } ],
: {
"redundantCopiesrebalanceRegionResults" : [ 5,{
"evictionbucketCreateTimeInMilliseconds" : {6,
"entryCountprimaryTransferTimeInMilliseconds" : 09,
"objectSizerbucketCreatesCompleted" : {1,
"initPropertiesbucketTransfersCompleted" : {
2,
"keynumOfMembers" : { }7,
"bucketCreateBytes" : }0,
"classNameregionName" : "classNameregionName",
"bucketTransferTimeInMilliseconds" : }5,
"actiontimeInMilliseconds" : "LOCAL_DESTROY"2,
"typeprimaryTransfersCompleted" : "ENTRY_COUNT"3,
"memorySizeMbbucketTransferBytes" : 65
}, {
"keyConstraintbucketCreateTimeInMilliseconds" : "keyConstraint"6,
"nameprimaryTransferTimeInMilliseconds" : "name"9,
"valueConstraintbucketCreatesCompleted" : "valueConstraint"1,
"typebucketTransfersCompleted" : "PARTITION"2,
"diskStoreNamenumOfMembers" : "diskStoreName"7,
"groupbucketCreateBytes" : "group"
0,
},
"runtimeInforegionName" : [ {"regionName",
"entryCountbucketTransferTimeInMilliseconds" : 5,
"memberNametimeInMilliseconds" : "memberName"
}, {2,
"entryCountprimaryTransfersCompleted" : 53,
"memberNamebucketTransferBytes" : "memberName"5
} ]
}, {
"configurationsuccess" : {true,
"expirationsstatusMessage" : [ {"statusMessage"
},
"actionstatusCode" : "DESTROYOK",
} ],
"typelinks" : { "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"actionself" : "uri" },
"statusMessage" : "DESTROYstatusMessage",
"typestatusCode" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5OK"
}Responses
200
OK ClusterManagementListOperationsResult_RebalanceOperation_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
POST /management/v1/operations/rebalances
POST /management/v1/operations/rebalancesstart 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
{
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage",
"evictionstackTrace" : [ {
"entryCountfileName" : 0"fileName",
"objectSizernativeMethod" : {true,
"initPropertiesmethodName" : {"methodName",
"className" : "className",
"keylineNumber" : { }4
}, {
},
"className"fileName" : "classNamefileName",
"nativeMethod" : }true,
"actionmethodName" : "LOCAL_DESTROYmethodName",
"typeclassName" : "ENTRY_COUNTclassName",
"memorySizeMblineNumber" : 64
} ],
},
"suppressed" : [ null, null ],
"keyConstraintmessage" : "keyConstraintmessage",
},
"operationId" : "operationId",
"nameoperationEnd" : "nameyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"valueConstraintexcludeRegions" : [ "valueConstraintexcludeRegions",
"excludeRegions" ],
"typeincludeRegions" : [ "PARTITIONincludeRegions",
"includeRegions" ],
"diskStoreNamesimulate" : "diskStoreName"true,
"groupoperator" : "groupoperator"
},
"statusMessage" : }"statusMessage",
"operationResult" : {
"runtimeInforebalanceRegionResults" : [ {
"entryCountbucketCreateTimeInMilliseconds" : 56,
"memberNameprimaryTransferTimeInMilliseconds" : "memberName"
}, {
9,
"entryCountbucketCreatesCompleted" : 51,
"memberNamebucketTransfersCompleted" : "memberName"2,
} ]
} ]"numOfMembers" : 7,
"id" : "idbucketCreateBytes"
: }0,
"links" : { "selfregionName" : "uriregionName" },
"statusMessagebucketTransferTimeInMilliseconds" : "statusMessage"5,
"statusCode" : "OK"
}Responses
200
OK ClusterManagementGetResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found GET list indexes
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"resulttimeInMilliseconds" : 2,
[ {
"groupsprimaryTransfersCompleted" : [ {3,
"configurationbucketTransferBytes" : {5
}, {
"regionPathbucketCreateTimeInMilliseconds" : "regionPath"6,
"indexTypeprimaryTransferTimeInMilliseconds" : "KEY"9,
"expressionbucketCreatesCompleted" : "expression"1,
"namebucketTransfersCompleted" : "name"
}2,
"runtimeInfonumOfMembers" : [ {
7,
"memberNamebucketCreateBytes" : "memberName"
}, {
0,
"memberNameregionName" : "memberName"
} ]
}, {regionName",
"configurationbucketTransferTimeInMilliseconds" : {
"regionPath" : "regionPath"5,
"indexTypetimeInMilliseconds" : "KEY"2,
"expressionprimaryTransfersCompleted" : "expression"3,
"namebucketTransferBytes" : "name"5
} }],
"runtimeInfosuccess" : [ {
true,
"memberNamestatusMessage" : "memberNamestatusMessage"
}, {
"memberNamestatusCode" : "memberNameOK"
} ]
} ],
"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"
} ],}Responses
200
OK ClusterManagementOperationResult_RebalanceOperation_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not Found...
Region Management
POST /management/v1/regions/{regionName}/indexes
POST /management/v1/regions/{regionName}/indexescreate 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/indexescreate 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/regionscreate 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 ClusterManagementListResult_Index_IndexInfo ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
404 Not Found GET
regionName
/indexes
DELETE /management/v1/regions/{
regionNameDELETE /management/v1/regions/{id}
/indexesid}list delete region indexes
Path parameters
regionName id (required)
Path Parameter -- regionName id
Query parameters
id 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
ClusterManagementListResultClusterManagementGetResult_Index_IndexInfo
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groupslinks" : [ {
"self" : "configurationuri" : {},
"regionPath"statusMessage" : "regionPathstatusMessage",
"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
GET /management/v1/regions
GET /management/v1/regionslist regions
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result "indexType" : "KEY",{
"expressiongroups" : "expression",
[ {
"nameconfiguration" : "name"
{
},
"runtimeInfoexpirations" : [ {
"memberNameaction" : "memberNameDESTROY",
}, {
"memberNametype" : "memberName"ENTRY_TIME_TO_LIVE",
} ]
"timeInSeconds" },: {1
"configuration" : }, {
"regionPathaction" : "regionPathDESTROY",
"indexTypetype" : "KEYENTRY_TIME_TO_LIVE",
"expressiontimeInSeconds" : 1
} ],
"expressionredundantCopies" : 5,
"nameeviction" : "name"{
} "entryCount" : 0,
"runtimeInfoobjectSizer" : [ {
"memberNameinitProperties" : {
"memberName"
"key" : { }
},
{
"memberNameclassName" : "memberNameclassName"
},
]
} ],
"idaction" : "idLOCAL_DESTROY",
} ],
"linkstype" : {"ENTRY_COUNT",
"selfmemorySizeMb" : "uri"6
},
"statusMessagekeyConstraint" : "statusMessagekeyConstraint",
"statusCodename" : "OKname"
}Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found{
"result" : [ {
,
"valueConstraint" : "valueConstraint",
"groupstype" : "PARTITION",
[ {
"configurationdiskStoreName" : {"diskStoreName",
"expirationsgroup" : "group"
[ {
},
"actionruntimeInfo" : "DESTROY", [ {
"typeentryCount" : "ENTRY_TIME_TO_LIVE"5,
"timeInSecondsmemberName" : 1"memberName"
}, {
"actionentryCount" : "DESTROY"5,
"typememberName" : "ENTRY_TIME_TO_LIVE",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"
} ]
} ], {
"configurationid" : {"id"
},
"links" : { "expirationsself" : [ {"uri" },
"statusMessage" : "statusMessage",
"actionstatusCode" : "DESTROY",
OK"
}Responses
200
OK ClusterManagementGetResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/indexes
GET /management/v1/indexeslist indexes
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"typegroups" : "ENTRY_TIME_TO_LIVE",
[ {
"timeInSecondsconfiguration" : 1{
}, {"regionPath" : "regionPath",
"actionindexType" : "DESTROYKEY",
"typeexpression" : "ENTRY_TIME_TO_LIVEexpression",
"timeInSecondsname" : 1"name"
} ],
"redundantCopiesruntimeInfo" : 5,[ {
"evictionmemberName" : {
"memberName"
}, {
"entryCountmemberName" : 0,"memberName"
} ]
"objectSizer" :}, {
"initProperties"configuration" : {
"regionPath" : "regionPath",
"keyindexType" : { }"KEY",
"expression" }: "expression",
"classNamename" : "classNamename"
},
},
"runtimeInfo" : [ {
"actionmemberName" : "LOCAL_DESTROYmemberName",
}, {
"typememberName" : "ENTRY_COUNTmemberName",
} ]
"memorySizeMb" :} 6],
"id" : "id"
}, {
"keyConstraintgroups" : "keyConstraint",
[ {
"nameconfiguration" : "name",{
"valueConstraintregionPath" : "valueConstraintregionPath",
"typeindexType" : "PARTITIONKEY",
"diskStoreNameexpression" : "diskStoreNameexpression",
"groupname" : "groupname"
},
"runtimeInfo" : [ {
"entryCountmemberName" : 5,"memberName"
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"expirationsregionPath" : [ {
"regionPath",
"actionindexType" : "DESTROYKEY",
"typeexpression" : "ENTRY_TIME_TO_LIVEexpression",
"timeInSecondsname" : 1"name"
}, {
"actionruntimeInfo" : "DESTROY",
[ {
"typememberName" : "ENTRY_TIME_TO_LIVE",memberName"
}, {
"timeInSecondsmemberName" : 1"memberName"
} ],
} ],
"redundantCopiesid" : 5,"id"
} ],
"links" : { "evictionself" : {"uri" },
"statusMessage" : "entryCount" : 0"statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{regionName}/indexes
GET /management/v1/regions/{regionName}/indexeslist region indexes
Path parameters
regionName (required)
Path Parameter -- regionName
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
objectSizer" : {
"result" : [ {
"initPropertiesgroups" : [ {
"keyconfiguration" : { }
"regionPath" }: "regionPath",
"classNameindexType" : "classNameKEY",
"expression" : }"expression",
"actionname" : "LOCAL_DESTROYname",
},
"typeruntimeInfo" : "ENTRY_COUNT",
[ {
"memorySizeMbmemberName" : 6"memberName"
}, {
"keyConstraintmemberName" : "keyConstraintmemberName",
} ]
}, "name{
"configuration" : "name",{
"valueConstraintregionPath" : "valueConstraintregionPath",
"typeindexType" : "PARTITIONKEY",
"diskStoreNameexpression" : "diskStoreNameexpression",
"groupname" : "groupname"
},
"runtimeInfo" : [ {
"entryCountmemberName" : 5,"memberName"
}, {
"memberName" : "memberName"
}, {]
"entryCount" : 5,
} ],
"memberNameid" : "memberNameid"
}, {
} ]
"groups" : [ }, {
"configuration" : {
"expirationsregionPath" : [ {"regionPath",
"actionindexType" : "DESTROYKEY",
"typeexpression" : "ENTRY_TIME_TO_LIVEexpression",
"name" : "timeInSecondsname"
: 1},
"runtimeInfo" : },[ {
"actionmemberName" : "DESTROYmemberName",
}, {
"typememberName" : "ENTRY_TIME_TO_LIVE",memberName"
"timeInSeconds" : 1
} ]
}, ],{
"redundantCopiesconfiguration" : 5,{
"evictionregionPath" : {"regionPath",
"entryCountindexType" : 0"KEY",
"objectSizerexpression" : {
"expression",
"initPropertiesname" : {"name"
},
"keyruntimeInfo" : [ { }
},
"className"memberName" : "classNamememberName"
}, {
"actionmemberName" : "LOCAL_DESTROYmemberName",
} ]
"type" : "ENTRY_COUNT"} ],
"memorySizeMbid" : 6"id"
}} ],
"links" : { "keyConstraintself" : "keyConstrainturi" },
"namestatusMessage" : "namestatusMessage",
"valueConstraintstatusCode" : "OK"
}Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions
GET /management/v1/regionslist regions
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
valueConstraint",
"type" : "PARTITION",
"diskStoreNameconfiguration" : "diskStoreName",{
"groupexpirations" : [ "group"{
},
"action" : "runtimeInfoDESTROY" :,
[ {
"entryCounttype" : 5"ENTRY_TIME_TO_LIVE",
"memberNametimeInSeconds" : "memberName"1
}, {
"entryCountaction" : 5"DESTROY",
"memberNametype" : "memberName"ENTRY_TIME_TO_LIVE",
} ]
"timeInSeconds" } : 1
} ],
"idredundantCopies" : 5,
"id"
} ],
"links "eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
"self },
"className" : "uriclassName"
},
"action" : "LOCAL_DESTROY",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementListResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not FoundModels
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]
"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...
RestoreRedundancy Operation
GET /management/v1/operations/restoreRedundancy/{id}
GET /management/v1/operations/restoreRedundancy/{id}get restore-redundancy
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage",
"stackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
} ],
"suppressed" : [ null, null ],
"message" : "message"
},
"operationId" : "operationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"excludeRegions" : [ "excludeRegions", "excludeRegions" ],
"reassignPrimaries" : true,
"includeRegions" : [ "includeRegions", "includeRegions" ],
"operator" : "operator"
},
"statusMessage" : "statusMessage",
"operationResult" : {
"regionResults" : {
"key" : {
"configuredRedundancy" : 6,
"regionName" : "regionName",
"actualRedundancy" : 0,
"status" : "SATISFIED"
}
},
"underRedundancyRegionResults" : { },
"zeroRedundancyRegionResults" : { },
"totalPrimaryTransferTime" : 1,
"totalPrimaryTransfersCompleted" : 5,
"includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
"success" : true,
"satisfiedRedundancyRegionResults" : { },
"statusMessage" : "statusMessage"
},
"statusCode" : "OK"
}Responses
200
OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/operations/restoreRedundancy
GET /management/v1/operations/restoreRedundancylist restore-redundancy
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage",
"stackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
} ],
"suppressed" : [ null, null ],
"message" : "message"
},
"operationId" : "operationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"excludeRegions" : [ "excludeRegions", "excludeRegions" ],
"reassignPrimaries" : true,
"includeRegions" : [ "includeRegions", "includeRegions" ],
"operator" : "operator"
},
"statusMessage" : "statusMessage",
"operationResult" : {
"regionResults" : {
"key" : {
"configuredRedundancy" : 6,
"regionName" : "regionName",
"actualRedundancy" : 0,
"status" : "SATISFIED"
}
},
"underRedundancyRegionResults" : { },
"zeroRedundancyRegionResults" : { },
"totalPrimaryTransferTime" : 1,
"totalPrimaryTransfersCompleted" : 5,
"includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
"success" : true,
"satisfiedRedundancyRegionResults" : { },
"statusMessage" : "statusMessage"
},
"statusCode" : "OK"
}, {
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage",
"stackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
} ],
"suppressed" : [ null, null ],
"message" : "message"
},
"operationId" : "operationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"excludeRegions" : [ "excludeRegions", "excludeRegions" ],
"reassignPrimaries" : true,
"includeRegions" : [ "includeRegions", "includeRegions" ],
"operator" : "operator"
},
"statusMessage" : "statusMessage",
"operationResult" : {
"regionResults" : {
"key" : {
"configuredRedundancy" : 6,
"regionName" : "regionName",
"actualRedundancy" : 0,
"status" : "SATISFIED"
}
},
"underRedundancyRegionResults" : { },
"zeroRedundancyRegionResults" : { },
"totalPrimaryTransferTime" : 1,
"totalPrimaryTransfersCompleted" : 5,
"includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
"success" : true,
"satisfiedRedundancyRegionResults" : { },
"statusMessage" : "statusMessage"
},
"statusCode" : "OK"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}Responses
200
OK ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults401
Unauthorized403
Forbidden404
Not Found...
POST /management/v1/operations/restoreRedundancy
POST /management/v1/operations/restoreRedundancystart restore-redundancy
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
{
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"throwable" : {
"localizedMessage" : "localizedMessage",
"stackTrace" : [ {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
}, {
"fileName" : "fileName",
"nativeMethod" : true,
"methodName" : "methodName",
"className" : "className",
"lineNumber" : 4
} ],
"suppressed" : [ null, null ],
"message" : "message"
},
"operationId" : "operationId",
"operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operation" : {
"excludeRegions" : [ "excludeRegions", "excludeRegions" ],
"reassignPrimaries" : true,
"includeRegions" : [ "includeRegions", "includeRegions" ],
"operator" : "operator"
},
"statusMessage" : "statusMessage",
"operationResult" : {
"regionResults" : {
"key" : {
"configuredRedundancy" : 6,
"regionName" : "regionName",
"actualRedundancy" : 0,
"status" : "SATISFIED"
}
},
"underRedundancyRegionResults" : { },
"zeroRedundancyRegionResults" : { },
"totalPrimaryTransferTime" : 1,
"totalPrimaryTransfersCompleted" : 5,
"includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
"success" : true,
"satisfiedRedundancyRegionResults" : { },
"statusMessage" : "statusMessage"
},
"statusCode" : "OK"
}Responses
200
OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults201
Created401
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_DiskStore_DiskStoreInfo
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
ClusterManagementGetResult_Deployment_DeploymentInfo links (optional)
result (optional)
EntityInfo_DeploymentMember_DeploymentInfoMemberInformation
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_
GatewayReceiverPdx_
GatewayReceiverInfoPdxInfo
links (optional)
result (optional)
EntityInfo_GatewayReceiverPdx_GatewayReceiverInfoPdxInfo
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_
IndexRegion_
IndexInfoRuntimeRegionInfo
links (optional)
result (optional)
EntityInfo_IndexRegion_IndexInfoRuntimeRegionInfo
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_
MemberRebalanceOperation_
MemberInformationRebalanceResult
links (optional)
result (optional)
EntityInfoarray[ClusterManagementOperationResult_MemberRebalanceOperation_MemberInformationRebalanceResult]
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
ClusterManagementGetResult
ClusterManagementListOperationsResult_
PdxRestoreRedundancyRequest_
PdxInfoRestoreRedundancyResults
links (optional)
result (optional)
EntityInfoarray[ClusterManagementOperationResult_PdxRestoreRedundancyRequest_PdxInfoRestoreRedundancyResults]
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_
RegionDeployment_
RuntimeRegionInfoDeploymentInfo
links (optional)
result (optional)
array[EntityInfo_RegionDeployment_RuntimeRegionInfoDeploymentInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListOperationsResult
RebalanceOperation
RebalanceResult
ClusterManagementListResult_
RebalanceOperationDiskStore_
RebalanceResultDiskStoreInfo
links (optional)
result (optional)
array[ClusterManagementOperationResultEntityInfo_RebalanceOperationDiskStore_RebalanceResultDiskStoreInfo]
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_
DeploymentGatewayReceiver_
DeploymentInfoGatewayReceiverInfo
links (optional)
result (optional)
array[EntityInfo_DeploymentGatewayReceiver_DeploymentInfoGatewayReceiverInfo]
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_
GatewayReceiverIndex_
GatewayReceiverInfoIndexInfo
links (optional)
result (optional)
array[EntityInfo_GatewayReceiverIndex_GatewayReceiverInfoIndexInfo]
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_
IndexMember_
IndexInfoMemberInformation
links (optional)
result (optional)
array[EntityInfo_IndexMember_IndexInfoMemberInformation]
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_
MemberRegion_
MemberInformationRuntimeRegionInfo
links (optional)
result (optional)
array[EntityInfo_MemberRegion_MemberInformationRuntimeRegionInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementOperationResult_RebalanceOperation_RebalanceResult
links (optional)
operation (optional)
operationEnd (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId statusMessage (optional)
String
ClusterManagementListResult_Region_RuntimeRegionInfo
links operationResult (optional)
result operationStart (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
throwable (optional)
ClusterManagementOperationResult_
RebalanceOperationRestoreRedundancyRequest_
RebalanceResultRestoreRedundancyResults
links (optional)
operation (optional)
operationEnd (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String
operationResult (optional)
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
throwable (optional)
ClusterManagementResult
links (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
Deployment
deployedBy (optional)
String
deployedTime (optional)
String
fileName (optional)
String
group (optional)
String
DeploymentInfo
jarLocation (optional)
String
lastModified statusMessage (optional)
String
throwable memberName (optional)
ClusterManagementResult DiskDir
links dirSize (optional)
Integer format: int32
name statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
DiskStore
allowForceCompaction (optional)
Boolean
autoCompact (optional)
Boolean
compactionThreshold (optional)
Integer format: int32
directories (optional)
diskUsageCriticalPercentage (optional)
Float format: float
diskUsageWarningPercentage (optional)
Float format: float
group
Deployment
deployedBy (optional)
String
deployedTime maxOplogSizeInBytes (optional)
String
Long format: int64
name fileName (optional)
String
group queueSize (optional)
String
DeploymentInfo
Integer format: int32
timeInterval jarLocation (optional)
String
Long format: int64
writeBufferSize lastModified (optional)
Integer format: int32String
DiskStoreInfo
memberName (optional)
String
DocLinks
latest (optional)
String
supported (optional)
array[String]
EntityInfo_DiskStore_DiskStoreInfo
groups (optional)
array[EntityGroupInfo_DeploymentDiskStore_DeploymentInfoDiskStoreInfo]
id (optional)
String
links (optional)
EntityInfo_GatewayReceiver_GatewayReceiverInfo
groups (optional)
id (optional)
String
links (optional)
EntityInfo_Member_MemberInformation
groups (optional)
id (optional)
String
links (optional)
EntityInfo_Region_RuntimeRegionInfo
groups (optional)
id (optional)
String
links (optional)
Eviction
action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount (optional)
Integer format: int32
memorySizeMb (optional)
Integer format: int32
objectSizer (optional)
type (optional)
String
Enum:
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE
Expiration
action (optional)
String
Enum:
DESTROY
INVALIDATE
LEGACY
timeInSeconds (optional)
Integer format: int32
type (optional)
String
Enum:
ENTRY_TIME_TO_LIVE
ENTRY_IDLE_TIME
LEGACY
GatewayReceiver
endPort (optional)
Integer format: int32
gatewayTransportFilters (optional)
group (optional)
String
manualStart (optional)
Boolean
maximumTimeBetweenPings (optional)
Integer format: int32
socketBufferSize (optional)
Integer format: int32
startPort (optional)
Integer format: int32
GatewayReceiverInfo
bindAddress (optional)
String
connectedSenders (optional)
array[String]
hostnameForSenders (optional)
String
memberName (optional)
String
port (optional)
Integer format: int32
running (optional)
Boolean
senderCount (optional)
Integer format: int32
Index
expression (optional)
String
indexType (optional)
String
Enum:
KEY
RANGE
HASH_DEPRECATED
name (optional)
String
regionPath (optional)
String
IndexInfo
memberName (optional)
String
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 (optional)
Boolean
memberName (optional)
String
pdxSerializer (optional)
String
readSerialized (optional)
Boolean
RebalanceOperation
excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
operator (optional)
String
simulate (optional)
Boolean
RebalanceRegionResult
bucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
numOfMembers (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64
RebalanceResult
rebalanceRegionResults (optional)
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
RegionRedundancyStatus
actualRedundancy (optional)
Integer format: int32
configuredRedundancy (optional)
Integer format: int32
regionName (optional)
String
status (optional)
String
Enum:
SATISFIED
NOT_SATISFIED
NO_REDUNDANT_COPIES
RestoreRedundancyRequest
excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
operator (optional)
String
reassignPrimaries (optional)
Boolean
RestoreRedundancyResults
includedRegionsWithNoMembers (optional)
array[String]
regionResults (optional)
satisfiedRedundancyRegionResults (optional)
statusMessage (optional)
String
success (optional)
Boolean
totalPrimaryTransferTime (optional)
Long format: int64
totalPrimaryTransfersCompleted (optional)
Integer format: int32
underRedundancyRegionResults (optional)
zeroRedundancyRegionResults (optional)
RuntimeRegionInfo
entryCount (optional)
Long format: int64
memberName (optional)
String
StackTraceElement
className (optional)
String
fileName (optional)
String
lineNumber (optional)
Integer format: int32
methodName (optional)
String
nativeMethod (optional)
Boolean
Throwable
cause (optional)
localizedMessage (optional)
String
message (optional)
String
stackTrace (optional)
suppressed (optional)