Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: automatically generated from 1.12.0 by update-management-wiki.sh

...

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

Versions

GET /management

get documentation-links

Return type

Object

Example data

Content-Type: application/json
{ }

Responses

200

OK Object

401

Unauthorized

403

Forbidden

404

Not Found

Gateway Management

Deployment Management

GET

POST

 /management/v1/

gateways

deployments/

receivers
create gateway-receiver

Consumes

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

Request body

{id}

get deployed

Path parameters

id body GatewayReceiver (required)
Request Body Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"linksresult" : {
"selfconfigurationByGroup" : "uri" },
[ {
"statusMessage" : "statusMessage",
"statusCodeconfiguration" : "OK"
}

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error. GET
 
/management/v1/gateways/receivers/
{
id}

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
"configurationdeployedTime" : {
"deployedTime",
"startPortdeployedBy" : 5"deployedBy",
"gatewayTransportFiltersjarFileName" : [ {"jarFileName",
"initPropertiesgroup" : {"group"
},
"keyruntimeInfo" : [ {
}
"jarLocation" : }"jarLocation",
"classNamememberName" : "classNamememberName",
}, {
"lastModified" : "lastModified"
"initProperties" :}, {
"jarLocation" : "keyjarLocation",
: { }
"memberName" : }"memberName",
"classNamelastModified" : "classNamelastModified"
} ]
}, {
"manualStartconfiguration" : true,{
"maximumTimeBetweenPingsdeployedTime" : 6"deployedTime",
"endPortdeployedBy" : 0"deployedBy",
"socketBufferSizejarFileName" : 1"jarFileName",
"group" : "group"
},
"runtimeInfo" : [ {
"connectedSendersjarLocation" : [ "connectedSendersjarLocation",
"connectedSenders" ],
"runningmemberName" : true"memberName",
"portlastModified" : 5,
"lastModified"
}, {
"hostnameForSendersjarLocation" : "hostnameForSendersjarLocation",
"memberName" : "memberName",
"bindAddresslastModified" : "bindAddresslastModified",
"senderCount" : 2} ]
} ], {
"connectedSendersid" : [ "connectedSendersid",
"connectedSenders" ]},
"runninglinks" : true,
{ "portself" : 5,
"hostnameForSenders" : "hostnameForSenders",
"uri" },
"memberNamestatusMessage" : "memberNamestatusMessage",
"bindAddressstatusCode" : "bindAddressOK",
"senderCount" : 2
} ]
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_GatewayReceiverDeployment_GatewayReceiverInfoDeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/

gateways/receivers

deployments

list gateway-receiversdeployed

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"configuration" : {
"startPortdeployedTime" : 5"deployedTime",
"gatewayTransportFiltersdeployedBy" : [ {
"deployedBy",
"initPropertiesjarFileName" : {"jarFileName",
"group" : "keygroup"
: { },
"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" : [ "connectedSenders", "connectedSenders" ]jarLocation",
"runningmemberName" : true"memberName",
"portlastModified" : 5,"lastModified"
"hostnameForSenders" : "hostnameForSenders",}, {
"memberNamejarLocation" : "memberNamejarLocation",
"bindAddressmemberName" : "bindAddressmemberName",
"senderCountlastModified" : 2"lastModified"
}, {]
} ],
"connectedSenderslinks" : [{ "connectedSendersself", : "connectedSendersuri" ]},
"runningstatusMessage" : true"statusMessage",
"statusCode" : "port" : 5,
"hostnameForSendersOK"
}

Responses

200

OK ClusterManagementListResult_Deployment_DeploymentInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Versions

GET /management

get documentation-links

Return type

Example data

Content-Type: application/json
{
"latest" : "hostnameForSenderslatest",
"supported" : [ "memberNamesupported", : "supported" ]
}

Responses

200

OK DocLinks

401

Unauthorized

403

Forbidden

404

Not Found

...

Gateway Management

POST /management/v1/gateways/receivers

create gateway-receiver

Consumes

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

Request body

body GatewayReceiver (required)
Request Body

Return type

Example data

Content-Type: application/json
{
"links" : { "selfmemberName",
"bindAddress" : "bindAddressuri" },
"statusMessage" : "statusMessage",
"senderCountstatusCode" : "OK"
}

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Gateway receiver already exists.

500

Internal error.

...

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

