Versions Compared

Key

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

Table of Contents
maxLevel2
excludeFoo

Apache Geode Management REST API

REST API and interface to manage Geode . This is experimental. All request/response formats are subject to changecomponents.
More information: http://geode.apache.org
Contact Info: user@geode dev@geode.apache.org
Version: v1v2
BasePath:/management/v1experimental/api-docs
Apache License, version 2.0
http://www.apache.org/licenses/

Gateway Management

POST /

v1

management/experimental/gateways/receivers

create gateway-receivercreateGatewayReceiver

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
{
"linksuri" : { }"uri",
"statusMessage" : "statusMessage",
"statusCode" : "OKILLEGAL_ARGUMENT"
}

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

experimental/gateways/receivers

/{id}
get gateway-receiver
Path

listGatewayReceivers

Query parameters

id group (requiredoptional)
Path Query Parameter -- id group

Return type

Example data

Content-Type: application/json

GET /v1/gateways/receivers

list gateway-receivers

Query parameters

group (optional)
Query Parameter -- group

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"configurationconfig" : {
"startPort" : 5"startPort",
"gatewayTransportFilters" : [ {
"initPropertiesclassName" : {"className",
"keyparameters" : [ {
}
"string" : }"string",
"classNamename" : "classNamename"
}, {
"initPropertiesstring" : {"string",
"keyname" : {"name"
} ]
}, {
"className" : "className",
} ],
"parameters" : [ {
"manualStartstring" : true"string",
"maximumTimeBetweenPingsname" : 6,"name"
"endPort" : 0}, {
"socketBufferSizestring" : 1"string",
"groupname" : "groupname"
}, } ]
"runtimeInfo" : [} {],
"connectedSendershostnameForSenders" : [ "connectedSendershostnameForSenders", "connectedSenders" ],
"runningmanualStart" : true,
"portgroups" : 5 [ "groups", "groups" ],
"hostnameForSendersmaximumTimeBetweenPings" : "hostnameForSendersmaximumTimeBetweenPings",
"memberNameendPort" : "endPort",
"uri" : "memberNameuri",
"bindAddress" : "bindAddress",
"senderCountsocketBufferSize" : "socketBufferSize",
"group" : 2"group"
},
"runtimeInfo" : [ {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
"running" : true,
"port" : 50,
"hostnameForSenders" : "hostnameForSenders",
"memberName" : "memberName",
"bindAddress" : "bindAddress",
"senderCount" : 26
}, {
"connectedSenders" : [ "connectedSenders", "connectedSenders" ],
} "running" : true,
"linksport" : { }0,
"statusMessagehostnameForSenders" : "statusMessagehostnameForSenders",
"statusCodememberName" : "OKmemberName"
}

Responses

200

OK ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found
{
"result" : [,
"bindAddress" : "bindAddress",
"senderCount" : 6
} ]
}, {
"configurationconfig" : {
"startPort" : 5"startPort",
"gatewayTransportFilters" : [ {
"initPropertiesclassName" : {"className",
"keyparameters" : [ {
}
"string" : }"string",
"classNamename" : "classNamename"
}, {
"initPropertiesstring" : {"string",
"keyname" : {"name"
} ]
}, {
"className" : "className",
} ],
"parameters" : [ {
"manualStart" : true,
"maximumTimeBetweenPingsstring" : 6"string",
"endPortname" : 0,"name"
"socketBufferSize" : 1}, {
"groupstring" : "group"
}string",
"runtimeInfo" : [ {
"connectedSendersname" : [ "connectedSendersname",
"connectedSenders" ],
"running" : true,} ]
"port" : 5} ],
"hostnameForSenders" : "hostnameForSenders",
"memberNamemanualStart" : "memberName"true,
"bindAddressgroups" : [ "bindAddressgroups",
"senderCountgroups" : 2
}, {],
"connectedSendersmaximumTimeBetweenPings" : [ "connectedSendersmaximumTimeBetweenPings", "connectedSenders" ],
"runningendPort" : true,
"port" : 5"endPort",
"hostnameForSendersuri" : "hostnameForSendersuri",
"memberNamebindAddress" : "memberNamebindAddress",
"bindAddresssocketBufferSize" : "bindAddresssocketBufferSize",
"senderCountgroup" : 2"group"
} ]
}, {
"configurationruntimeInfo" : [ {
"startPortconnectedSenders" : 5[ "connectedSenders", "connectedSenders" ],
"gatewayTransportFiltersrunning" : [ {true,
"initPropertiesport" : {0,
"keyhostnameForSenders" : { }"hostnameForSenders",
"memberName" : }"memberName",
"classNamebindAddress" : "classNamebindAddress",
}, {
"initProperties"senderCount" : {6
}, {
"keyconnectedSenders" : { }
},
"className" : "className"
} [ "connectedSenders", "connectedSenders" ],
"manualStartrunning" : true,
"maximumTimeBetweenPingsport" : 60,
"endPorthostnameForSenders" : 0"hostnameForSenders",
"socketBufferSizememberName" : 1"memberName",
"groupbindAddress" : "groupbindAddress",
},
"runtimeInfosenderCount" : [6
{
} ]
"connectedSenders" : [} ],
"connectedSendersuri", : "connectedSendersuri" ],
"runningstatusMessage" : true"statusMessage",
"portstatusCode" : 5,
"hostnameForSenders" : "hostnameForSenders","ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListResult_GatewayReceiverConfig_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Member Management

GET /management/experimental/members/{id}

getMember

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"config" : {
"memberNamegroups" : [ "memberName"groups", "groups" ],
"bindAddressid" : "bindAddressid",
"senderCounturi" : 2"uri"
},
"runtimeInfo" : [ {
"connectedSenderscpuUsage" : [5.637376656633329,
"connectedSendersserver" : true,
"connectedSendershttpServiceBindAddress" : ]"httpServiceBindAddress",
"runningmemberName" : true"memberName",
"portlocators" : 5"locators",
"hostnameForSendersprocessId" : 4,
"hostnameForSenderswebSSL" : true,
"memberNamehostedRegions" : "memberName"[ "hostedRegions", "hostedRegions" ],
"bindAddresshost" : "bindAddresshost",
"senderCountmaxHeapSize" : 2,
} ]
"workingDirPath" }: ]"workingDirPath",
"linksid" : { }"id",
"statusMessageclientCount" : "statusMessage"5,
"httpServicePort" : 7,
"statusCodecacheServerInfo" : "OK"
}

Responses

200

OK ClusterManagementListResult_GatewayReceiver_GatewayReceiverInfo

401

Unauthorized

403

Forbidden

404

Not Found

Member Management

