THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Table of Contents | ||||
---|---|---|---|---|
|
Apache Geode Management REST API
REST API to manage Geode. This is experimental. All request/response formats are subject to change.
Swagger: http://locator:7070/management/docs (requires access to a running locator)
Codegen:
More information: http://geode.apache.org
Codegen:
brew install swagger-codegen; swagger-codegen generate -i http://locator:7070/management/v1/api-docs
More information: http://geode.apache.org
...
http://www.apache.org/licenses/
...
Deployment Management
...
GET /management/v1/
GET /management/v1/
...
deployments/
deployments/
...
{id}
{id}
get
...
deployed
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {
"configuration" : {
"deployedTime" : "deployedTime",
"deployedBy" : "deployedBy",
"jarFileName" : "jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"jarLocation" : "jarLocation",
"memberName" : "memberName",
...
Member Management
Pdx Management
Ping
Rebalance Operation
Region Management
post /v1/regions
delete /v1/regions/{id}
get /v1/regions/{regionName}/indexes/{id}
get /v1/regions/{id}
get /v1/indexes
get /v1/regions/{regionName}/indexes
get /v1/regions
Gateway Management
ANCHOR ="createGatewayReceiverUsingPOST"
create gateway-receiver
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Request Body
Return type
Example data
Content-Type: application/json
{
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Gateway receiver already exists.500
Internal error.ANCHOR ="getGatewayReceiverUsingGET"
get gateway-receiver
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"configuration" : {
"startPortlastModified" : 5,"lastModified"
"gatewayTransportFilters" : [ }, {
"initPropertiesjarLocation" : {"jarLocation",
"keymemberName" : { }
}"memberName",
"classNamelastModified" : "classNamelastModified"
} ]
}, {
"initPropertiesconfiguration" : {
"deployedTime" : "keydeployedTime",
: { }
"deployedBy" : }"deployedBy",
"classNamejarFileName" : "classNamejarFileName",
} ],
"group" : "group"
"manualStart" : true},
"maximumTimeBetweenPingsruntimeInfo" : [ 6,{
"endPortjarLocation" : 0"jarLocation",
"socketBufferSizememberName" : 1"memberName",
"grouplastModified" : "grouplastModified"
}, {
"runtimeInfojarLocation" : "jarLocation",
[ {
"connectedSendersmemberName" : [ "connectedSendersmemberName",
"connectedSenders" ],
"runninglastModified" : true,"lastModified"
"port" : 5,} ]
"hostnameForSenders" : "hostnameForSenders"} ],
"memberNameid" : "memberNameid",
"bindAddress" : "bindAddress"},
"senderCountlinks" : 2
}, {
"connectedSendersself" : [ "connectedSendersuri", "connectedSenders" ]},
"runningstatusMessage" : true,
"portstatusMessage" : 5,
"hostnameForSendersstatusCode" : "hostnameForSendersOK",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 2
} ]
},
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
}
Responses
200
OK ClusterManagementGetResult_Deployment_DeploymentInfo401
Unauthorized403
Forbidden404
Not Found ANCHOR ="listGatewayReceiversUsingGET" Up get...
GET /management/v1/
gateways/receiversGET /management/v1/
deployments
deployments
list gateway-receiversdeployed
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» ClusterManagementListResult_Deployment_DeploymentInfo
Example data
Content-Type: application/json
{
"result" : [ {
"configurationgroups" : [ {
"startPortconfiguration" : 5,{
"gatewayTransportFiltersdeployedTime" : [ {"deployedTime",
"initPropertiesdeployedBy" : {"deployedBy",
"jarFileName" : "jarFileName",
"key "group" : { "group"
},
"runtimeInfo" : [ },{
"classNamejarLocation" : "classNamejarLocation",
}, {"memberName" : "memberName",
"initPropertieslastModified" : {"lastModified"
}, {
"keyjarLocation" : { }
"jarLocation",
"memberName" : }"memberName",
"classNamelastModified" : "classNamelastModified"
} ]
}, {
"manualStartconfiguration" : true,{
"maximumTimeBetweenPingsdeployedTime" : 6"deployedTime",
"endPortdeployedBy" : 0"deployedBy",
"socketBufferSizejarFileName" : 1"jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSendersjarLocation" : [ "connectedSendersjarLocation",
"connectedSenders" ],
"runningmemberName" : true"memberName",
"portlastModified" : 5,
"lastModified"
}, {
"hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
"memberName" : "memberName",
"bindAddresslastModified" : "bindAddresslastModified",
"senderCount" : 2} ]
} ], {
"connectedSendersid" : [ "connectedSendersid",
"connectedSenders" ]}, {
"runninggroups" : [ true,{
"portconfiguration" : 5,{
"hostnameForSendersdeployedTime" : "hostnameForSendersdeployedTime",
"memberNamedeployedBy" : "memberNamedeployedBy",
"bindAddressjarFileName" : "bindAddressjarFileName",
"senderCountgroup" : 2"group"
} ]
},
{
"configurationruntimeInfo" : [ {
"startPortjarLocation" : 5"jarLocation",
"gatewayTransportFiltersmemberName" : [ {"memberName",
"initPropertieslastModified" : {
"key" : { }
lastModified"
}, {
"classNamejarLocation" : "className"
}, {jarLocation",
"initPropertiesmemberName" : {"memberName",
"lastModified" : "keylastModified"
: { }
} ]
}, {
"classNameconfiguration" : "className"{
} ],
"manualStartdeployedTime" : true"deployedTime",
"maximumTimeBetweenPingsdeployedBy" : 6"deployedBy",
"endPortjarFileName" : 0"jarFileName",
"socketBufferSize" : 1,
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSendersjarLocation" : [ "connectedSendersjarLocation",
"connectedSenders" ],
"runningmemberName" : true"memberName",
"portlastModified" : 5,
"lastModified"
}, {
"hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
"memberName" : "memberName",
"bindAddresslastModified" : "bindAddresslastModified",
"senderCount" : 2} ]
} ], {
"connectedSendersid" : [ "connectedSendersid", "connectedSenders"
} ],
"runninglinks" : true,
"port{ "self" : 5,
"hostnameForSendersuri" : "hostnameForSenders"},
"memberNamestatusMessage" : "memberNamestatusMessage",
"bindAddressstatusCode" : "bindAddressOK",
"senderCount" : 2
} ]
} ],
"links" : { },
"statusMessage
}
Responses
200
OK ClusterManagementListResult_Deployment_DeploymentInfo401
Unauthorized403
Forbidden404
Not Found...
Versions
GET /management
GET /management
get documentation-links
Return type
Example data
Content-Type: application/json
{
"latest" : "statusMessagelatest",
"statusCodesupported" : [ "supported", "OKsupported" ]
}
Responses
200
OK ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» DocLinks401
Unauthorized403
Forbidden404
Not Found...
Gateway Management
ANCHOR ="getMemberUsingGET" Up get
members/{id}
POST /management/v1/
members/{id}POST /management/v1/
get member
Path parameters
gateways/receivers
gateways/receivers
create gateway-receiver
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Path Parameter -- id Request Body
Return type
Example data
Content-Type: application/json
{
"resultlinks" : {
"self" : "configurationuri" : {},
"idstatusMessage" : "idstatusMessage",
"groupstatusCode" : "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" : {group"
},
"runtimeInfogroups" : [ {
"cpuUsageconfiguration" : 5.637376656633329,{
"serverstartPort" : true5,
"httpServiceBindAddressgatewayTransportFilters" : "httpServiceBindAddress",
[ {
"memberNameinitProperties" : "memberName",{
"locators" : "locators",
"processIdkey" : 4,{ }
"webSSL" : true},
"hostedRegions" : [ "hostedRegionsclassName", : "hostedRegionsclassName" ],
"host" : "host"}, {
"maxHeapSizeinitProperties" : 2,{
"workingDirPath" : "workingDirPath",
"idkey" : "id",{ }
"clientCount" : 5},
"httpServicePortclassName" : 7,"className"
"cacheServerInfo" : [} {],
"runningmanualStart" : true,
"portmaximumTimeBetweenPings" : 16,
"maxThreadsendPort" : 60,
"bindAddresssocketBufferSize" : "bindAddress"1,
"maxConnectionsgroup" : 0"group"
}, {
"runningruntimeInfo" : true,[ {
"portconnectedSenders" : 1 [ "connectedSenders", "connectedSenders" ],
"maxThreadsrunning" : 6true,
"bindAddressport" : "bindAddress"5,
"maxConnectionshostnameForSenders" : 0
} ],
"hostnameForSenders",
"coordinatormemberName" : true"memberName",
"groupsbindAddress" : "groupsbindAddress",
"serverBindAddresssenderCount" : "serverBindAddress",
2
}, {
"cacheXmlFilePathconnectedSenders" : [ "connectedSenders", "cacheXmlFilePathconnectedSenders" ],
"locatorPortrunning" : 3true,
"heapUsageport" : 25,
"initHeapSizehostnameForSenders" : 9"hostnameForSenders",
"logFilePathmemberName" : "logFilePathmemberName",
"offHeapMemorySizebindAddress" : "offHeapMemorySizebindAddress",
"secured" : true,
"statArchiveFilePathsenderCount" : "statArchiveFilePath",2
"status" : "status"} ]
}, {
"cpuUsageconfiguration" : 5.637376656633329,{
"serverstartPort" : true5,
"httpServiceBindAddress" : "httpServiceBindAddressgatewayTransportFilters",
: [ {
"memberName" : "memberName",
"locatorsinitProperties" : "locators",{
"processId" : 4,
"webSSLkey" : true,{ }
"hostedRegions" : [ "hostedRegions"},
"hostedRegions" ],
"hostclassName" : "hostclassName",
"maxHeapSize" : 2}, {
"workingDirPathinitProperties" : "workingDirPath",{
"id" : "id",
"clientCountkey" : 5,{ }
"httpServicePort" : 7},
"cacheServerInfoclassName" : [ {"className"
"running" : true} ],
"portmanualStart" : 1true,
"maxThreadsmaximumTimeBetweenPings" : 6,
"bindAddressendPort" : "bindAddress"0,
"maxConnectionssocketBufferSize" : 0
}, {1,
"runninggroup" : true,"group"
"port" : 1},
"maxThreadsruntimeInfo" : [ 6,{
"bindAddressconnectedSenders" : [ "connectedSenders", "bindAddressconnectedSenders" ],
"maxConnectionsrunning" : 0
} ],
true,
"coordinatorport" : true5,
"groupshostnameForSenders" : "groupshostnameForSenders",
"serverBindAddressmemberName" : "serverBindAddressmemberName",
"cacheXmlFilePathbindAddress" : "cacheXmlFilePathbindAddress",
"locatorPortsenderCount" : 3,2
"heapUsage}, {
"connectedSenders" : 2 [ "connectedSenders", "connectedSenders" ],
"initHeapSizerunning" : 9true,
"logFilePathport" : "logFilePath"5,
"offHeapMemorySizehostnameForSenders" : "offHeapMemorySizehostnameForSenders",
"securedmemberName" : true"memberName",
"statArchiveFilePathbindAddress" : "statArchiveFilePathbindAddress",
"statussenderCount" : "status" 2
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult«Member,MemberInformation» ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found ANCHOR ="listMembersUsingGET"...
Up get
members
GET /management/v1/gateways/
membersGET /management/v1/gateways/
receivers
receivers
list membersgateway-receivers
Query parameters
group (optional)
Query Parameter -- group
id (optional)Query Parameter -- id
Return type
ClusterManagementListResult«Member,MemberInformation» ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo
Example data
Content-Type: application/json
{
"result" : [ {
"configurationgroups" : [ {
"idconfiguration" : "id",{
"groupstartPort" : "group"5,
},
"runtimeInfogatewayTransportFilters" : [ {
"cpuUsageinitProperties" : 5.637376656633329,
{
"serverkey" : { true,}
"httpServiceBindAddress" : "httpServiceBindAddress"},
"memberNameclassName" : "memberNameclassName",
"locators" : "locators"}, {
"processIdinitProperties" : 4,
{
"webSSLkey" : true,{ }
"hostedRegions" : [ "hostedRegions"},
"hostedRegions" ],
"hostclassName" : "hostclassName",
"maxHeapSize" :} 2],
"workingDirPathmanualStart" : "workingDirPath"true,
"idmaximumTimeBetweenPings" : "id"6,
"clientCountendPort" : 50,
"httpServicePortsocketBufferSize" : 71,
"cacheServerInfogroup" : [ {"group"
"running" : true},
"portruntimeInfo" : 1,[ {
"maxThreadsconnectedSenders" : 6,
"bindAddress" : "bindAddress"[ "connectedSenders", "connectedSenders" ],
"maxConnectionsrunning" : 0
}, {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, ],{
"coordinatorconnectedSenders" : true,
"groups" : "groups",
[ "connectedSenders", "connectedSenders" ],
"serverBindAddressrunning" : "serverBindAddress"true,
"cacheXmlFilePathport" : "cacheXmlFilePath"5,
"locatorPorthostnameForSenders" : 3"hostnameForSenders",
"heapUsagememberName" : 2"memberName",
"initHeapSizebindAddress" : 9"bindAddress",
"logFilePathsenderCount" : "logFilePath",2
} ]
"offHeapMemorySize" : "offHeapMemorySize"}, {
"securedconfiguration" : true,{
"statArchiveFilePathstartPort" : "statArchiveFilePath"5,
"statusgatewayTransportFilters" : [ "status"{
}, {
"cpuUsageinitProperties" : 5.637376656633329,{
"server" : true,
"httpServiceBindAddresskey" : "httpServiceBindAddress",
{ }
"memberName" : "memberName"},
"locatorsclassName" : "locatorsclassName",
"processId" : 4}, {
"webSSLinitProperties" : true,{
"hostedRegions" : [ "hostedRegions", "hostedRegionskey" ],
: { }
"host" : "host",
},
"maxHeapSize" : 2,
"workingDirPathclassName" : "workingDirPathclassName",
"id" :} "id"],
"clientCountmanualStart" : 5true,
"httpServicePortmaximumTimeBetweenPings" : 76,
"cacheServerInfoendPort" : [ {0,
"runningsocketBufferSize" : true1,
"portgroup" : 1,
"group"
},
"maxThreadsruntimeInfo" : 6,[ {
"bindAddressconnectedSenders" : [ "connectedSenders", "bindAddressconnectedSenders" ],
"maxConnectionsrunning" : 0
}, {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"coordinatorrunning" : true,
"groupsport" : "groups"5,
"serverBindAddresshostnameForSenders" : "serverBindAddresshostnameForSenders",
"cacheXmlFilePathmemberName" : "cacheXmlFilePathmemberName",
"locatorPortbindAddress" : 3"bindAddress",
"heapUsagesenderCount" : 2,
} ]
"initHeapSize" :} 9],
"logFilePathid" : "logFilePathid",
}, {
"offHeapMemorySizegroups" : "offHeapMemorySize", [ {
"securedconfiguration" : true,{
"statArchiveFilePathstartPort" : "statArchiveFilePath"5,
"statusgatewayTransportFilters" : "status"[ {
} ]
}, {
"configurationinitProperties" : {
"id" : "id",
"key" : { }
"group" : "group"
},
"runtimeInfo "className" : [ {"className"
"cpuUsage" : 5.637376656633329}, {
"serverinitProperties" : true,{
"httpServiceBindAddresskey" : "httpServiceBindAddress", { }
"memberName" : "memberName"},
"locatorsclassName" : "locatorsclassName",
"processId" :} 4],
"webSSLmanualStart" : true,
"hostedRegionsmaximumTimeBetweenPings" : [ "hostedRegions"6,
"hostedRegions" ],
"hostendPort" : "host"0,
"maxHeapSizesocketBufferSize" : 21,
"workingDirPathgroup" : "workingDirPath"group"
},
"idruntimeInfo" : "id",
[ {
"clientCountconnectedSenders" : 5,
"httpServicePort" : 7[ "connectedSenders", "connectedSenders" ],
"cacheServerInforunning" : [ {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, {
"runningconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
"portrunning" : 1true,
"maxThreadsport" : 65,
"bindAddresshostnameForSenders" : "bindAddresshostnameForSenders",
"maxConnectionsmemberName" : 0"memberName",
} ] "bindAddress" : "bindAddress",
"coordinatorsenderCount" : true,2
} ]
"groups" : "groups"}, {
"serverBindAddressconfiguration" : "serverBindAddress",
{
"cacheXmlFilePathstartPort" : "cacheXmlFilePath"5,
"locatorPortgatewayTransportFilters" : 3,
[ {
"heapUsageinitProperties" : 2,{
"initHeapSizekey" : { 9,}
"logFilePath" : "logFilePath"},
"offHeapMemorySizeclassName" : "offHeapMemorySizeclassName",
"secured" : true}, {
"statArchiveFilePath" : "statArchiveFilePath",
"statusinitProperties" : "status"{
}, {
"cpuUsagekey" : 5.637376656633329,
{ }
"server" : true},
"httpServiceBindAddressclassName" : "httpServiceBindAddressclassName",
"memberName" :} "memberName"],
"locatorsmanualStart" : "locators"true,
"processIdmaximumTimeBetweenPings" : 46,
"webSSLendPort" : true0,
"hostedRegionssocketBufferSize" : [ "hostedRegions", "hostedRegions" ],
1,
"hostgroup" : "hostgroup",
"maxHeapSize" : 2},
"workingDirPathruntimeInfo" : "workingDirPath",
[ {
"idconnectedSenders" : [ "idconnectedSenders",
"clientCountconnectedSenders" : 5],
"httpServicePort" : 7,
"cacheServerInforunning" : [ {true,
"runningport" : true5,
"porthostnameForSenders" : 1"hostnameForSenders",
"maxThreadsmemberName" : 6"memberName",
"bindAddress" : "bindAddress",
"maxConnectionssenderCount" : 02
}, {
"runningconnectedSenders" : true [ "connectedSenders", "connectedSenders" ],
"portrunning" : 1true,
"maxThreadsport" : 65,
"bindAddresshostnameForSenders" : "bindAddresshostnameForSenders",
"maxConnectionsmemberName" : 0"memberName",
} ],
"coordinatorbindAddress" : true"bindAddress",
"groupssenderCount" : "groups",2
"serverBindAddress" : "serverBindAddress",} ]
"cacheXmlFilePath" : "cacheXmlFilePath"} ],
"locatorPortid" : 3,
"heapUsageid" : 2,
"initHeapSize" : 9} ],
"logFilePathlinks" : "logFilePath",
"offHeapMemorySize{ "self" : "offHeapMemorySizeuri",
"secured" : true },
"statArchiveFilePathstatusMessage" : "statArchiveFilePathstatusMessage",
"statusstatusCode" : "statusOK"
} ]
} ],
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult«Member,MemberInformation»Responses
200
OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo401
Unauthorized403
Forbidden404
Not Found...
Member Management
ANCHOR ="configurePdxUsingPOST" Up post
configurations
pdx
GET /management/v1/
configurationsGET /management/v1/
members/
pdxmembers/
configure pdx
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
{id}
{id}
get member
Path parameters
Body Path Parameter -- pdxType id
Return type
Example data
Content-Type: application/json
ANCHOR ="checkRebalanceStatusUsingGET" check rebalance
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"linksresult" : {
},
"statusMessagegroups" : [ {
"statusMessage",configuration" : {
"statusCode "id" : "OKid"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Pdx already configured.500
Internal error.Ping
ANCHOR ="pingUsingGET"
ping
Return type
String
Example data
Content-Type: application/json
""
Responses
200
OK String401
Unauthorized403
Forbidden404
Not FoundRebalance Operation
{
"result" : {
"rebalanceRegionResults" : [ {
,
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"bucketCreateTimeInMillisecondshttpServiceBindAddress" : 6"httpServiceBindAddress",
"primaryTransferTimeInMillisecondsmemberName" : 7"memberName",
"bucketCreatesCompletedlocators" : 1"locators",
"bucketTransfersCompletedprocessId" : 24,
"bucketCreateByteswebSSL" : 0true,
"regionNamehostedRegions" : [ "hostedRegions", "regionNamehostedRegions" ],
"bucketTransferTimeInMillisecondshost" : 5"host",
"timeInMillisecondsmaxHeapSize" : 32,
"primaryTransfersCompletedworkingDirPath" : 9"workingDirPath",
"bucketTransferBytesid" : 5"id",
}, {
"bucketCreateTimeInMillisecondsclientCount" : 65,
"primaryTransferTimeInMillisecondshttpServicePort" : 7,
"bucketCreatesCompletedcacheServerInfo" : 1,
[ {
"bucketTransfersCompletedrunning" : 2true,
"bucketCreateBytesport" : 01,
"regionNamemaxThreads" : "regionName"6,
"bucketTransferTimeInMillisecondsbindAddress" : 5"bindAddress",
"timeInMillisecondsmaxConnections" : 3,
0
}, {
"primaryTransfersCompletedrunning" : 9true,
"bucketTransferBytesport" : 51,
} ],
"statusMessagemaxThreads" : "statusMessage"6,
},
"operationEndedbindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXbindAddress",
"operationStartmaxConnections" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links0
} ],
"coordinator" : { }true,
"operatorgroups" : "operatorgroups",
"statusMessageserverBindAddress" : "statusMessageserverBindAddress",
"statusCode "cacheXmlFilePath" : "OKcacheXmlFilePath"
}
Responses
200
OK ClusterManagementOperationStatusResult«RebalanceResult»401
Unauthorized403
Forbidden404
Not Found ANCHOR ="listRebalancesUsingGET"list rebalances
Return type
Example data
Content-Type: application/json
ANCHOR ="getIndexUsingGET" get index
Path parameters
id (required)
Path Parameter -- id
regionName (required)
Path Parameter -- regionName
Return type
Example data
Content-Type: application/json
{
"result" : [ {
,
"locatorPort" : 3,
"operationEndedheapUsage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"2,
"initHeapSize" : 9,
"operationStartlogFilePath" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXlogFilePath",
"operationIdoffHeapMemorySize" : "operationIdoffHeapMemorySize",
"operatorsecured" : "operator"true,
"statusMessagestatArchiveFilePath" : "statusMessagestatArchiveFilePath",
"statusCodestatus" : "OKstatus"
}, {
"operationEndedcpuUsage" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
5.637376656633329,
"operationStartserver" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"true,
"operationIdhttpServiceBindAddress" : "operationIdhttpServiceBindAddress",
"operatormemberName" : "operatormemberName",
"statusMessagelocators" : "statusMessagelocators",
"statusCodeprocessId" : 4,
"OK"
} "webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"links "host" : { },
"host",
"maxHeapSize" : 2,
"statusMessageworkingDirPath" : "statusMessageworkingDirPath",
"statusCodeid" : "OKid"
}
Responses
200
OK ClusterManagementListOperationsResult«RebalanceResult»401
Unauthorized403
Forbidden404
Not FoundANCHOR ="startRebalanceUsingPOST"
start rebalance
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- operation
Return type
Example data
Content-Type: application/json
{
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationResult«RebalanceResult»201
Created401
Unauthorized403
Forbidden404
Not FoundRegion Management
ANCHOR ="createRegionUsingPOST"
create region
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- regionConfig
Return type
Example data
Content-Type: application/json
{
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Region already exists.500
Internal error.ANCHOR ="deleteRegionUsingDELETE"
delete region
Path parameters
id (required)
Path Parameter -- id
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
{
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
ForbiddenANCHOR ="getRegionUsingGET"
get region
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"configuration" : {
"regionPath" : "regionPath,
"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",
"expressionoffHeapMemorySize" : "expressionoffHeapMemorySize",
"keyIndexsecured" : true,
"namestatArchiveFilePath" : "namestatArchiveFilePath",
"groupstatus" : "groupstatus"
},
} ]
}, {
"runtimeInfoconfiguration" : [ { {
"id" : "id",
"memberNamegroup" : "memberNamegroup"
}, {
"memberNameruntimeInfo" : [ "memberName"{
} ]
},
"links "cpuUsage" : 5.637376656633329,
"server" : { }true,
"statusMessage "httpServiceBindAddress" : "statusMessagehttpServiceBindAddress",
"statusCodememberName" : "OK"
}
Responses
200
OK ClusterManagementGetResult«Index,RuntimeInfo»401
Unauthorized403
Forbidden404
Not Found{
"result" : {
memberName",
"locators" : "locators",
"configurationprocessId" : {4,
"expirationswebSSL" : [ {true,
"actionhostedRegions" : [ "hostedRegions", "DESTROYhostedRegions" ],
"typehost" : "ENTRY_TIME_TO_LIVEhost",
"timeInSecondsmaxHeapSize" : 0
}, {2,
"actionworkingDirPath" : "DESTROYworkingDirPath",
"typeid" : "ENTRY_TIME_TO_LIVEid",
"timeInSecondsclientCount" : 05,
"httpServicePort" }: ]7,
"redundantCopiescacheServerInfo" : 6,[ {
"keyConstraint "running" : "keyConstraint"true,
"nameport" : "name"1,
"valueConstraintmaxThreads" : "valueConstraint"6,
"typebindAddress" : "PARTITIONbindAddress",
"diskStoreNamemaxConnections" : "diskStoreName",0
"group" : "group"
}, {
},
"runtimeInforunning" : true,
[ {
"entryCountport" : 1,
"memberNamemaxThreads" : "memberName"6,
}, {
"entryCountbindAddress" : 1"bindAddress",
"memberNamemaxConnections" : "memberName"0
} ],
},
"linkscoordinator" : { }true,
"statusMessage "groups" : "statusMessagegroups",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult«Region,RuntimeRegionInfo»401
Unauthorized403
Forbidden404
Not Found ANCHOR ="listAllIndexUsingGET"list indexes
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"serverBindAddress" : "serverBindAddress",
"configurationcacheXmlFilePath" : {
"cacheXmlFilePath",
"regionPathlocatorPort" : "regionPath"3,
"expressionheapUsage" : "expression"2,
"keyIndexinitHeapSize" : true9,
"namelogFilePath" : "namelogFilePath",
"groupoffHeapMemorySize" : "groupoffHeapMemorySize",
},
"runtimeInfosecured" : [ {
true,
"memberNamestatArchiveFilePath" : "memberNamestatArchiveFilePath",
}, {
"memberNamestatus" : "memberNamestatus"
} ]
}, {
"configurationcpuUsage" : {5.637376656633329,
"regionPathserver" : "regionPath"true,
"expressionhttpServiceBindAddress" : "expressionhttpServiceBindAddress",
"keyIndexmemberName" : true"memberName",
"namelocators" : "namelocators",
"groupprocessId" : "group"4,
},
"runtimeInfowebSSL" : [ {
true,
"memberNamehostedRegions" : [ "memberNamehostedRegions"
, "hostedRegions" ],
}, {
"memberNamehost" : "memberNamehost",
} ]
"maxHeapSize" }: ]2,
"links" : { },
"statusMessageworkingDirPath" : "statusMessageworkingDirPath",
"statusCode "id" : "OKid"
}
Responses
200
OK ClusterManagementListResult«Index,RuntimeInfo»401
Unauthorized403
Forbidden404
Not Found,
"clientCount" : 5,
"httpServicePort" : 7,
ANCHOR ="listIndexUsingGET" list region indexes
Path parameters
regionName (required)
Path Parameter -- regionName
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
ANCHOR ="listRegionUsingGET" list regions
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"configuration" : {
"regionPathcacheServerInfo" : "regionPath",
[ {
"expressionrunning" : "expression"true,
"keyIndexport" : true1,
"name" : "namemaxThreads" : 6,
"groupbindAddress" : "groupbindAddress",
},
"runtimeInfomaxConnections" : [0
{
"memberName" : "memberName"}, {
}, {
"memberNamerunning" : "memberName"
true,
} ]
}, {
"configurationport" : {1,
"regionPathmaxThreads" : "regionPath"6,
"expressionbindAddress" : "expressionbindAddress",
"keyIndexmaxConnections" : true,0
"name" :} "name"],
"groupcoordinator" : "group"true,
},
"runtimeInfogroups" : [ {
"groups",
"memberNameserverBindAddress" : "memberNameserverBindAddress",
}, {
"memberNamecacheXmlFilePath" : "memberNamecacheXmlFilePath",
} ]
} ],
"linkslocatorPort" : { }3,
"statusMessage" : "statusMessage",
"statusCodeheapUsage" : "OK"
}
Responses
200
OK ClusterManagementListResult«Index,RuntimeInfo»401
Unauthorized403
Forbidden404
Not Found{
"result" : [ {
2,
"configurationinitHeapSize" : {9,
"expirationslogFilePath" : [ {"logFilePath",
"actionoffHeapMemorySize" : "DESTROYoffHeapMemorySize",
"typesecured" : "ENTRY_TIME_TO_LIVE"true,
"timeInSeconds" : 0
}, {
"action"statArchiveFilePath" : "DESTROYstatArchiveFilePath",
"typestatus" : "ENTRY_TIME_TO_LIVE",status"
"timeInSeconds" : 0} ]
} ],
"redundantCopies" : 6,
"keyConstraint""id" : "keyConstraintid",
"name" : "name"},
"valueConstraintlinks" : "valueConstraint",
"type{ "self" : "PARTITIONuri" },
"diskStoreNamestatusMessage" : "diskStoreNamestatusMessage",
"groupstatusCode" : "group"
},
"runtimeInfoOK"
}
Responses
200
OK ClusterManagementGetResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/members
GET /management/v1/members
list members
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"entryCountgroups" : 1,[ {
"memberNameconfiguration" : "memberName"
}, {
{
"entryCountid" : 1"id",
"memberNamegroup" : "memberNamegroup"
} ]
}, {
"configuration" : {
"expirationsruntimeInfo" : [ {
"actioncpuUsage" : "DESTROY"5.637376656633329,
"typeserver" : "ENTRY_TIME_TO_LIVE"true,
"timeInSecondshttpServiceBindAddress" : 0"httpServiceBindAddress",
}, { "memberName" : "memberName",
"actionlocators" : "DESTROYlocators",
"typeprocessId" : "ENTRY_TIME_TO_LIVE"4,
"timeInSecondswebSSL" : 0true,
"hostedRegions" : [ }"hostedRegions", "hostedRegions" ],
"redundantCopieshost" : 6"host",
"keyConstraintmaxHeapSize" : "keyConstraint"2,
"nameworkingDirPath" : "nameworkingDirPath",
"valueConstraintid" : "valueConstraintid",
"typeclientCount" : "PARTITION"5,
"diskStoreNamehttpServicePort" : "diskStoreName"7,
"groupcacheServerInfo" : [ {
"group"
},
"runtimeInfo" : [ {
"entryCount" : 1,
"memberName" : "memberName"
}, {
"entryCount" : 1,
"memberName" : "memberName"
} ]
} ],
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult«Region,RuntimeRegionInfo»401
Unauthorized403
Forbidden404
Not FoundModels
...
Table of Contents
CacheServerInfo
- CacheServerInfoClassName
- ClassNameClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
- ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»ClusterManagementGetResult«Index,RuntimeInfo»
- ClusterManagementGetResult«Index,RuntimeInfo»ClusterManagementGetResult«Member,MemberInformation»
- ClusterManagementGetResult«Member,MemberInformation»ClusterManagementGetResult«Region,RuntimeRegionInfo»
- ClusterManagementGetResult«Region,RuntimeRegionInfo»ClusterManagementListOperationsResult«RebalanceResult»
- ClusterManagementListOperationsResult«RebalanceResult»ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»
- ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»ClusterManagementListResult«Index,RuntimeInfo»
- ClusterManagementListResult«Index,RuntimeInfo»ClusterManagementListResult«Member,MemberInformation»
- ClusterManagementListResult«Member,MemberInformation»ClusterManagementListResult«Region,RuntimeRegionInfo»
- ClusterManagementListResult«Region,RuntimeRegionInfo»ClusterManagementOperationResult«RebalanceResult»
- ClusterManagementOperationResult«RebalanceResult»ClusterManagementOperationStatusResult«RebalanceResult»
- ClusterManagementOperationStatusResult«RebalanceResult»ClusterManagementResult
- ClusterManagementResultConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
- ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»ConfigurationResult«Index,RuntimeInfo»
- ConfigurationResult«Index,RuntimeInfo»ConfigurationResult«Member,MemberInformation»
- ConfigurationResult«Member,MemberInformation»ConfigurationResult«Region,RuntimeRegionInfo»
- ConfigurationResult«Region,RuntimeRegionInfo»Expiration
- ExpirationGatewayReceiver
- GatewayReceiverGatewayReceiverInfo
- GatewayReceiverInfoIndex
- IndexLinks
- LinksMember
- MemberMemberInformation
- MemberInformationPdx
- PdxRebalanceOperation
- RebalanceOperationRebalanceRegionResult
- RebalanceRegionResultRebalanceResult
- RebalanceResultRegion
- RegionRuntimeInfo
- RuntimeInfoRuntimeRegionInfo
- RuntimeRegionInfo
CacheServerInfo
- CacheServerInfo Up
bindAddress (optional)
String
maxConnections (optional)
Integer format: int32
maxThreads (optional)
Integer format: int32
port (optional)
Integer format: int32
running (optional)
Boolean
running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
}, {
"configuration" : {
"id" : "id",
"group" : "group"
},
"runtimeInfo" : [ {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
}, {
"cpuUsage" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress",
"memberName" : "memberName",
"locators" : "locators",
"processId" : 4,
"webSSL" : true,
"hostedRegions" : [ "hostedRegions", "hostedRegions" ],
"host" : "host",
"maxHeapSize" : 2,
"workingDirPath" : "workingDirPath",
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,
"initHeapSize" : 9,
"logFilePath" : "logFilePath",
"offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "status"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Member_MemberInformation401
Unauthorized403
Forbidden404
Not Found...
Pdx Management
POST /management/v1/configurations/pdx
POST /management/v1/configurations/pdx
configure pdx
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- pdxType
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Pdx already configured.500
Internal error....
GET /management/v1/configurations/pdx
GET /management/v1/configurations/pdx
get pdx
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {
"configuration" : {
"autoSerializer" : {
"patterns" : [ "patterns", "patterns" ],
"portable" : true
},
"readSerialized" : true,
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
}
},
"runtimeInfo" : [ {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
}, {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
} ]
}, {
"configuration" : {
"autoSerializer" : {
"patterns" : [ "patterns", "patterns" ],
"portable" : true
},
"readSerialized" : true,
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
}
},
"runtimeInfo" : [ {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
}, {
"readSerialized" : true,
"memberName" : "memberName",
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Pdx_PdxInfo401
Unauthorized403
Forbidden404
Not Found...
Ping
GET /management/v1/ping
GET /management/v1/ping
ping
Return type
String
Example data
Content-Type: application/json
""
Responses
200
OK String401
Unauthorized403
Forbidden404
Not Found...
Rebalance Operation
GET /management/v1/operations/rebalances/{id}
GET /management/v1/operations/rebalances/{id}
check rebalance
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"rebalanceRegionResults" : [ {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 7,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5
}, {
"bucketCreateTimeInMilliseconds" : 6,
"primaryTransferTimeInMilliseconds" : 7,
"bucketCreatesCompleted" : 1,
"bucketTransfersCompleted" : 2,
"bucketCreateBytes" : 0,
"regionName" : "regionName",
"bucketTransferTimeInMilliseconds" : 5,
"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5
} ],
"success" : true,
"statusMessage" : "statusMessage"
},
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links" : { "self" : "uri" },
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationStatusResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/operations/rebalances
GET /management/v1/operations/rebalances
list rebalances
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}, {
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListOperationsResult_RebalanceResult401
Unauthorized403
Forbidden404
Not Found...
POST /management/v1/operations/rebalances
POST /management/v1/operations/rebalances
start rebalance
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- operation
Return type
Example data
Content-Type: application/json
{
"operationEnded" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationId" : "operationId",
"operator" : "operator",
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementOperationResult_RebalanceResult201
Created401
Unauthorized403
Forbidden404
Not Found...
Region Management
POST /management/v1/regions/{regionName}/indexes
POST /management/v1/regions/{regionName}/indexes
create region index
Path parameters
regionName (required)
Path Parameter -- regionName
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- indexConfig
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Index already exists.500
Internal error....
POST /management/v1/indexes
POST /management/v1/indexes
create index
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- indexConfig
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Index already exists.500
Internal error....
POST /management/v1/regions
POST /management/v1/regions
create region
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
Body Parameter -- regionConfig
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult201
Created400
Bad request.401
Unauthorized403
Forbidden404
Not Found409
Region already exists.500
Internal error....
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
DELETE /management/v1/regions/{regionName}/indexes/{indexName}
delete region index
Path parameters
indexName (required)
Path Parameter -- indexName
regionName (required)
Path Parameter -- regionName
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
DELETE /management/v1/regions/{id}
DELETE /management/v1/regions/{id}
delete region
Path parameters
id (required)
Path Parameter -- id
Query parameters
group (optional)
Query Parameter -- group
Return type
Example data
Content-Type: application/json
{
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementResult204
No Content401
Unauthorized403
Forbidden...
GET /management/v1/regions/{regionName}/indexes/{id}
GET /management/v1/regions/{regionName}/indexes/{id}
get index
Path parameters
id (required)
Path Parameter -- id
regionName (required)
Path Parameter -- regionName
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{id}
GET /management/v1/regions/{id}
get region
Path parameters
id (required)
Path Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : {
"groups" : [ {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementGetResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/indexes
GET /management/v1/indexes
list indexes
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions/{regionName}/indexes
GET /management/v1/regions/{regionName}/indexes
list region indexes
Path parameters
regionName (required)
Path Parameter -- regionName
Query parameters
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Index_IndexInfo401
Unauthorized403
Forbidden404
Not Found...
GET /management/v1/regions
GET /management/v1/regions
list regions
Query parameters
group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"groups" : [ {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
}, {
"groups" : [ {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"expirations" : [ {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
}, {
"action" : "DESTROY",
"type" : "ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 1
} ],
"redundantCopies" : 5,
"eviction" : {
"entryCount" : 0,
"objectSizer" : {
"initProperties" : {
"key" : { }
},
"className" : "className"
},
"action" : "LOCAL_DESTROY",
"type" : "ENTRY_COUNT",
"memorySizeMb" : 6
},
"keyConstraint" : "keyConstraint",
"name" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 5,
"memberName" : "memberName"
}, {
"entryCount" : 5,
"memberName" : "memberName"
} ]
} ],
"id" : "id"
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}
Responses
200
OK ClusterManagementListResult_Region_RuntimeRegionInfo401
Unauthorized403
Forbidden404
Not Found...
Models
AutoSerializer
portable (optional)
Boolean
patterns (optional)
array[String]
CacheServerInfo
bindAddress (optional)
String
maxConnections (optional)
Integer format: int32
maxThreads (optional)
Integer format: int32
port (optional)
Integer format: int32
running (optional)
Boolean
ClassName
className (optional)
String
initProperties (optional)
map[String, Object]
ClusterManagementGetResult_Deployment_DeploymentInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult_Index_IndexInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult_Member_MemberInformation
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult_Pdx_PdxInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult_Region_RuntimeRegionInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListOperationsResult_RebalanceResult
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListResult_Deployment_DeploymentInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo
ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo»
- ClusterManagementGetResult«GatewayReceiver,GatewayReceiverInfo» Uplinks (optional)
result (optional)
ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» array[EntityInfo_GatewayReceiver_GatewayReceiverInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult«Index,RuntimeInfo»
- ClusterManagementGetResult«Index,RuntimeInfo» UpClusterManagementListResult_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«Member,MemberInformation» UpClusterManagementListResult_Member_MemberInformation
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult«Region,RuntimeRegionInfo»
- ClusterManagementGetResult«Region,RuntimeRegionInfo» UpClusterManagementListResult_Region_RuntimeRegionInfo
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementOperationResult_RebalanceResult
links (optional)
operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String
operationStart (optional)
String
ClusterManagementListOperationsResult«RebalanceResult»
- ClusterManagementListOperationsResult«RebalanceResult» Up
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator links (optional)
result (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
ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo»
- ClusterManagementListResult«GatewayReceiver,GatewayReceiverInfo» UpClusterManagementOperationStatusResult_RebalanceResult
links (optional)
result (optional)
statusCode operationEnded (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart statusMessage (optional)
String
ClusterManagementListResult«Index,RuntimeInfo»
- ClusterManagementListResult«Index,RuntimeInfo» Up
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListResult«Member,MemberInformation»
- ClusterManagementListResult«Member,MemberInformation» UpClusterManagementResult
links (optional)
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementListResult«Region,RuntimeRegionInfo»
- ClusterManagementListResult«Region,RuntimeRegionInfo» Up
Deployment
deployedBy links (optional)
result deployedTime (optional)
String
group statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
jarFileName (optional)
String
DeploymentInfo
jarLocation statusMessage (optional)
String
ClusterManagementOperationResult«RebalanceResult»
- ClusterManagementOperationResult«RebalanceResult» Up
links lastModified (optional)
operationEnded memberName (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
DocLinks
latest operationId (optional)
String
operationStart supported (optional)
array[String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
]
EntityGroupInfo_Deployment_DeploymentInfo
configuration operator (optional)
statusCode runtimeInfo (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementOperationStatusResult«RebalanceResult»
- ClusterManagementOperationStatusResult«RebalanceResult» Up
links (optional)
operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
result (optional)
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementResult
- ClusterManagementResult Up
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
EntityInfo_Deployment_DeploymentInfo
groups (optional)
id (optional)
String
links (optional)
EntityInfo_GatewayReceiver_GatewayReceiverInfo
groups (optional)
id (optional)
String
links (optional)
EntityInfo_Member_MemberInformation
ConfigurationResult«GatewayReceiver,GatewayReceiverInfo»
- ConfigurationResult«GatewayReceiver,GatewayReceiverInfo» Up
EntityInfo_Pdx_PdxInfo
groups runtimeInfo (optional)
array[GatewayReceiverInfo]
ConfigurationResult«Index,RuntimeInfo»
- ConfigurationResult«Index,RuntimeInfo» Up
EntityInfo_Region_RuntimeRegionInfo
groups runtimeInfo (optional)
array[RuntimeInfo]
ConfigurationResult«Member,MemberInformation»
- ConfigurationResult«Member,MemberInformation» Up
id configuration (optional)
links (optional)
Eviction
action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount runtimeInfo (optional)
ConfigurationResult«Region,RuntimeRegionInfo»
- ConfigurationResult«Region,RuntimeRegionInfo» Up
Integer format: int32
memorySizeMb (optional)
Integer format: int32
objectSizer configuration (optional)
links type (optional)
runtimeInfo (optional)
Expiration
- Expiration UpString
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
- GatewayReceiver UpendPort (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
- GatewayReceiverInfo UpbindAddress (optional)
String
connectedSenders (optional)
array[String]
hostnameForSenders (optional)
String
memberName (optional)
String
port (optional)
Integer format: int32
running (optional)
Boolean
senderCount (optional)
Integer format: int32
Index
- Index
Upexpression (optional)
String
group indexType (optional)
String
Enum:
KEY
RANGE
HASH_DEPRECATED
name keyIndex (optional)
Boolean String
name regionPath (optional)
String
IndexInfo
memberName regionPath (optional)
String
MemberInformation
- MemberInformation UpcacheServerInfo (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
- PdxautoSerializer (optional)
diskStoreName (optional)
String
ignoreUnreadFields (optional)
Boolean
pdxSerializer (optional)
readSerialized (optional)
Boolean
PdxInfo
diskStoreName (optional)
String
ignoreUnreadFields persistent (optional)
Boolean
memberName (optional)
String
pdxSerializer (optional)
String
readSerialized (optional)
Boolean
RebalanceOperation
- RebalanceOperation UpexcludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
simulate (optional)
Boolean
RebalanceRegionResult
- RebalanceRegionResult
UpbucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64
RebalanceResult
- RebalanceResult UprebalanceRegionResults (optional)
statusMessage (optional)
String
success (optional)
Boolean
Region
- Region UpdiskStoreName (optional)
String
eviction (optional)
expirations (optional)
group (optional)
String
keyConstraint (optional)
String
name (optional)
String
redundantCopies (optional)
Integer format: int32
type (optional)
String
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
valueConstraint (optional)
String
RuntimeInfo
- RuntimeInfo Up
memberName (optional)
String
RuntimeRegionInfo
- RuntimeRegionInfo
UpentryCount (optional)
Long format: int64
memberName (optional)
String