get gateway-receiver

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
"configurationByGroup" : [ {
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
} ]
}, ],{
"linksconfiguration" : {
"selfstartPort" : "uri" }5,
"statusMessagegatewayTransportFilters" : "statusMessage",
[ {
"statusCodeinitProperties" : "OK"
}

Responses

200

OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

Member Management

GET /management/v1/members/{id}

get member

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result{
"key" : { }
"configuration" : {
},
"id" : "id",
"groupclassName" : "groupclassName"
}, {
"runtimeInfoinitProperties" : [ {
"cpuUsage" : 5.637376656633329,
"serverkey" : true,{ }
"httpServiceBindAddress" : "httpServiceBindAddress"},
"memberName" : "memberName",
"locatorsclassName" : "locatorsclassName",
"processId" :} 4],
"webSSLmanualStart" : true,
"hostedRegionsmaximumTimeBetweenPings" : [ "hostedRegions"6,
"hostedRegions" ],
"hostendPort" : "host"0,
"maxHeapSizesocketBufferSize" : 21,
"workingDirPathgroup" : "workingDirPathgroup",
"id" : "id"},
"clientCountruntimeInfo" : [ 5,{
"httpServicePortconnectedSenders" : [ 7,
"connectedSenders", "cacheServerInfoconnectedSenders" : [ {],
"running" : true,
"port" : 15,
"maxThreadshostnameForSenders" : 6"hostnameForSenders",
"memberName" : "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",
} ]
} ],
"serverBindAddressid" : "serverBindAddressid"
},
"links" : { "cacheXmlFilePathself" : "cacheXmlFilePathuri" },
"locatorPortstatusMessage" : 3"statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/gateways/receivers

list gateway-receivers

Query parameters

group (optional)
Query Parameter -- group

Return type

Example data