[ {
"running" : true,

GET /v1/members/{id}

get member

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
"configurationport" : {1,
"idmaxThreads" : "id"6,
"groupbindAddress" : "groupbindAddress",
},
"runtimeInfomaxConnections" : [0
{
"cpuUsage" : 5.637376656633329,
}, {
"serverrunning" : true,
"httpServiceBindAddressport" : "httpServiceBindAddress"1,
"memberNamemaxThreads" : "memberName"6,
"locatorsbindAddress" : "locatorsbindAddress",
"processIdmaxConnections" : 4,0
"webSSL" : true} ],
"hostedRegionscoordinator" : [ "hostedRegions", "hostedRegions" ],true,
"hostgroups" : "hostgroups",
"maxHeapSizeserverBindAddress" : 2"serverBindAddress",
"workingDirPathcacheXmlFilePath" : "workingDirPathcacheXmlFilePath",
"idlocatorPort" : "id"3,
"clientCountheapUsage" : 52,
"httpServicePortinitHeapSize" : 79,
"cacheServerInfologFilePath" : [ {
"running" : true,
"logFilePath",
"portoffHeapMemorySize" : 1"offHeapMemorySize",
"maxThreadssecured" : 6true,
"bindAddressstatArchiveFilePath" : "bindAddressstatArchiveFilePath",
"maxConnectionsstatus" : 0"status"
}, {
"runningcpuUsage" : true5.637376656633329,
"portserver" : 1true,
"maxThreadshttpServiceBindAddress" : 6"httpServiceBindAddress",
"bindAddressmemberName" : "bindAddressmemberName",
"maxConnectionslocators" : 0"locators",
} ]"processId" : 4,
"coordinatorwebSSL" : true,
"groupshostedRegions" : "groups"[ "hostedRegions", "hostedRegions" ],
"serverBindAddresshost" : "serverBindAddresshost",
"cacheXmlFilePathmaxHeapSize" : "cacheXmlFilePath"2,
"locatorPortworkingDirPath" : 3"workingDirPath",
"heapUsageid" : 2"id",
"initHeapSizeclientCount" : 95,
"logFilePathhttpServicePort" : "logFilePath"7,
"offHeapMemorySizecacheServerInfo" : "offHeapMemorySize",[ {
"securedrunning" : true,
"statArchiveFilePathport" : "statArchiveFilePath"1,
"statusmaxThreads" : "status"6,
}, {
"cpuUsagebindAddress" : 5.637376656633329"bindAddress",
"servermaxConnections" : true,0
"httpServiceBindAddress" : "httpServiceBindAddress",
}, {
"memberNamerunning" : "memberName"true,
"locatorsport" : "locators"1,
"processIdmaxThreads" : 46,
"webSSLbindAddress" : true"bindAddress",
"hostedRegionsmaxConnections" : [ "hostedRegions", "hostedRegions" 0
} ],
"hostcoordinator" : "host"true,
"maxHeapSizegroups" : 2"groups",
"workingDirPathserverBindAddress" : "workingDirPathserverBindAddress",
"idcacheXmlFilePath" : "idcacheXmlFilePath",
"clientCountlocatorPort" : 53,
"httpServicePortheapUsage" : 72,
"cacheServerInfoinitHeapSize" : [ {9,
"runninglogFilePath" : true"logFilePath",
"portoffHeapMemorySize" : 1"offHeapMemorySize",
"maxThreadssecured" : 6true,
"bindAddressstatArchiveFilePath" : "bindAddressstatArchiveFilePath",
"maxConnectionsstatus" : 0"status"
} ]
}, {
"runningconfig" : true,{
"groups" : [ "portgroups", :"groups" 1],
"maxThreadsid" : 6"id",
"bindAddressuri" : "bindAddressuri",
},
"maxConnectionsruntimeInfo" : 0[ {
} ]"cpuUsage" : 5.637376656633329,
"coordinatorserver" : true,
"groupshttpServiceBindAddress" : "groupshttpServiceBindAddress",
"serverBindAddressmemberName" : "serverBindAddressmemberName",
"cacheXmlFilePathlocators" : "cacheXmlFilePathlocators",
"locatorPortprocessId" : 34,
"heapUsagewebSSL" : 2true,
"initHeapSizehostedRegions" : 9 [ "hostedRegions", "hostedRegions" ],
"logFilePathhost" : "logFilePathhost",
"offHeapMemorySizemaxHeapSize" : "offHeapMemorySize"2,
"securedworkingDirPath" : true"workingDirPath",
"statArchiveFilePathid" : "statArchiveFilePathid",
"statusclientCount" : "status"5,
} ]
"httpServicePort" : }7,
"links" : { },
"statusMessagecacheServerInfo" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found
 [ {
"running" : true,
"port" : 1,

GET /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" : [ {
"configuration" : {
"idmaxThreads" : "id"6,
"groupbindAddress" : "groupbindAddress",
},
"runtimeInfomaxConnections" : [ {0
"cpuUsage" : 5.637376656633329,
}, {
"serverrunning" : true,
"httpServiceBindAddressport" : "httpServiceBindAddress"1,
"memberNamemaxThreads" : "memberName"6,
"locatorsbindAddress" : "locatorsbindAddress",
"processIdmaxConnections" : 4,0
"webSSL" : true} ],
"hostedRegionscoordinator" : [ "hostedRegions", "hostedRegions" ],true,
"hostgroups" : "hostgroups",
"maxHeapSizeserverBindAddress" : 2"serverBindAddress",
"workingDirPathcacheXmlFilePath" : "workingDirPathcacheXmlFilePath",
"idlocatorPort" : "id"3,
"clientCountheapUsage" : 52,
"httpServicePortinitHeapSize" : 79,
"cacheServerInfologFilePath" : [ {"logFilePath",
"runningoffHeapMemorySize" : true"offHeapMemorySize",
"portsecured" : 1true,
"maxThreadsstatArchiveFilePath" : 6"statArchiveFilePath",
"bindAddressstatus" : "bindAddressstatus",
}, {
"maxConnections "cpuUsage" : 0
}, {5.637376656633329,
"runningserver" : true,
"porthttpServiceBindAddress" : 1"httpServiceBindAddress",
"maxThreadsmemberName" : 6"memberName",
"bindAddresslocators" : "bindAddresslocators",
"maxConnectionsprocessId" : 04,
} ]"webSSL" : true,
"coordinatorhostedRegions" : true [ "hostedRegions", "hostedRegions" ],
"groupshost" : "groupshost",
"serverBindAddressmaxHeapSize" : "serverBindAddress"2,
"cacheXmlFilePathworkingDirPath" : "cacheXmlFilePathworkingDirPath",
"locatorPortid" : 3"id",
"heapUsageclientCount" : 25,
"initHeapSizehttpServicePort" : 97,
"logFilePathcacheServerInfo" : "logFilePath",[ {
"offHeapMemorySizerunning" : "offHeapMemorySize"true,
"securedport" : true1,
"statArchiveFilePathmaxThreads" : "statArchiveFilePath"6,
"statusbindAddress" : "statusbindAddress",
"maxConnections" : 0
}, {
"cpuUsagerunning" : 5.637376656633329true,
"serverport" : true1,
"httpServiceBindAddressmaxThreads" : "httpServiceBindAddress"6,
"memberNamebindAddress" : "memberNamebindAddress",
"locatorsmaxConnections" : "locators",0
"processId" : 4} ],
"webSSLcoordinator" : true,
"hostedRegionsgroups" : [ "hostedRegions", "hostedRegions" ]"groups",
"hostserverBindAddress" : "hostserverBindAddress",
"maxHeapSizecacheXmlFilePath" : 2"cacheXmlFilePath",
"workingDirPathlocatorPort" : "workingDirPath"3,
"idheapUsage" : "id"2,
"clientCountinitHeapSize" : 59,
"httpServicePortlogFilePath" : 7"logFilePath",
"cacheServerInfooffHeapMemorySize" : [ {"offHeapMemorySize",
"runningsecured" : true,
"portstatArchiveFilePath" : 1"statArchiveFilePath",
"maxThreadsstatus" : 6,"status"
} ]
} ],
"bindAddressuri" : "bindAddressuri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListResult_MemberConfig_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/experimental/members

