Jump to

• Request
• Response

View Storage Managers

get

/management/coherence/cluster/storage

Use this endpoint to view list of storage managers in the cluster. A Storage instance manages all index, listener, and lock information for the portion of the DistributedCache managed by the local member.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that returns the storage managers in a Coherence cluster

Body ()

Root Schema : schema

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/storage"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object storage
  Details of the particular storage manager.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/storage"
    }
}

Nested Schema : storage

Type: object

Details of the particular storage manager.

Show Source

• cache(optional): string
  Name of the cache.
• 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.
• indexingTotalMillis(optional): integet(int64)
  Read Only: true

  The cumulative duration in milliseconds of index builds since statistics were last reset.
• 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.
• 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.
• 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.
• nodeId(optional): array nodeId
  Storage manager members.
• 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.
• 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.
• 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.
• service(optional): string
  Name of the service.

{
    "type":"object",
    "description":"Details of the particular storage manager.",
    "properties":{
        "cache":{
            "type":"string",
            "description":"Name of the cache."
        },
        "service":{
            "type":"string",
            "description":"Name of the service."
        },
        "nodeId":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int64"
            },
            "description":"Storage manager members."
        },
        "insertCount":{
            "type":"integer",
            "format":"int64",
            "description":"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.",
            "readOnly":true
        },
        "evictionCount":{
            "type":"integer",
            "format":"int64",
            "description":"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.",
            "readOnly":true
        },
        "indexingTotalMillis":{
            "type":"integet",
            "format":"int64",
            "description":"The cumulative duration in milliseconds of index builds since statistics were last reset.",
            "readOnly":true
        },
        "listenerKeyCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of key-based listeners currently registered with the StorageManager.",
            "readOnly":true
        },
        "nonOptimizedQueryTotalMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The total execution time in milliseconds for queries that could not be resolved or were partially resolved against indexes since statistics were last reset.",
            "readOnly":true
        },
        "listenerRegistrations":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of listener registration requests processed by the StorageManager since the last time the statistics were reset.",
            "readOnly":true
        },
        "listenerFilterCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of filter-based listeners currently registered with the StorageManager.",
            "readOnly":true
        },
        "nonOptimizedQueryCount":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of queries that could not be resolved or were partially resolved against indexes since statistics were last reset.",
            "readOnly":true
        },
        "locksGranted":{
            "type":"integer",
            "format":"int32",
            "description":"The number of locks currently granted for the portion of the partitioned cache managed by the StorageManager.",
            "readOnly":true
        },
        "indexTotalUnits":{
            "type":"integer",
            "format":"int64",
            "description":"The total units used by all indices on the associated cache.",
            "readOnly":true
        },
        "optimizedQueryAverageMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The average duration in milliseconds per optimized query execution since the statistics were last reset.",
            "readOnly":true
        },
        "optimizedQueryTotalMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The total execution time in milliseconds for queries that were fully resolved using indexes since statistics were last reset.",
            "readOnly":true
        },
        "removeCount":{
            "type":"integer",
            "format":"int64",
            "description":"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.",
            "readOnly":true
        },
        "locksPending":{
            "type":"integer",
            "format":"int32",
            "description":"The number of pending lock requests for the portion of the partitioned cache managed by the StorageManager.",
            "readOnly":true
        },
        "queryContentionCount":{
            "type":"integer",
            "format":"int64",
            "description":"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.",
            "readOnly":true
        },
        "eventsDispatched":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of events dispatched by the StorageManager since the last time the statistics were reset.",
            "readOnly":true
        },
        "optimizedQueryCount":{
            "type":"integer",
            "format":"int64",
            "description":"The total number of queries that were fully resolved using indexes since statistics were last reset.",
            "readOnly":true
        },
        "maxQueryDurationMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The duration in milliseconds of the longest query execution since statistics were last reset.",
            "readOnly":true
        },
        "maxQueryThresholdMillis":{
            "type":"integer",
            "format":"int64",
            "description":"A query execution threshold in milliseconds The longest query executing longer than this threshold will be reported by the MaxQueryDescription attribute.",
            "readOnly":false
        },
        "nonOptimizedQueryAverageMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The average duration in milliseconds per non-optimized query execution since the statistics were last reset.",
            "readOnly":true
        }
    }
}

Nested Schema : nodeId

Type: array

Storage manager members.

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int64"
    },
    "description":"Storage manager members."
}

Back to Top