Update a Cache Member
post
/management/coherence/cluster/services/{serviceName}/caches/{cacheName}/members/{memberIdentifier}
Use this endpoint to update the configuration parameters for a cache member that is managed by a specific service.
Request
Path Parameters
-
cacheName: string
Name of the cache.
-
memberIdentifier: string
An identifier of the member, it can either be the name or the nodeId of the member.
-
serviceName: string
Name of the cache service.
Root Schema : cacheMember
Type:
Show Source
object
-
averageGetMillis(optional):
number(double)
Read Only:
true
The average number of milliseconds per get() invocation since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
averageHitMillis(optional):
number(double)
Read Only:
true
The average number of milliseconds per get() invocation that is a hit. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
averageMissMillis(optional):
number(double)
Read Only:
true
The average number of milliseconds per get() invocation that is a miss. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
averagePutMillis(optional):
number(double)
Read Only:
true
The average number of milliseconds per put() invocation since the cache statistics were last reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
batchFactor(optional):
number(double)
The BatchFactor attribute is used to calculate the `soft-ripe` time for write-behind queue entries. A queue entry is considered to be `ripe` for a write operation if it has been in the write-behind queue for no less than the QueueDelay interval. The `soft-ripe` time is the point in time prior to the actual `ripe` time after which an entry will be included in a batched asynchronous write operation to the CacheStore (along with all other `ripe` and `soft-ripe` entries). This attribute is only applicable if asynchronous writes are enabled (i.e. the value of the QueueDelay attribute is greater than zero) and the CacheStore implements the storeAll() method. The value of the element is expressed as a percentage of the QueueDelay interval. Valid values are doubles in the interval [0.0, 1.0].
-
cacheHits(optional):
integer(int64)
Read Only:
true
The rough number of cache hits since the last time statistics were reset. A cache hit is a read operation invocation (i.e. get()) for which an entry exists in this map. -
cacheHitsMillis(optional):
integer(int64)
Read Only:
true
The total number of milliseconds (since the last time statistics were reset) for the get() operations for which an entry existed in this map. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
cacheMisses(optional):
integer(int64)
Read Only:
true
The rough number of cache misses since the last time statistics were reset. -
cacheMissesMillis(optional):
integer(int64)
Read Only:
true
The total number of milliseconds ( since the last time statistics were reset) for the get() operations for which no entry existed in this map. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
cachePrunes(optional):
integer(int64)
Read Only:
true
The number of `prune` operations since the last time statistics were reset. A prune operation occurs every time the cache reaches its high watermark. -
cachePrunesMillis(optional):
integer(int64)
Read Only:
true
The total number of milliseconds for the prune operations since the last time statistics were reset. -
cacheStoreType(optional):
string
Read Only:
true
The cache store type for this cache. Possible values include NONE, READ-ONLY, WRITE-THROUGH, WRITE-BEHIND. -
description(optional):
string
Read Only:
true
The cache description. -
eventInterceptorInfo(optional):
array eventInterceptorInfo
Read Only:
true
An array of statistics for events processed by event interceptors. -
eventsDispatched(optional):
integer(int64)
Read Only:
true
The total number of events dispatched by the StorageManager since the last time the statistics were reset. -
evictionCount(optional):
integer(int64)
Read Only:
true
The number of evictions from the backing map managed by this StorageManager caused by entries expiry or insert operations that would make the underlying backing map to reach its configured size limit. The eviction count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the eviction count is not reset by the reset statistics method. -
expiryDelay(optional):
integer(int32)
The time-to-live for cache entries in milliseconds. Value of zero indicates that the automatic expiry is disabled. Change of this attribute will not affect already-scheduled expiry of existing entries.
-
highUnits(optional):
integer(int32)
The limit of the cache size measured in units. The cache will prune itself automatically once it reaches its maximum unit level. This is often referred to as the `high water mark` of the cache.
-
hitProbability(optional):
number(double)
Read Only:
true
The rough probability (0 <= p <="1)" that the next invocation will be a hit, based on statistics collected since last time were reset.< div> => -
indexInfo(optional):
array indexInfo
Read Only:
true
An array of information for each index applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that includes a ValueExtractor description, ordered flag (true to indicate that the contents of the index are ordered; false otherwise), and cardinality (number of unique values indexed). -
indexTotalUnits(optional):
integer(int64)
Read Only:
true
The total units used by all indices on the associated cache. -
insertCount(optional):
integer(int64)
Read Only:
true
The number of inserts into the backing map managed by this StorageManager. In addition to standard inserts caused by put and invoke operations or synthetic inserts caused by get operations with read-through backing map topology, this counter is incremented when distribution transfers move resources `into` the underlying backing map and is decremented when distribution transfers move data `out`. The insert count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the insert count is not reset by the reset statistics method. -
listenerFilterCount(optional):
integer(int32)
Read Only:
true
The number of filter-based listeners currently registered with the StorageManager. -
listenerKeyCount(optional):
integer(int32)
Read Only:
true
The number of key-based listeners currently registered with the StorageManager. -
listenerRegistrations(optional):
integer(int64)
Read Only:
true
The total number of listener registration requests processed by the StorageManager since the last time the statistics were reset. -
location(optional):
string
Read Only:
true
The location of the MBean server -
locksGranted(optional):
integer(int32)
Read Only:
true
The number of locks currently granted for the portion of the partitioned cache managed by the StorageManager. -
locksPending(optional):
integer(int32)
Read Only:
true
The number of pending lock requests for the portion of the partitioned cache managed by the StorageManager. -
lowUnits(optional):
integer(int32)
The number of units to which the cache will shrink when it prunes. This is often referred to as a `low water mark` of the cache.
-
maxQueryDescription(optional):
string
Read Only:
true
A string representation of a query with the longest execution time exceeding the MaxQueryThresholdMillis since statistics were last reset. -
maxQueryDurationMillis(optional):
integer(int64)
Read Only:
true
The duration in milliseconds of the longest query execution since statistics were last reset. -
maxQueryThresholdMillis(optional):
integer(int64)
A query execution threshold in milliseconds The longest query executing longer than this threshold will be reported by the MaxQueryDescription attribute.
-
member(optional):
string
Name of the cluster member
-
memoryUnits(optional):
boolean
Read Only:
true
Determines if Units is measuring the memory usage of the cache. If true, Units * UnitFactor is the number of bytes consumed by the cache. -
name(optional):
string
Read Only:
true
The name of the cache -
nodeId(optional):
integer(int64)
Read Only:
true
The ID of member to which the MBean belongs -
nonOptimizedQueryAverageMillis(optional):
integer(int64)
Read Only:
true
The average duration in milliseconds per non-optimized query execution since the statistics were last reset. -
nonOptimizedQueryCount(optional):
integer(int64)
Read Only:
true
The total number of queries that could not be resolved or were partially resolved against indexes since statistics were last reset. -
nonOptimizedQueryTotalMillis(optional):
integer(int64)
Read Only:
true
The total execution time in milliseconds for queries that could not be resolved or were partially resolved against indexes since statistics were last reset. -
optimizedQueryAverageMillis(optional):
integer(int64)
Read Only:
true
The average duration in milliseconds per optimized query execution since the statistics were last reset. -
optimizedQueryCount(optional):
integer(int64)
Read Only:
true
The total number of queries that were fully resolved using indexes since statistics were last reset. -
optimizedQueryTotalMillis(optional):
integer(int64)
Read Only:
true
The total execution time in milliseconds for queries that were fully resolved using indexes since statistics were last reset. -
persistenceType(optional):
string
Read Only:
true
Deprecated - use attribute CacheStoreType instead. -
queryContentionCount(optional):
integer(int64)
Read Only:
true
Total number of times a query had to be re-evaluated due to a concurrent update since statistics were last reset. This statistics provides a measure of an impact of concurrent updates on the query perfomance. If the total number of queries is Q and the number of contentions is C then the expected performance degradation factor should be no more than (Q + C)/Q. -
queueDelay(optional):
integer(int32)
The number of seconds that an entry added to a write-behind queue will sit in the queue before being stored via a CacheStore. Applicable only for WRITE-BEHIND persistence type.
-
queueSize(optional):
integer(int32)
Read Only:
true
The size of the write-behind queue size. Applicable only for WRITE-BEHIND persistence type. -
refreshFactor(optional):
number(double)
The RefreshFactor attribute is used to calculate the `soft-expiration` time for cache entries. Soft-expiration is the point in time prior to the actual expiration after which any access request for an entry will schedule an asynchronous load request for the entry. This attribute is only applicable for a ReadWriteBackingMap which has an internal LocalCache with scheduled automatic expiration. The value of this element is expressed as a percentage of the internal LocalCache expiration interval. Valid values are doubles in the interval[0.0, 1.0]. If zero, refresh-ahead scheduling will be disabled.
-
refreshTime(optional):
string(date-time)
Read Only:
true
The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time. -
removeCount(optional):
integer(int64)
Read Only:
true
The number of removes from the backing map managed by this StorageManager caused by operations such as clear, remove or invoke. The remove count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the remove count is not reset by the reset statistics method. -
requeueThreshold(optional):
integer(int32)
The maximum size of the write-behind queue for which failed CacheStore write operations are requeued. If zero, the write-behind requeueing will be disabled. Applicable only for WRITE-BEHIND persistence type.
-
service(optional):
string
The cache service name
-
size(optional):
integer(int32)
Read Only:
true
The number of entries in the cache. -
storeAverageBatchSize(optional):
integer(int64)
Read Only:
true
The average number of entries stored per CacheStore write operation. A call to the store() method is counted as a batch of one, whereas a call to the storeAll() method is counted as a batch of the passed Map size. The value of this attribute is -1 if the persistence type is NONE. -
storeAverageReadMillis(optional):
integer(int64)
Read Only:
true
The average time (in millis) spent per read operation; -1 if persistence type is NONE. This statistic is only tracked for caches associated with a CacheStore. -
storeAverageWriteMillis(optional):
integer(int64)
Read Only:
true
The average time (in millis) spent per write operation; -1 if persistence type is NONE. This statistic is only tracked for caches associated with a CacheStore. -
storeFailures(optional):
integer(int64)
Read Only:
true
The total number of CacheStore failures (load, store and erase operations); -1 if persistence type is NONE. -
storeReadMillis(optional):
integer(int64)
Read Only:
true
The cummulative time (in millis) spent on load operations; -1 if persistence type is NONE. This statistic is only tracked for caches associated with a CacheStore. -
storeReads(optional):
integer(int64)
Read Only:
true
The total number of load operations; -1 if persistence type is NONE. -
storeWriteMillis(optional):
integer(int64)
Read Only:
true
The cumulative time (in milliseconds) spent on store and erase operations; -1 if persistence type is NONE or READ-ONLY. This statistic is only tracked for caches associated with a CacheStore. -
storeWrites(optional):
integer(int64)
Read Only:
true
The total number of store and erase operations; -1 if persistence type is NONE or READ-ONLY. -
tier(optional):
string
Read Only:
true
Allowed Values:[ "front", "back" ]
Tier of the cache. -
totalGets(optional):
integer(int64)
Read Only:
true
The total number of get() operations since the last time statistics were reset. -
totalGetsMillis(optional):
integer(int64)
Read Only:
true
The total number of milliseconds spent on get() operations since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
totalPuts(optional):
integer(int64)
Read Only:
true
The total number of put() operations since the last time statistics were reset. -
totalPutsMillis(optional):
integer(int64)
Read Only:
true
The total number of milliseconds spent on put() operations since the last time statistics were reset. This statistic is only tracked for caches that may incur expensive hits (for example the front of a near cache). -
triggerInfo(optional):
array triggerInfo
Read Only:
true
An array of information for each trigger applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that represents a human-readable description of the corresponding MapTrigger. -
type(optional):
string
Read Only:
true
Allowed Values:[ "Cache" ]
The type of the MBean -
unitFactor(optional):
integer(int32)
Read Only:
true
The factor by which the Units, LowUnits and HighUnits properties are adjusted. Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes. -
units(optional):
integer(int32)
Read Only:
true
The size of the cache measured in units. This value needs to be adjusted by the UnitFactor.
Nested Schema : eventInterceptorInfo
Type:
array
Read Only:
true
An array of statistics for events processed by event interceptors.
Show Source
Nested Schema : indexInfo
Type:
array
Read Only:
true
An array of information for each index applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that includes a ValueExtractor description, ordered flag (true to indicate that the contents of the index are ordered; false otherwise), and cardinality (number of unique values indexed).
Show Source
Nested Schema : triggerInfo
Type:
array
Read Only:
true
An array of information for each trigger applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that represents a human-readable description of the corresponding MapTrigger.
Show Source
Response
Supported Media Types
- application/json
200 Response
A successful request that updates the cache parameters