listMembers

Query parameters

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

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"config" : {maxConnections" : 0
}, {
"running" : true,
"groups" : [ "portgroups", :"groups" 1],
"maxThreadsid" : 6"id",
"bindAddressuri" : "bindAddressuri",
},
"maxConnectionsruntimeInfo" : 0[ {
} ]"cpuUsage" : 5.637376656633329,
"coordinatorserver" : true,
"groupshttpServiceBindAddress" : "groupshttpServiceBindAddress",
"serverBindAddressmemberName" : "serverBindAddressmemberName",
"cacheXmlFilePathlocators" : "cacheXmlFilePathlocators",
"locatorPortprocessId" : 34,
"heapUsagewebSSL" : 2true,
"initHeapSizehostedRegions" : 9 [ "hostedRegions", "hostedRegions" ],
"logFilePathhost" : "logFilePathhost",
"offHeapMemorySizemaxHeapSize" : "offHeapMemorySize"2,
"securedworkingDirPath" : true"workingDirPath",
"statArchiveFilePathid" : "statArchiveFilePathid",
"statusclientCount" : "status"5,
} ]
}, {
"httpServicePort" : 7,
"configurationcacheServerInfo" : [ {
"idrunning" : "id"true,
"groupport" : "group"1,
},
"runtimeInfomaxThreads" : [ {
6,
"cpuUsagebindAddress" : 5.637376656633329"bindAddress",
"servermaxConnections" : true,0
"httpServiceBindAddress" : "httpServiceBindAddress",
}, {
"memberNamerunning" : "memberName"true,
"locatorsport" : "locators"1,
"processIdmaxThreads" : 46,
"webSSLbindAddress" : true"bindAddress",
"hostedRegionsmaxConnections" : [ "hostedRegions", "hostedRegions"0
} ],
"hostcoordinator" : "host"true,
"maxHeapSizegroups" : 2"groups",
"workingDirPathserverBindAddress" : "workingDirPathserverBindAddress",
"idcacheXmlFilePath" : "idcacheXmlFilePath",
"clientCountlocatorPort" : 53,
"httpServicePortheapUsage" : 72,
"cacheServerInfoinitHeapSize" : [ {
9,
"runninglogFilePath" : true"logFilePath",
"portoffHeapMemorySize" : 1"offHeapMemorySize",
"maxThreadssecured" : 6true,
"bindAddressstatArchiveFilePath" : "bindAddressstatArchiveFilePath",
"maxConnectionsstatus" : 0"status"
}, {
"runningcpuUsage" : true5.637376656633329,
"portserver" : 1true,
"maxThreadshttpServiceBindAddress" : 6"httpServiceBindAddress",
"bindAddressmemberName" : "bindAddressmemberName",
"maxConnectionslocators" : 0"locators",
} ]"processId" : 4,
"coordinatorwebSSL" : true,
"groupshostedRegions" : "groups"[ "hostedRegions", "hostedRegions" ],
"serverBindAddresshost" : "serverBindAddresshost",
"cacheXmlFilePathmaxHeapSize" : "cacheXmlFilePath"2,
"locatorPortworkingDirPath" : 3"workingDirPath",
"heapUsageid" : 2"id",
"initHeapSizeclientCount" : 95,
"logFilePathhttpServicePort" : "logFilePath"7,
"offHeapMemorySizecacheServerInfo" : "offHeapMemorySize",
[ {
"securedrunning" : true,
"statArchiveFilePathport" : "statArchiveFilePath"1,
"statusmaxThreads" : "status"6,
}, {
"cpuUsagebindAddress" : 5.637376656633329"bindAddress",
"servermaxConnections" : true,0
"httpServiceBindAddress" : "httpServiceBindAddress",
}, {
"memberNamerunning" : "memberName"true,
"locatorsport" : "locators"1,
"processIdmaxThreads" : 46,
"webSSLbindAddress" : true"bindAddress",
"hostedRegionsmaxConnections" : [ "hostedRegions", "hostedRegions" 0
} ],
"hostcoordinator" : "host"true,
"maxHeapSizegroups" : 2"groups",
"workingDirPathserverBindAddress" : "workingDirPathserverBindAddress",
"idcacheXmlFilePath" : "idcacheXmlFilePath",
"clientCountlocatorPort" : 53,
"httpServicePortheapUsage" : 72,
"cacheServerInfoinitHeapSize" : [ {
9,
"runninglogFilePath" : true"logFilePath",
"portoffHeapMemorySize" : 1"offHeapMemorySize",
"maxThreadssecured" : 6true,
"bindAddressstatArchiveFilePath" : "bindAddressstatArchiveFilePath",
"maxConnectionsstatus" : 0"status"
} ]
}, {
"runningconfig" : true,{
"groups" : [ "portgroups", :"groups" 1],
"maxThreadsid" : 6"id",
"bindAddressuri" : "bindAddressuri",
},
"maxConnectionsruntimeInfo" : 0[ {
} ]"cpuUsage" : 5.637376656633329,
"coordinatorserver" : true,
"groupshttpServiceBindAddress" : "groupshttpServiceBindAddress",
"serverBindAddressmemberName" : "serverBindAddressmemberName",
"cacheXmlFilePathlocators" : "cacheXmlFilePathlocators",
"locatorPortprocessId" : 34,
"heapUsagewebSSL" : 2true,
"initHeapSizehostedRegions" : 9 [ "hostedRegions", "hostedRegions" ],
"logFilePathhost" : "logFilePathhost",
"offHeapMemorySizemaxHeapSize" : "offHeapMemorySize2,
"workingDirPath" : "workingDirPath",
"securedid" : true"id",
"statArchiveFilePathclientCount" : "statArchiveFilePath"5,
"httpServicePort" : 7,
"statuscacheServerInfo" : [ {
"statusrunning" : true,
} ]
"port" }: ]1,
"linksmaxThreads" : { }6,
"statusMessagebindAddress" : "statusMessagebindAddress",
"statusCodemaxConnections" : "OK"
}

Responses

200

OK ClusterManagementListResult_Member_MemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

Pdx Management

POST /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" : { },
"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.

Ping

GET /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

0
}, {
"running" : true,
"port" : 1,
"maxThreads" : 6,
"bindAddress" : "bindAddress",
"maxConnections" : 0
} ],
"coordinator" : true,
"groups" : "groups",
"serverBindAddress" : "serverBindAddress",
"cacheXmlFilePath" : "cacheXmlFilePath",
"locatorPort" : 3,
"heapUsage" : 2,