Content-Type: application/json
{
"result "heapUsage" : [ 2,{
"initHeapSizeconfiguration" : 9,{
"logFilePathstartPort" : "logFilePath"5,
"offHeapMemorySizegatewayTransportFilters" : "offHeapMemorySize",
[ {
"securedinitProperties" : true,
{
"statArchiveFilePathkey" : "statArchiveFilePath", { }
"status },
"className" : "statusclassName"
}, {
"cpuUsageinitProperties" : 5.637376656633329,
{
"serverkey" : true,{ }
"httpServiceBindAddress" : "httpServiceBindAddress"},
"memberNameclassName" : "memberName"className"
} ],
"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
} ],
}, {
"coordinatorconfiguration" : true,{
"groupsstartPort" : "groups"5,
"serverBindAddressgatewayTransportFilters" : "serverBindAddress", [ {
"cacheXmlFilePathinitProperties" : "cacheXmlFilePath",{
"locatorPortkey" : { 3,}
"heapUsage" : 2},
"initHeapSizeclassName" : 9,"className"
"logFilePath" : "logFilePath",
}, {
"offHeapMemorySizeinitProperties" : "offHeapMemorySize",
{
"securedkey" : { true,}
"statArchiveFilePath" : "statArchiveFilePath"},
"statusclassName" : "statusclassName"
} ],
},
"linksmanualStart" : { true,
"selfmaximumTimeBetweenPings" : "uri" }6,
"statusMessageendPort" : "statusMessage"0,
"statusCodesocketBufferSize" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/members

list members

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
1,
"group" : "group"
},{
"result" : [ {
"configurationruntimeInfo" : [ {
"idconnectedSenders" : [ "connectedSenders", "idconnectedSenders" ],
"grouprunning" : "group"
true,
},
"runtimeInfoport" : [ {5,
"cpuUsagehostnameForSenders" : 5.637376656633329,
"server" : true,
"httpServiceBindAddress" : "httpServiceBindAddress""hostnameForSenders",
"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} ],
"links" : [ {
"self" : "uri" },
"runningstatusMessage" : true"statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Member Management

GET /management/v1/members/{id}

get member

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result "port" : 1,{
"configurationByGroup" : [ {
"maxThreadsconfiguration" : 6,{
"bindAddressid" : "bindAddressid",
"maxConnectionsgroup" : 0"group"
}, {
"runningruntimeInfo" : [ true,{
"portcpuUsage" : 15.637376656633329,
"maxThreadsserver" : 6true,
"bindAddresshttpServiceBindAddress" : "bindAddresshttpServiceBindAddress",
"maxConnectionsmemberName" : 0
} ],
"memberName",
"coordinatorlocators" : true"locators",
"groupsprocessId" : "groups"4,
"serverBindAddresswebSSL" : "serverBindAddress"true,
"cacheXmlFilePathhostedRegions" : [ "cacheXmlFilePathhostedRegions",
"locatorPorthostedRegions" : 3],
"heapUsagehost" : 2"host",
"initHeapSizemaxHeapSize" : 92,
"logFilePathworkingDirPath" : "logFilePathworkingDirPath",
"offHeapMemorySizeid" : "offHeapMemorySizeid",
"securedclientCount" : true5,
"statArchiveFilePathhttpServicePort" : "statArchiveFilePath"7,
"statuscacheServerInfo" : [ "status"{
}, {
"cpuUsagerunning" : 5.637376656633329true,
"serverport" : true1,
"httpServiceBindAddressmaxThreads" : "httpServiceBindAddress"6,
"memberNamebindAddress" : "memberNamebindAddress",
"locatorsmaxConnections" : "locators",0
"processId" : 4}, {
"webSSLrunning" : true,
"hostedRegions" : [ "hostedRegionsport", "hostedRegions": ]1,
"hostmaxThreads" : "host"6,
"maxHeapSize" : 2,
"workingDirPathbindAddress" : "workingDirPathbindAddress",
"idmaxConnections" : "id",0
"clientCount" :} 5],
"httpServicePortcoordinator" : 7true,
"cacheServerInfogroups" : [ {"groups",
"runningserverBindAddress" : true"serverBindAddress",
"portcacheXmlFilePath" : 1"cacheXmlFilePath",
"maxThreadslocatorPort" : 63,
"bindAddressheapUsage" : "bindAddress"2,
"maxConnectionsinitHeapSize" : 0
}, {9,
"runninglogFilePath" : true"logFilePath",
"portoffHeapMemorySize" : 1"offHeapMemorySize",
"maxThreadssecured" : 6true,
"bindAddressstatArchiveFilePath" : "bindAddressstatArchiveFilePath",
"maxConnectionsstatus" : 0"status"
}, ],{
"coordinatorcpuUsage" : true5.637376656633329,
"groupsserver" : "groups"true,
"serverBindAddresshttpServiceBindAddress" : "serverBindAddresshttpServiceBindAddress",
"cacheXmlFilePathmemberName" : "cacheXmlFilePathmemberName",
"locatorPortlocators" : 3"locators",
"heapUsageprocessId" : 24,
"initHeapSizewebSSL" : 9true,
"logFilePathhostedRegions" : [ "hostedRegions", "logFilePathhostedRegions" ],
"offHeapMemorySizehost" : "offHeapMemorySizehost",
"securedmaxHeapSize" : true2,
"statArchiveFilePathworkingDirPath" : "statArchiveFilePathworkingDirPath",
"statusid" : "statusid",
} ]
}, {
"configurationclientCount" : {5,
"idhttpServicePort" : "id"7,
"groupcacheServerInfo" : [ "group"{
},
"runtimeInforunning" : true,
[ {
"cpuUsageport" : 5.6373766566333291,
"servermaxThreads" : true6,
"httpServiceBindAddressbindAddress" : "httpServiceBindAddressbindAddress",
"memberNamemaxConnections" : "memberName",0
"locators" : "locators"}, {
"processIdrunning" : 4true,
"webSSLport" : true1,
"hostedRegions" : [ "hostedRegionsmaxThreads", "hostedRegions": ]6,
"hostbindAddress" : "hostbindAddress",
"maxHeapSize" : 2,
"workingDirPathmaxConnections" : "workingDirPath",0
"id" :} "id"],
"clientCountcoordinator" : 5true,
"httpServicePortgroups" : 7"groups",
"cacheServerInfoserverBindAddress" : [ {"serverBindAddress",
"runningcacheXmlFilePath" : true"cacheXmlFilePath",
"portlocatorPort" : 13,
"maxThreadsheapUsage" : 62,
"bindAddressinitHeapSize" : "bindAddress"9,
"maxConnectionslogFilePath" : 0
}, {"logFilePath",
"runningoffHeapMemorySize" : true"offHeapMemorySize",
"portsecured" : 1true,
"maxThreadsstatArchiveFilePath" : 6"statArchiveFilePath",
"bindAddressstatus" : "bindAddressstatus",
"maxConnections" : 0} ]
}, ],{
"coordinatorconfiguration" : true,{
"groupsid" : "groupsid",
"serverBindAddressgroup" : "serverBindAddressgroup",
"cacheXmlFilePath" : "cacheXmlFilePath"},
"locatorPortruntimeInfo" : [ 3,{
"heapUsagecpuUsage" : 25.637376656633329,
"initHeapSizeserver" : 9true,
"logFilePathhttpServiceBindAddress" : "logFilePathhttpServiceBindAddress",
"offHeapMemorySizememberName" : "offHeapMemorySizememberName",
"securedlocators" : true"locators",
"statArchiveFilePathprocessId" : "statArchiveFilePath"4,
"statuswebSSL" : "status"true,
}, {
"hostedRegions" : [ "cpuUsagehostedRegions", : 5.637376656633329"hostedRegions" ],
"serverhost" : true"host",
"httpServiceBindAddressmaxHeapSize" : "httpServiceBindAddress"2,
"memberNameworkingDirPath" : "memberNameworkingDirPath",
"locatorsid" : "locatorsid",
"processIdclientCount" : 45,
"webSSLhttpServicePort" : true7,
"hostedRegionscacheServerInfo" : [ "hostedRegions", "hostedRegions" ],
{
"hostrunning" : "host"true,
"maxHeapSizeport" : 21,
"workingDirPathmaxThreads" : "workingDirPath"6,
"idbindAddress" : "idbindAddress",
"clientCount" : 5,
"httpServicePortmaxConnections" : 7,0
"cacheServerInfo" : [}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ], {
"runningcoordinator" : true,
"portgroups" : 1"groups",
"maxThreadsserverBindAddress" : 6"serverBindAddress",
"bindAddresscacheXmlFilePath" : "bindAddresscacheXmlFilePath",
"maxConnectionslocatorPort" : 03,
"heapUsage" }: ]2,
"coordinatorinitHeapSize" : true9,
"groupslogFilePath" : "groupslogFilePath",
"serverBindAddressoffHeapMemorySize" : "serverBindAddressoffHeapMemorySize",
"cacheXmlFilePathsecured" : "cacheXmlFilePath"true,
"locatorPortstatArchiveFilePath" : 3"statArchiveFilePath",
"heapUsagestatus" : 2,
"status"
}, {
"initHeapSizecpuUsage" : 95.637376656633329,
"logFilePathserver" : "logFilePath"true,
"offHeapMemorySizehttpServiceBindAddress" : "offHeapMemorySizehttpServiceBindAddress",
"securedmemberName" : true"memberName",
"statArchiveFilePathlocators" : "statArchiveFilePathlocators",
"statusprocessId" : "status"
4,
} ]
} ],
"linkswebSSL" : { "selftrue,
"hostedRegions" : [ "uri"hostedRegions", "hostedRegions" }],
"statusMessagehost" : "host",
"statusMessage" "maxHeapSize" : 2,
"statusCode "workingDirPath" : "OKworkingDirPath"
}

Responses

200

OK ClusterManagementListResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

Pdx Management

POST /management/v1/configurations/pdx

configure pdx

Consumes

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

Request body

body Pdx (required)
Body Parameter -- pdxType

Return type

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

GET /management/v1/configurations/pdx

get pdx

Return type

Example data

Content-Type: application/json
{
"result" : {
"configuration" : {
,
"id" : "id",
"clientCount" : 5,
"httpServicePort" : 7,
"cacheServerInfo" : [ {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"autoSerializermaxConnections" : {0
"patterns" : [ "patterns", "patterns" ],
}, {
"portablerunning" : true,
},
"readSerializedport" : true1,
"diskStoreNamemaxThreads" : "diskStoreName"6,
"ignoreUnreadFieldsbindAddress" : true"bindAddress",
"pdxSerializermaxConnections" : { 0
} ],
"initPropertiescoordinator" : {true,
"groups" : "keygroups",
: { }
"serverBindAddress" : }"serverBindAddress",
"classNamecacheXmlFilePath" : "classNamecacheXmlFilePath",
}
"locatorPort" : }3,
"runtimeInfoheapUsage" : 2,
[ {
"readSerializedinitHeapSize" : true9,
"memberNamelogFilePath" : "memberNamelogFilePath",
"diskStoreNameoffHeapMemorySize" : "diskStoreNameoffHeapMemorySize",
"ignoreUnreadFieldssecured" : true,
"pdxSerializerstatArchiveFilePath" : "pdxSerializerstatArchiveFilePath",
}, {
"status" : "readSerializedstatus" : true,
"memberName" : "memberName",} ]
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
} ],
"pdxSerializerid" : "pdxSerializer"
} ]id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_PdxMember_PdxInfoMemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

...

GET /management/v1/

pingping

members

list members

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result"

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

Rebalance Operation

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

check rebalance

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
: [ {
"configuration" : {
"id" : "id",
"rebalanceRegionResultsgroup" : [ {
"group"
},
"bucketCreateTimeInMillisecondsruntimeInfo" : [ 6,{
"primaryTransferTimeInMillisecondscpuUsage" : 75.637376656633329,
"bucketCreatesCompletedserver" : 1true,
"bucketTransfersCompletedhttpServiceBindAddress" : 2"httpServiceBindAddress",
"bucketCreateBytesmemberName" : 0"memberName",
"regionNamelocators" : "regionNamelocators",
"bucketTransferTimeInMillisecondsprocessId" : 54,
"timeInMillisecondswebSSL" : 3true,
"primaryTransfersCompletedhostedRegions" : 9[ "hostedRegions", "hostedRegions" ],
"bucketTransferByteshost" : 5
"host",
"maxHeapSize" : }2, {
"bucketCreateTimeInMillisecondsworkingDirPath" : 6"workingDirPath",
"primaryTransferTimeInMillisecondsid" : 7"id",
"bucketCreatesCompletedclientCount" : 15,
"bucketTransfersCompletedhttpServicePort" : 27,
"bucketCreateBytescacheServerInfo" : [ 0,{
"regionNamerunning" : "regionName"true,
"bucketTransferTimeInMillisecondsport" : 51,
"timeInMillisecondsmaxThreads" : 36,
"primaryTransfersCompletedbindAddress" : 9"bindAddress",
"bucketTransferBytesmaxConnections" : 50
}, ],
{
"successrunning" : true,
"statusMessageport" : "statusMessage"
1,
},
"operationEndedmaxThreads" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links" : { "self6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "urigroups" },
"operatorserverBindAddress" : "operatorserverBindAddress",
"statusMessagecacheXmlFilePath" : "statusMessagecacheXmlFilePath",
"statusCodelocatorPort" : 3,
"OKheapUsage"
}

Responses

200

OK ClusterManagementOperationStatusResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/operations/rebalances

list rebalances

Return type

Example data

Content-Type: application/json
{
"result" : [ {
: 2,
"initHeapSize" : 9,
"operationEndedlogFilePath" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXlogFilePath",
"operationStartoffHeapMemorySize" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXoffHeapMemorySize",
"operationIdsecured" : "operationId"true,
"operatorstatArchiveFilePath" : "operatorstatArchiveFilePath",
"statusMessagestatus" : "statusMessagestatus",
"statusCode" : "OK"
}, {
}, {
"cpuUsage" : 5.637376656633329,
"operationEndedserver" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"true,
"operationStarthttpServiceBindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXhttpServiceBindAddress",
"operationIdmemberName" : "operationIdmemberName",
"operatorlocators" : "operatorlocators",
"statusMessageprocessId" : "statusMessage"4,
"statusCodewebSSL" : "OK"true,
} ],
"linkshostedRegions" : {[ "selfhostedRegions" :, "urihostedRegions" }],
"statusMessagehost" : "statusMessagehost",
"statusCodemaxHeapSize" : 2,
"OK"
}

Responses

200

OK ClusterManagementListOperationsResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

POST /management/v1/operations/rebalances

start rebalance

Consumes

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

Request body

body RebalanceOperation (required)
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

Created

401

Unauthorized

403

Forbidden

404

Not Found

Region Management

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 Region (required)
Body Parameter -- regionConfig

Return type

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

DELETE /management/v1/regions/{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 ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden
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",

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

GET /management/v1/regions/{id}

get region

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
"configuration" : {
"regionPathcacheXmlFilePath" : "regionPathcacheXmlFilePath",
"expressionlocatorPort" : "expression"3,
"keyIndexheapUsage" : 2,
"initHeapSize" : true9,
"namelogFilePath" : "namelogFilePath",
"groupoffHeapMemorySize" : "groupoffHeapMemorySize",
"secured" : }true,
"runtimeInfostatArchiveFilePath" : [ {"statArchiveFilePath",
"memberNamestatus" : "memberNamestatus"
} ]
}, {
"configuration" : {
"memberNameid" : "memberNameid",
} ]
"group" : "group"
},
"linksruntimeInfo" : [ {
"selfcpuUsage" : "uri" }5.637376656633329,
"statusMessageserver" : "statusMessage"true,
"statusCodehttpServiceBindAddress" : "OKhttpServiceBindAddress"
}

Responses

200

OK ClusterManagementGetResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found
{
"result" : {
,
"memberName" : "memberName",
"configurationlocators" : {"locators",
"expirationsprocessId" : [ {
4,
"actionwebSSL" : "DESTROY"true,
"typehostedRegions" : [ "ENTRY_TIME_TO_LIVEhostedRegions",
"hostedRegions" ],
"timeInSecondshost" : 0"host",
}, {"maxHeapSize" : 2,
"actionworkingDirPath" : "DESTROYworkingDirPath",
"typeid" : "ENTRY_TIME_TO_LIVEid",
"timeInSecondsclientCount" : 05,
} ]"httpServicePort" : 7,
"redundantCopiescacheServerInfo" : [ 6,{
"keyConstraintrunning" : "keyConstraint"true,
"nameport" : "name"1,
"valueConstraintmaxThreads" : "valueConstraint"6,
"typebindAddress" : "PARTITIONbindAddress",
"diskStoreNamemaxConnections" : "diskStoreName",0
"group" : "group"}, {
},
"runtimeInforunning" : true,
[ {
"entryCountport" : 1,
"memberNamemaxThreads" : "memberName"6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ], {
"coordinator" : true,
"entryCountgroups" : 1"groups",
"memberNameserverBindAddress" : "memberNameserverBindAddress",
} ]
"cacheXmlFilePath" : }"cacheXmlFilePath",
"linkslocatorPort" : {3,
"selfheapUsage" : 2,
"uriinitHeapSize" : }9,
"statusMessagelogFilePath" : "statusMessagelogFilePath",
"statusCodeoffHeapMemorySize" : "OKoffHeapMemorySize"
}

Responses

200

OK ClusterManagementGetResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

GET /management/v1/indexes

list indexes

Query parameters

id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
,
"secured" : true,
"configurationstatArchiveFilePath" : {"statArchiveFilePath",
"regionPathstatus" : "regionPath",status"
}, {
"expressioncpuUsage" : "expression"5.637376656633329,
"keyIndexserver" : true,
"namehttpServiceBindAddress" : "namehttpServiceBindAddress",
"groupmemberName" : "groupmemberName",
},
"runtimeInfolocators" : [ {"locators",
"memberNameprocessId" : "memberName"4,
}, { "webSSL" : true,
"memberNamehostedRegions" : [ "hostedRegions", "memberNamehostedRegions" ],
} ]
"host" : }"host",
{
"configurationmaxHeapSize" : {2,
"regionPathworkingDirPath" : "regionPathworkingDirPath",
"expressionid" : "expressionid",
"keyIndexclientCount" : true5,
"namehttpServicePort" : "name"7,
"groupcacheServerInfo" : "group"[ {
},
"runtimeInforunning" : true,
[ {
"memberNameport" : "memberName"1,
}, {
"maxThreads" : 6,
"memberNamebindAddress" : "memberNamebindAddress",
} ]
} ],
"linksmaxConnections" : 0
}, {
"running" : true,
"selfport" : "uri" },
1,
"maxThreads" : 6,
"statusMessagebindAddress" : "statusMessagebindAddress",
"statusCode "maxConnections" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found

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

list region indexes

Path parameters

regionName (required)
Path Parameter -- regionName

Query parameters

id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",{
"result" : [ {
"configuration" : {
"regionPathcacheXmlFilePath" : "regionPathcacheXmlFilePath",
"expressionlocatorPort" : "expression"3,
"keyIndexheapUsage" : true2,
"nameinitHeapSize" : "name"9,
"grouplogFilePath" : "grouplogFilePath",
},
"runtimeInfooffHeapMemorySize" : [ {"offHeapMemorySize",
"memberNamesecured" : "memberName"true,
}, {
"memberNamestatArchiveFilePath" : "memberName"
} ]
}, {
"configuration" : {statArchiveFilePath",
"regionPathstatus" : "regionPathstatus",
} ]
"expression" :} "expression"],
"keyIndexlinks" : true,
"name{ "self" : "nameuri" },
"groupstatusMessage" : "group"
}statusMessage",
"runtimeInfostatusCode" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],"OK"
}

Responses

200

OK ClusterManagementListResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

Pdx Management

POST /management/v1/configurations/pdx

configure pdx

Consumes

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

Request body

body Pdx (required)
Body Parameter -- pdxType

Return type

Example data

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

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Pdx already configured.

500

Internal error.

...

GET /management/v1/configurations/pdx

get pdx

Return type

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" : [ {
"configurationconfigurationByGroup" : [ {
"expirationsconfiguration" : [ {
"actionautoSerializer" : "DESTROY",{
"typepatterns" : [ "ENTRY_TIME_TO_LIVE",
patterns", "patterns" ],
"timeInSecondsportable" : 0true
}, {
"actionreadSerialized" : "DESTROY"true,
"typediskStoreName" : "ENTRY_TIME_TO_LIVEdiskStoreName",
"timeInSecondsignoreUnreadFields" : 0true,
} ],
"pdxSerializer" : {
"redundantCopies" : 6,
"keyConstraintinitProperties" : "keyConstraint",{
"name" : "name",
"valueConstraintkey" : "valueConstraint", { }
"type" : "PARTITION"},
"diskStoreNameclassName" : "diskStoreNameclassName",
"group" : "group"}
},
"runtimeInfo" : [ {
"entryCountreadSerialized" : 1true,
"memberName" : "memberName",
}, {
"diskStoreName" : "diskStoreName",
"entryCountignoreUnreadFields" : 1true,
"memberNamepdxSerializer" : "memberNamepdxSerializer"
} ]
}, {
"configurationreadSerialized" : {true,
"expirationsmemberName" : [ {"memberName",
"actiondiskStoreName" : "DESTROYdiskStoreName",
"typeignoreUnreadFields" : "ENTRY_TIME_TO_LIVE"true,
"timeInSecondspdxSerializer" : 0
"pdxSerializer"
} ]
}, {
"actionconfiguration" : "DESTROY",{
"typeautoSerializer" : "ENTRY_TIME_TO_LIVE",
{
"timeInSecondspatterns" : 0
[ "patterns", "patterns" ],
} ],
"redundantCopiesportable" : 6,true
"keyConstraint" : "keyConstraint"},
"namereadSerialized" : "name"true,
"valueConstraintdiskStoreName" : "valueConstraintdiskStoreName",
"typeignoreUnreadFields" : "PARTITION"true,
"diskStoreNamepdxSerializer" : "diskStoreName",
{
"groupinitProperties" : "group"{
},
"runtimeInfo" : [ "key" : { }
"entryCount" : 1},
"memberNameclassName" : "memberName"className"
}
},
"runtimeInfo" : [ {
"entryCountreadSerialized" : 1true,
"memberName" : "memberName",
} ]
} ]"diskStoreName" : "diskStoreName",
"links "ignoreUnreadFields" : {true,
"selfpdxSerializer" : "uripdxSerializer"
}, {
"statusMessagereadSerialized" : "statusMessage"true,
"statusCodememberName" : "OKmemberName"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

Models

AutoSerializer

portable (optional)
Boolean
patterns (optional)
array[String]

CacheServerInfo

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

ClassName

className (optional)
String
initProperties (optional)
map[String, Object]
,
"diskStoreName" : "diskStoreName",
"ignoreUnreadFields" : true,
"pdxSerializer" : "pdxSerializer"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Pdx_PdxInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Ping

GET /management/v1/ping

ping

Return type

String

Example data

Content-Type: application/json
""

Responses

200

OK String

401

Unauthorized

403

Forbidden

404

Not Found

...

Rebalance Operation

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

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_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

...

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_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

...

POST /management/v1/operations/rebalances

start rebalance

Consumes

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

Request body

body RebalanceOperation (required)
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

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Region Management

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

create region index

Path parameters

regionName (required)
Path Parameter -- regionName

Consumes

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

Request body

body Index (required)
Body Parameter -- indexConfig

Return type

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Index already exists.

500

Internal error.

...

POST /management/v1/indexes

create index

Consumes

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

Request body

body Index (required)
Body Parameter -- indexConfig

Return type

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Index already exists.

500

Internal error.

...

POST /management/v1/regions

create region

Consumes

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

Request body

body Region (required)
Body Parameter -- regionConfig

Return type

Example data

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

Responses

200

OK ClusterManagementResult

201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

404

Not Found

409

Region already exists.

500

Internal error.

...

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

delete region index

Path parameters

indexName (required)
Path Parameter -- indexName
regionName (required)
Path Parameter -- regionName

Return type

Example data

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

...

DELETE /management/v1/regions/{id}

delete region

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

Example data

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

...

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

get index

Path parameters

id (required)
Path Parameter -- id
regionName (required)
Path Parameter -- regionName

Return type

Example data

Content-Type: application/json
{
"result" : {
"configurationByGroup" : [ {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configuration" : {
"regionPath" : "regionPath",
"indexType" : "KEY",
"expression" : "expression",
"name" : "name"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"id" : "id"
},
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions/{id}

get region

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

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

Responses

200

OK ClusterManagementGetResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/indexes

list indexes

Query parameters

id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"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"
} ]
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

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

list region indexes

Path parameters

regionName (required)
Path Parameter -- regionName

Query parameters

id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"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"
} ]
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_IndexInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/regions

list regions

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"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"
} ]
} ],
"links" : { "self" : "uri" },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Models

AutoSerializer

portable (optional)
Boolean
patterns (optional)
array[String]

CacheServerInfo

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

ClassName

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

ClusterManagementGetResult_Deployment_DeploymentInfo

links (optional)
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

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

links (optional)
result (optional)
ConfigurationResultConfigurationInfo_GatewayReceiverRegion_GatewayReceiverInfoRuntimeRegionInfo
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

ClusterManagementListOperationsResult_

Index_RuntimeInfo

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
ClusterManagementGetResult

ClusterManagementListResult_

Member

Deployment_

MemberInformation

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

ClusterManagementListResult_

Pdx

GatewayReceiver_

PdxInfo

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

ClusterManagementListResult_

Region

Index_

RuntimeRegionInfo

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
ClusterManagementListOperationsResult

ClusterManagementListResult_Member_

RebalanceResult

MemberInformation

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

Region_

GatewayReceiverInfo

RuntimeRegionInfo

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

ClusterManagementOperationResult_

Index_RuntimeInfo

RebalanceResult

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

ClusterManagementOperationStatusResult_

Member_MemberInformation

RebalanceResult

links (optional)
operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
result (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

ClusterManagementResult

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

ConfigurationInfo_Deployment_DeploymentInfo

configurationByGroup (optional)
id statusMessage (optional)
String
ClusterManagementOperationResult

ConfigurationInfo_GatewayReceiver_

RebalanceResult

GatewayReceiverInfo

links configurationByGroup (optional)
id operationEnded (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

ConfigurationInfo_Index_IndexInfo

configurationByGroup operationId (optional)
String
id operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

ConfigurationInfo_Member_MemberInformation

configurationByGroup operator (optional)
String
id statusCode (optional)
String
Enum:

ConfigurationInfo_Pdx_PdxInfo

configurationByGroup (optional)
id (optional)
String

ConfigurationInfo_Region_RuntimeRegionInfo

configurationByGroup (optional)
id
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementOperationStatusResult

ConfigurationResult_Deployment_

RebalanceResult

DeploymentInfo

links configuration (optional)
operationEnded links (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
runtimeInfo operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX

ConfigurationResult_GatewayReceiver_GatewayReceiverInfo

configuration operator (optional)
result links (optional)
statusCode runtimeInfo (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS

ConfigurationResult_Index_IndexInfo

configuration statusMessage (optional)
String Index

ClusterManagementResult

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

ConfigurationResult_Member_MemberInformation

configuration (optional)
links (optional)
runtimeInfo (optional)

ConfigurationResult_Pdx_PdxInfo

ConfigurationResult_GatewayReceiver_GatewayReceiverInfo

configuration (optional)
links (optional)
runtimeInfo (optional)
array[GatewayReceiverInfoPdxInfo]

ConfigurationResult_

Index

Region_

RuntimeInfo

RuntimeRegionInfo

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

ConfigurationResult_Member_MemberInformation

Deployment

deployedBy (optional)
String
deployedTime (optional)
String
group (optional)
String
jarFileName (optional)
String

DeploymentInfo

jarLocation (optional)
String
lastModified (optional)
String
memberName configuration (optional)
Member
String
links latest (optional)
Links String
runtimeInfo supported (optional)
array[MemberInformationString]

ConfigurationResult_Pdx_PdxInfo

Eviction

action configuration (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
entryCount links (optional)
Integer format: int32
memorySizeMb runtimeInfo (optional)

ConfigurationResult_Region_RuntimeRegionInfo

Integer format: int32
objectSizer configuration (optional)
links type (optional)
runtimeInfo (optional)
array[RuntimeRegionInfo]
String
Enum:
ENTRY_COUNT
MEMORY_SIZE
HEAP_PERCENTAGE

Expiration

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

...

Index

expression (optional)
String
group indexType (optional)
String
Enum:
KEY
RANGE
HASH_DEPRECATED
name keyIndex (optional)
Boolean String
name regionPath (optional)
String

IndexInfo

regionPath memberName (optional)
String

Member

group (optional)
String
id (optional)
String

...

Region

diskStoreName (optional)
String
eviction (optional)
expirations (optional)
group (optional)
String
keyConstraint (optional)
String
name (optional)
String
redundantCopies (optional)
Integer format: int32
type (optional)
String
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
valueConstraint (optional)
String

RuntimeInfo

memberName (optional)
String

RuntimeRegionInfo

entryCount (optional)
Long format: int64
memberName (optional)
String