Sign in
Cluster

Fetch global cluster statistics.

Note: do not try to parse the freeform field of the response, it is given as a string specifically because its format is not stable.

get/v2/GetClusterStatistics

Response

Global cluster statistics

bucketCountinteger nullable

number of buckets in the cluster

dataAvailinteger nullable

available storage space for object data in the entire cluster, in bytes

freeformstring required

cluster statistics as a free-form string, kept for compatibility with nodes running older v2.x versions of garage

incompleteAvailInfoboolean nullable

true if the available storage space statistics are imprecise due to missing information of disconnected nodes. When this is the case, the actual space available in the cluster might be lower than the reported values.

metadataAvailinteger nullable

available storage space for object metadata in the entire cluster, in bytes

totalObjectBytesinteger nullable

total size of objects stored in all buckets, before compression, deduplication and replication (this is NOT equivalent to actual disk usage in the cluster)

totalObjectCountinteger nullable

total number of objects stored in all buckets

Changes

No recorded changes to this endpoint across all 1 revision of this API.