GET /v1/operations/rebalances/{id}

check rebalance

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
"rebalanceRegionResults" : [ {
"bucketCreateTimeInMillisecondsinitHeapSize" : 69,
"primaryTransferTimeInMillisecondslogFilePath" : 7"logFilePath",
"bucketCreatesCompletedoffHeapMemorySize" : 1"offHeapMemorySize",
"bucketTransfersCompletedsecured" : 2true,
"bucketCreateBytesstatArchiveFilePath" : 0"statArchiveFilePath",
"regionNamestatus" : "regionName",status"
}, {
"bucketTransferTimeInMillisecondscpuUsage" : 5.637376656633329,
"timeInMillisecondsserver" : 3true,
"primaryTransfersCompletedhttpServiceBindAddress" : 9"httpServiceBindAddress",
"bucketTransferBytesmemberName" : 5
"memberName",
}, {"locators" : "locators",
"bucketCreateTimeInMillisecondsprocessId" : 64,
"primaryTransferTimeInMillisecondswebSSL" : 7true,
"bucketCreatesCompletedhostedRegions" : 1 [ "hostedRegions", "hostedRegions" ],
"bucketTransfersCompletedhost" : 2"host",
"bucketCreateBytesmaxHeapSize" : 02,
"regionNameworkingDirPath" : "regionNameworkingDirPath",
"bucketTransferTimeInMillisecondsid" : 5"id",
"timeInMillisecondsclientCount" : 35,
"primaryTransfersCompletedhttpServicePort" : 97,
"bucketTransferBytescacheServerInfo" : 5[ {
} ] "running" : true,
"statusMessageport" : "statusMessage"
1,
},
"operationEndedmaxThreads" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"6,
"operationStartbindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"links"bindAddress",
"maxConnections" : {0
}, {
"operatorrunning" : "operator"true,
"statusMessageport" : "statusMessage"1,
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationStatusResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

GET /v1/operations/rebalances

list rebalances

Return type

Example data

Content-Type: application/json
{
"result" : [ {
maxThreads" : 6,
"operationEndedbindAddress" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX""bindAddress",
"operationStartmaxConnections" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",0
"operationId" :} "operationId"],
"operatorcoordinator" : "operator"true,
"statusMessagegroups" : "statusMessagegroups",
"statusCodeserverBindAddress" : "OKserverBindAddress",
}, {
"operationEndedcacheXmlFilePath" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXXcacheXmlFilePath",
"operationStartlocatorPort" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"3,
"operationIdheapUsage" : "operationId"2,
"operatorinitHeapSize" : "operator"9,
"statusMessagelogFilePath" : "statusMessagelogFilePath",
"statusCode "offHeapMemorySize" : "offHeapMemorySize",
"secured" : true,
"statArchiveFilePath" : "statArchiveFilePath",
"status" : "OKstatus"
} ]
} ],
"linksuri" : { }"uri",
"statusMessage" : "statusMessage",
"statusCode" : "OKILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListOperationsResultClusterManagementListResult_MemberConfig_RebalanceResultMemberInformation

401

Unauthorized

403

Forbidden

404

Not Found

...

Pdx Management

POST /

v1

management/experimental/

operations

configurations/

rebalances

pdx

start rebalanceconfigure PDX

Consumes

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

Request body

body RebalanceOperation Pdx (required)
Body Parameter -- operation pdxType

Return type

Example data

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

Responses

200

OK ClusterManagementOperationResult_RebalanceResult . ClusterManagementResult

201

Created

401

Unauthorized Invalid Username or Password.

403

Forbidden Insufficient privileges for operation.

404

Not Found

Region Management

500

GemFire throws an error or exception.

...

Ping

GET /management/experimental/ping

ping

Return type

String

Example data

Content-Type: application/json
""

Responses

200

OK String

POST /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" : { },
"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.

...

Rebalance Operation

GET /management/experimental/operations/rebalances

DELETE /v1/regions

/{id}

delete regioncheckRebalanceStatus

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

Example data

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

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

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

get index

Path parameters

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

Return type

Example data

: [ {
"bucketCreateTimeInMilliseconds" : 6,
Content-Type: application/json
{
"result" : {
"configurationprimaryTransferTimeInMilliseconds" : {7,
"regionPathbucketCreatesCompleted" : "regionPath"1,
"expressionbucketTransfersCompleted" : "expression"2,
"keyIndexbucketCreateBytes" : true0,
"nameregionName" : "nameregionName",
"groupbucketTransferTimeInMilliseconds" : "group"5,
} "timeInMilliseconds" : 3,
"runtimeInfoprimaryTransfersCompleted" : [ {9,
"memberNamebucketTransferBytes" : "memberName"5
}, {
"memberNamebucketCreateTimeInMilliseconds" : 6,
"memberNameprimaryTransferTimeInMilliseconds" : 7,
} ] "bucketCreatesCompleted" : 1,
} "bucketTransfersCompleted" : 2,
"linksbucketCreateBytes" : { }0,
"statusMessageregionName" : "statusMessageregionName",
"statusCodebucketTransferTimeInMilliseconds" : "OK"
}

Responses

200

OK ClusterManagementGetResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found
5,
"timeInMilliseconds" : 3,
"primaryTransfersCompleted" : 9,
"bucketTransferBytes" : 5
} ],

GET /v1/regions/{id}

get region

Path parameters

id (required)
Path Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : {
"configurationstatusMessage" : {
"expirations" : [ {
"action"statusMessage"
},
"operationEnded" : "DESTROYyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"type"operationStart" : "ENTRY_TIME_TO_LIVEyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"timeInSecondsuri" : 0"uri",
"operator" }, {
"action: "operator",
"statusMessage" : "DESTROYstatusMessage",
"typestatusCode" : "ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementOperationStatusResult_RebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/experimental/operations/rebalances

listRebalances

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"ENTRY_TIME_TO_LIVE",
"timeInSeconds" : 0
} ],
"redundantCopiesuri" : 6"uri",
"keyConstraintoperator" : "keyConstraintoperator",
"namestatusMessage" : "namestatusMessage",
"valueConstraintstatusCode" : "valueConstraintILLEGAL_ARGUMENT",
}, {
"typeoperationEnded" : "PARTITIONyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"diskStoreNameoperationStart" : "diskStoreNameyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"groupuri" : "group"
}uri",
"runtimeInfooperator" : [ {
"operator",
"entryCountstatusMessage" : 1"statusMessage",
"memberNamestatusCode" : "memberNameILLEGAL_ARGUMENT"
}, {
"entryCount" : 1,
],
"memberNameuri" : "memberName"
} ]
},
"links" : { }uri",
"statusMessage" : "statusMessage",
"statusCode" : "OKILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementGetResultClusterManagementListOperationsResult_Region_RuntimeRegionInfoRebalanceResult

401

Unauthorized

403

Forbidden

404

Not Found GET

...

POST /management/experimental/

v1/indexes

operations/rebalances

startRebalance

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
list indexes

Query parameters

id (optional)
Query Parameter -- id

Return type

ClusterManagementListResultClusterManagementOperationResult_Index_RuntimeInfoRebalanceResult

Example data

Content-Type: application/json
{
"resultoperationEnded" : [ {
"configuration" : {
"regionPath" : "regionPath",
"expression"yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"operationStart" : "expressionyyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"keyIndex" : true,
"name""uri" : "nameuri",
"groupoperator" : "group"
}operator",
"runtimeInfostatusMessage" : [ {
"memberName" : "memberName"
}, {
"memberName"statusMessage",
"statusCode" : "memberNameILLEGAL_ARGUMENT"
} ]
}, {
"configuration" : {
"regionPath

Responses

200

OK ClusterManagementOperationResult_RebalanceResult

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Region Management

POST /management/experimental/regions

create regions

Consumes

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

Request body

body RegionConfig (required)
Body Parameter -- regionConfig

Return type

Example data

Content-Type: application/json
{
"uri" : "regionPathuri",
"expressionstatusMessage" : "expressionstatusMessage",
"keyIndexstatusCode" : true"ILLEGAL_ARGUMENT"
}

Responses

200

OK. ClusterManagementResult

201

Created

401

Invalid Username or Password.

403

Insufficient privileges for operation.

404

Not Found

409

Region already exist.

500

GemFire throws an error or exception.

...

DELETE /management/experimental/regions/{id}

deleteRegion

Path parameters

id (required)
Path Parameter -- id

Query parameters

group (optional)
Query Parameter -- group

Return type

Example data

Content-Type: application/json
{
"uri,
"name" : "nameuri",
"groupstatusMessage" : "group"
}statusMessage",
"runtimeInfostatusCode" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo
"ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementResult

204

No Content

401

Unauthorized

403

Forbidden

...

404 Not Found

GET /management/

v1

experimental/regions/{regionName}/indexes

/{id}

getIndexlist region indexes

Path parameters

regionName id (required)
Path Parameter -- id
regionName

Query parameters

id (optionalrequired)
Query Path Parameter -- id regionName

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"configurationconfig" : {
"regionPath"expression" : "expression",
"fromClause" : "regionPathfromClause",
"expressionimports" : "expressionimports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"configurationconfig" : {
"regionPathexpression" : "regionPathexpression",
"expressionfromClause" : "expressionfromClause",
"keyIndeximports" : true"imports",
"namekeyIndex" : "name"true,
"groupregionName" : "groupregionName",
},
"runtimeInfoname" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"linksuri" : { }"uri",
"statusMessage" : "statusMessage",
"statusCode" : "OKILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/

v1

experimental/regions

list regions

Query parameters

/{id}

getRegion

Path parameters

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

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"configurationconfig" : {
"expirationsregionAttributes" : [ {
"actionenableAsyncConflation" : "DESTROY"true,
"typehubId" : "ENTRY_TIME_TO_LIVEhubId",
"timeInSecondsisLockGrantor" : 0true,
"membershipAttributes" },: {
"actionrequiredRoles" : "DESTROY",
[ {
"typename" : "ENTRY_TIME_TO_LIVE",
name"
"timeInSeconds" :}, 0{
} ],
"redundantCopiesname" : 6,"name"
"keyConstraint" : "keyConstraint",
} ],
"namelossAction" : "namelossAction",
"valueConstraintresumptionAction" : "valueConstraintresumptionAction",
"type" : "PARTITION"},
"diskStoreNameconcurrencyChecksEnabled" : "diskStoreName"true,
"groupasyncEventQueueIds" : "groupasyncEventQueueIds",
},
"runtimeInfoevictionAttributes" : [ {
"entryCount" : 1,
"memberNamelruHeapPercentage" : "memberName"{
}, {
"entryCountaction" : 1"LOCAL_DESTROY",
"memberName "className" : "memberNameclassName",
} ]
}, {
"configurationparameters" : [ {
"expirations" : [ {
"actionstring" : "DESTROYstring",
"typename" : "ENTRY_TIME_TO_LIVE",name"
"timeInSeconds" : 0 }, {
}, {
"actionstring" : "DESTROYstring",
"typename" : "ENTRY_TIME_TO_LIVE",
name"
"timeInSeconds" : 0 } ]
} ],
"lruEntryCount" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum"
},
"redundantCopies "lruMemorySize" : {
"action" : 6"LOCAL_DESTROY",
"keyConstraintmaximum" : "keyConstraintmaximum",
"name "className" : "name",
"valueConstraint" : "valueConstraint",
"type" : "PARTITION",
"diskStoreName" : "diskStoreName",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 1,
"memberName" : "memberName"
}, {
"entryCount" : 1,
"memberName" : "memberName"
} ]
} ],
"links" : { },
"statusMessage" : "statusMessage",
"statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

Models

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_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_RuntimeInfo

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_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_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

ClusterManagementListResult_Index_RuntimeInfo

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

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

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
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operator (optional)
String
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementOperationStatusResult_RebalanceResult

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

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

ConfigurationResult_Index_RuntimeInfo

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

ConfigurationResult_Member_MemberInformation

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

ConfigurationResult_Region_RuntimeRegionInfo

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

Expiration

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

GatewayReceiver

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

GatewayReceiverInfo

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

Index

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

Member

group (optional)
String
id (optional)
String

MemberInformation

cacheServerInfo (optional)
cacheXmlFilePath (optional)
String
clientCount (optional)
Integer format: int32
coordinator (optional)
Boolean
cpuUsage (optional)
Double format: double
groups (optional)
String
heapUsage (optional)
Long format: int64
host (optional)
String
hostedRegions (optional)
array[String]
httpServiceBindAddress (optional)
String
httpServicePort (optional)
Integer format: int32
id (optional)
String
initHeapSize (optional)
Long format: int64
locatorPort (optional)
Integer format: int32
locators (optional)
String
logFilePath (optional)
String
maxHeapSize (optional)
Long format: int64
memberName (optional)
String
offHeapMemorySize (optional)
String
processId (optional)
Integer format: int32
secured (optional)
Boolean
server (optional)
Boolean
serverBindAddress (optional)
String
statArchiveFilePath (optional)
String
status (optional)
String
webSSL (optional)
Boolean
workingDirPath (optional)
String

Pdx

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

RebalanceOperation

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

RebalanceRegionResult

bucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64

RebalanceResult

rebalanceRegionResults (optional)
statusMessage (optional)
String
className",
"parameters" : [ null, null ]
}
},
"entryIdleTime" : {
"action" : "action",
"timeout" : "timeout"
},
"dataPolicy" : "EMPTY",
"initialCapacity" : "initialCapacity",
"diskWriteAttributes" : {
"rollOplogs" : "rollOplogs",
"synchronousWrites" : { },
"maxOplogSize" : "maxOplogSize",
"asynchronousWrites" : {
"bytesThreshold" : "bytesThreshold",
"timeInterval" : "timeInterval"
}
},
"gatewaySenderIds" : "gatewaySenderIds",
"enableSubscriptionConflation" : true,
"cacheListeners" : [ {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
}, {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
} ],
"concurrencyLevel" : "concurrencyLevel",
"ignoreJta" : true,
"scope" : "DISTRIBUTED_ACK",
"persistBackup" : true,
"offHeap" : true,
"id" : "id",
"refid" : "refid",
"poolName" : "poolName",
"mirrorType" : "KEYS",
"earlyAck" : true,
"statisticsEnabled" : true,
"diskDirs" : {
"diskDirs" : [ {
"dirSize" : "dirSize",
"content" : "content"
}, {
"dirSize" : "dirSize",
"content" : "content"
} ]
},
"indexUpdateType" : "ASYNCHRONOUS",
"multicastEnabled" : true,
"diskStoreName" : "diskStoreName",
"diskSynchronous" : true,
"loadFactor" : "loadFactor",
"partitionAttributes" : {
"redundantCopies" : "redundantCopies",
"startupRecoveryDelay" : "startupRecoveryDelay",
"recoveryDelay" : "recoveryDelay",
"localMaxMemory" : "localMaxMemory",
"totalNumBuckets" : "totalNumBuckets",
"colocatedWith" : "colocatedWith",
"fixedPartitionAttributes" : [ {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
}, {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
} ],
"totalMaxMemory" : "totalMaxMemory",
"partitionListeners" : [ null, null ]
},
"enableGateway" : true,
"subscriptionAttributes" : {
"interestPolicy" : "interestPolicy"
},
"keyConstraint" : "keyConstraint",
"cloningEnabled" : true,
"publisher" : true,
"valueConstraint" : "valueConstraint",
"compressor" : {
"className" : "className"
}
},
"indexes" : [ {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
}, {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
} ],
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 0,
"memberName" : "memberName"
}, {
"entryCount" : 0,
"memberName" : "memberName"
} ]
}, {
"config" : {
"regionAttributes" : {
"enableAsyncConflation" : true,
"hubId" : "hubId",
"isLockGrantor" : true,
"membershipAttributes" : {
"requiredRoles" : [ {
"name" : "name"
}, {
"name" : "name"
} ],
"lossAction" : "lossAction",
"resumptionAction" : "resumptionAction"
},
"concurrencyChecksEnabled" : true,
"asyncEventQueueIds" : "asyncEventQueueIds",
"evictionAttributes" : {
"lruHeapPercentage" : {
"action" : "LOCAL_DESTROY",
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
},
"lruEntryCount" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum"
},
"lruMemorySize" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum",
"className" : "className",
"parameters" : [ null, null ]
}
},
"entryIdleTime" : {
"action" : "action",
"timeout" : "timeout"
},
"dataPolicy" : "EMPTY",
"initialCapacity" : "initialCapacity",
"diskWriteAttributes" : {
"rollOplogs" : "rollOplogs",
"synchronousWrites" : { },
"maxOplogSize" : "maxOplogSize",
"asynchronousWrites" : {
"bytesThreshold" : "bytesThreshold",
"timeInterval" : "timeInterval"
}
},
"gatewaySenderIds" : "gatewaySenderIds",
"enableSubscriptionConflation" : true,
"cacheListeners" : [ {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
}, {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
} ],
"concurrencyLevel" : "concurrencyLevel",
"ignoreJta" : true,
"scope" : "DISTRIBUTED_ACK",
"persistBackup" : true,
"offHeap" : true,
"id" : "id",
"refid" : "refid",
"poolName" : "poolName",
"mirrorType" : "KEYS",
"earlyAck" : true,
"statisticsEnabled" : true,
"diskDirs" : {
"diskDirs" : [ {
"dirSize" : "dirSize",
"content" : "content"
}, {
"dirSize" : "dirSize",
"content" : "content"
} ]
},
"indexUpdateType" : "ASYNCHRONOUS",
"multicastEnabled" : true,
"diskStoreName" : "diskStoreName",
"diskSynchronous" : true,
"loadFactor" : "loadFactor",
"partitionAttributes" : {
"redundantCopies" : "redundantCopies",
"startupRecoveryDelay" : "startupRecoveryDelay",
"recoveryDelay" : "recoveryDelay",
"localMaxMemory" : "localMaxMemory",
"totalNumBuckets" : "totalNumBuckets",
"colocatedWith" : "colocatedWith",
"fixedPartitionAttributes" : [ {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
}, {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
} ],
"totalMaxMemory" : "totalMaxMemory",
"partitionListeners" : [ null, null ]
},
"enableGateway" : true,
"subscriptionAttributes" : {
"interestPolicy" : "interestPolicy"
},
"keyConstraint" : "keyConstraint",
"cloningEnabled" : true,
"publisher" : true,
"valueConstraint" : "valueConstraint",
"compressor" : {
"className" : "className"
}
},
"indexes" : [ {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
}, {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
} ],
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 0,
"memberName" : "memberName"
}, {
"entryCount" : 0,
"memberName" : "memberName"
} ]
} ],
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListResult_RegionConfig_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

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

listIndex

Path parameters

regionName (required)
Path Parameter -- regionName

Query parameters

id (optional)
Query Parameter -- id

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"config" : {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
}, {
"config" : {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"memberName" : "memberName"
}, {
"memberName" : "memberName"
} ]
} ],
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListResult_Index_RuntimeInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/experimental/regions

listRegion

Query parameters

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

Return type

Example data

Content-Type: application/json
{
"result" : [ {
"config" : {
"regionAttributes" : {
"enableAsyncConflation" : true,
"hubId" : "hubId",
"isLockGrantor" : true,
"membershipAttributes" : {
"requiredRoles" : [ {
"name" : "name"
}, {
"name" : "name"
} ],
"lossAction" : "lossAction",
"resumptionAction" : "resumptionAction"
},
"concurrencyChecksEnabled" : true,
"asyncEventQueueIds" : "asyncEventQueueIds",
"evictionAttributes" : {
"lruHeapPercentage" : {
"action" : "LOCAL_DESTROY",
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
},
"lruEntryCount" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum"
},
"lruMemorySize" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum",
"className" : "className",
"parameters" : [ null, null ]
}
},
"entryIdleTime" : {
"action" : "action",
"timeout" : "timeout"
},
"dataPolicy" : "EMPTY",
"initialCapacity" : "initialCapacity",
"diskWriteAttributes" : {
"rollOplogs" : "rollOplogs",
"synchronousWrites" : { },
"maxOplogSize" : "maxOplogSize",
"asynchronousWrites" : {
"bytesThreshold" : "bytesThreshold",
"timeInterval" : "timeInterval"
}
},
"gatewaySenderIds" : "gatewaySenderIds",
"enableSubscriptionConflation" : true,
"cacheListeners" : [ {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
}, {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
} ],
"concurrencyLevel" : "concurrencyLevel",
"ignoreJta" : true,
"scope" : "DISTRIBUTED_ACK",
"persistBackup" : true,
"offHeap" : true,
"id" : "id",
"refid" : "refid",
"poolName" : "poolName",
"mirrorType" : "KEYS",
"earlyAck" : true,
"statisticsEnabled" : true,
"diskDirs" : {
"diskDirs" : [ {
"dirSize" : "dirSize",
"content" : "content"
}, {
"dirSize" : "dirSize",
"content" : "content"
} ]
},
"indexUpdateType" : "ASYNCHRONOUS",
"multicastEnabled" : true,
"diskStoreName" : "diskStoreName",
"diskSynchronous" : true,
"loadFactor" : "loadFactor",
"partitionAttributes" : {
"redundantCopies" : "redundantCopies",
"startupRecoveryDelay" : "startupRecoveryDelay",
"recoveryDelay" : "recoveryDelay",
"localMaxMemory" : "localMaxMemory",
"totalNumBuckets" : "totalNumBuckets",
"colocatedWith" : "colocatedWith",
"fixedPartitionAttributes" : [ {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
}, {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
} ],
"totalMaxMemory" : "totalMaxMemory",
"partitionListeners" : [ null, null ]
},
"enableGateway" : true,
"subscriptionAttributes" : {
"interestPolicy" : "interestPolicy"
},
"keyConstraint" : "keyConstraint",
"cloningEnabled" : true,
"publisher" : true,
"valueConstraint" : "valueConstraint",
"compressor" : {
"className" : "className"
}
},
"indexes" : [ {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
}, {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
} ],
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 0,
"memberName" : "memberName"
}, {
"entryCount" : 0,
"memberName" : "memberName"
} ]
}, {
"config" : {
"regionAttributes" : {
"enableAsyncConflation" : true,
"hubId" : "hubId",
"isLockGrantor" : true,
"membershipAttributes" : {
"requiredRoles" : [ {
"name" : "name"
}, {
"name" : "name"
} ],
"lossAction" : "lossAction",
"resumptionAction" : "resumptionAction"
},
"concurrencyChecksEnabled" : true,
"asyncEventQueueIds" : "asyncEventQueueIds",
"evictionAttributes" : {
"lruHeapPercentage" : {
"action" : "LOCAL_DESTROY",
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
},
"lruEntryCount" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum"
},
"lruMemorySize" : {
"action" : "LOCAL_DESTROY",
"maximum" : "maximum",
"className" : "className",
"parameters" : [ null, null ]
}
},
"entryIdleTime" : {
"action" : "action",
"timeout" : "timeout"
},
"dataPolicy" : "EMPTY",
"initialCapacity" : "initialCapacity",
"diskWriteAttributes" : {
"rollOplogs" : "rollOplogs",
"synchronousWrites" : { },
"maxOplogSize" : "maxOplogSize",
"asynchronousWrites" : {
"bytesThreshold" : "bytesThreshold",
"timeInterval" : "timeInterval"
}
},
"gatewaySenderIds" : "gatewaySenderIds",
"enableSubscriptionConflation" : true,
"cacheListeners" : [ {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
}, {
"className" : "className",
"parameters" : [ {
"string" : "string",
"name" : "name"
}, {
"string" : "string",
"name" : "name"
} ]
} ],
"concurrencyLevel" : "concurrencyLevel",
"ignoreJta" : true,
"scope" : "DISTRIBUTED_ACK",
"persistBackup" : true,
"offHeap" : true,
"id" : "id",
"refid" : "refid",
"poolName" : "poolName",
"mirrorType" : "KEYS",
"earlyAck" : true,
"statisticsEnabled" : true,
"diskDirs" : {
"diskDirs" : [ {
"dirSize" : "dirSize",
"content" : "content"
}, {
"dirSize" : "dirSize",
"content" : "content"
} ]
},
"indexUpdateType" : "ASYNCHRONOUS",
"multicastEnabled" : true,
"diskStoreName" : "diskStoreName",
"diskSynchronous" : true,
"loadFactor" : "loadFactor",
"partitionAttributes" : {
"redundantCopies" : "redundantCopies",
"startupRecoveryDelay" : "startupRecoveryDelay",
"recoveryDelay" : "recoveryDelay",
"localMaxMemory" : "localMaxMemory",
"totalNumBuckets" : "totalNumBuckets",
"colocatedWith" : "colocatedWith",
"fixedPartitionAttributes" : [ {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
}, {
"partitionName" : "partitionName",
"isPrimary" : true,
"numBuckets" : "numBuckets"
} ],
"totalMaxMemory" : "totalMaxMemory",
"partitionListeners" : [ null, null ]
},
"enableGateway" : true,
"subscriptionAttributes" : {
"interestPolicy" : "interestPolicy"
},
"keyConstraint" : "keyConstraint",
"cloningEnabled" : true,
"publisher" : true,
"valueConstraint" : "valueConstraint",
"compressor" : {
"className" : "className"
}
},
"indexes" : [ {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
}, {
"expression" : "expression",
"fromClause" : "fromClause",
"imports" : "imports",
"keyIndex" : true,
"regionName" : "regionName",
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
} ],
"name" : "name",
"groups" : [ "groups", "groups" ],
"type" : "type",
"uri" : "uri",
"group" : "group"
},
"runtimeInfo" : [ {
"entryCount" : 0,
"memberName" : "memberName"
}, {
"entryCount" : 0,
"memberName" : "memberName"
} ]
} ],
"uri" : "uri",
"statusMessage" : "statusMessage",
"statusCode" : "ILLEGAL_ARGUMENT"
}

Responses

200

OK ClusterManagementListResult_RegionConfig_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

Models

AsynchronousWrites

bytesThreshold (optional)
String
timeInterval (optional)
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]

ClassNameType

className (optional)
String

ClusterManagementListOperationsResult_RebalanceResult

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

ClusterManagementListResult_GatewayReceiverConfig_GatewayReceiverInfo

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

ClusterManagementListResult_Index_RuntimeInfo

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

ClusterManagementListResult_MemberConfig_MemberInformation

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

ClusterManagementListResult_RegionConfig_RuntimeRegionInfo

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

ClusterManagementOperationResult_RebalanceResult

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
statusCode (optional)
String
Enum:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementOperationStatusResult_RebalanceResult

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:
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
OK
statusMessage (optional)
String
uri (optional)
String

ClusterManagementResult

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

ConfigurationResult_Index_RuntimeInfo

config (optional)
runtimeInfo (optional)

DeclarableType

className (optional)
String
parameters (optional)

DiskDirType

content (optional)
String
dirSize (optional)
String

DiskDirsType

diskDirs (optional)

DiskWriteAttributes

asynchronousWrites (optional)
maxOplogSize (optional)
String
rollOplogs (optional)
String
synchronousWrites (optional)
Object

EvictionAttributes

lruEntryCount (optional)
lruHeapPercentage (optional)
lruMemorySize (optional)

ExpirationAttributesType

action (optional)
String
customExpiry (optional)
timeout (optional)
String

FixedPartitionAttributes

isPrimary (optional)
Boolean
numBuckets (optional)
String
partitionName (optional)
String

GatewayReceiverConfig

bindAddress (optional)
String
endPort (optional)
String
gatewayTransportFilters (optional)
group (optional)
String
groups (optional)
array[String]
hostnameForSenders (optional)
String
manualStart (optional)
Boolean
maximumTimeBetweenPings (optional)
String
socketBufferSize (optional)
String
startPort (optional)
String
uri (optional)
String

GatewayReceiverInfo

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

Index

expression (optional)
String
fromClause (optional)
String
group (optional)
String
groups (optional)
array[String]
imports (optional)
String
keyIndex (optional)
Boolean
name (optional)
String
regionName (optional)
String
type (optional)
String
uri (optional)
String

LruEntryCount

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
maximum (optional)
String

LruHeapPercentage

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
className (optional)
String
parameters (optional)

LruMemorySize

action (optional)
String
Enum:
LOCAL_DESTROY
OVERFLOW_TO_DISK
className (optional)
String
maximum (optional)
String
parameters (optional)

MemberConfig

groups (optional)
array[String]
id (optional)
String
uri (optional)
String

MemberInformation

cacheServerInfo (optional)
cacheXmlFilePath (optional)
String
clientCount (optional)
Integer format: int32
coordinator (optional)
Boolean
cpuUsage (optional)
Double format: double
groups (optional)
String
heapUsage (optional)
Long format: int64
host (optional)
String
hostedRegions (optional)
array[String]
httpServiceBindAddress (optional)
String
httpServicePort (optional)
Integer format: int32
id (optional)
String
initHeapSize (optional)
Long format: int64
locatorPort (optional)
Integer format: int32
locators (optional)
String
logFilePath (optional)
String
maxHeapSize (optional)
Long format: int64
memberName (optional)
String
offHeapMemorySize (optional)
String
processId (optional)
Integer format: int32
secured (optional)
Boolean
server (optional)
Boolean
serverBindAddress (optional)
String
statArchiveFilePath (optional)
String
status (optional)
String
webSSL (optional)
Boolean
workingDirPath (optional)
String

MembershipAttributes

lossAction (optional)
String
requiredRoles (optional)
resumptionAction (optional)
String

ParameterType

declarable (optional)
name (optional)
String
string (optional)
String

PartitionAttributes

colocatedWith (optional)
String
fixedPartitionAttributes (optional)
localMaxMemory (optional)
String
partitionListeners (optional)
partitionResolver (optional)
recoveryDelay (optional)
String
redundantCopies (optional)
String
startupRecoveryDelay (optional)
String
totalMaxMemory (optional)
String
totalNumBuckets (optional)
String

Pdx

diskStoreName (optional)
String
group (optional)
String
groups (optional)
array[String]
ignoreUnreadFields (optional)
Boolean
pdxSerializer (optional)
persistent (optional)
Boolean
readSerialized (optional)
Boolean
uri (optional)
String

RebalanceOperation

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

RebalanceRegionResult

bucketCreateBytes (optional)
Long format: int64
bucketCreateTimeInMilliseconds (optional)
Long format: int64
bucketCreatesCompleted (optional)
Integer format: int32
bucketTransferBytes (optional)
Long format: int64
bucketTransferTimeInMilliseconds (optional)
Long format: int64
bucketTransfersCompleted (optional)
Integer format: int32
primaryTransferTimeInMilliseconds (optional)
Long format: int64
primaryTransfersCompleted (optional)
Integer format: int32
regionName (optional)
String
timeInMilliseconds (optional)
Long format: int64

RebalanceResult

rebalanceRegionResults (optional)
statusMessage (optional)
String

RegionAttributesType

asyncEventQueueIds (optional)
String
cacheListeners (optional)
cacheLoader (optional)
cacheWriter (optional)
cloningEnabled (optional)
Boolean
compressor (optional)
concurrencyChecksEnabled (optional)
Boolean
concurrencyLevel (optional)
String
dataPolicy (optional)
String
Enum:
EMPTY
NORMAL
PARTITION
PERSISTENT_REPLICATE
PRELOADED
REPLICATE
PERSISTENT_PARTITION
diskDirs (optional)
diskStoreName (optional)
String
diskSynchronous (optional)
Boolean
diskWriteAttributes (optional)
earlyAck (optional)
Boolean
enableAsyncConflation (optional)
Boolean
enableGateway (optional)
Boolean
enableSubscriptionConflation (optional)
Boolean
entryIdleTime (optional)
entryTimeToLive (optional)
evictionAttributes (optional)
gatewaySenderIds (optional)
String
hubId (optional)
String
id (optional)
String
ignoreJta (optional)
Boolean
indexUpdateType (optional)
String
Enum:
ASYNCHRONOUS
SYNCHRONOUS
initialCapacity (optional)
String
isLockGrantor (optional)
Boolean
keyConstraint (optional)
String
loadFactor (optional)
String
membershipAttributes (optional)
mirrorType (optional)
String
Enum:
KEYS
KEYS_VALUES
NONE
multicastEnabled (optional)
Boolean
offHeap (optional)
Boolean
partitionAttributes (optional)
persistBackup (optional)
Boolean
poolName (optional)
String
publisher (optional)
Boolean
refid (optional)
String
regionIdleTime (optional)
regionTimeToLive (optional)
scope (optional)
String
Enum:
DISTRIBUTED_ACK
DISTRIBUTED_NO_ACK
GLOBAL
LOCAL
statisticsEnabled (optional)
Boolean
subscriptionAttributes (optional)
valueConstraint (optional)
String

RegionConfig

group (optional)
String
groups (optional)
array[String]
indexes (optional)
name (optional)
String
regionAttributes (optional)
type (optional)
String
uri (optional)
String

RequiredRole

name

Region

diskStoreName (optional)
String
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

SubscriptionAttributes

interestPolicy (optional)
String