Object Storage API, REST: Bucket.GetStats
Returns the statistics for the specified bucket.
HTTP request
GET https://storage.api.cloud.yandex.net/storage/v1/buckets/{name}:getStats
Path parameters
Field |
Description |
name |
string Required field. Name of the bucket to return the statistics for. |
Response
HTTP Code: 200 - OK
{
"name": "string",
"maxSize": "string",
"usedSize": "string",
"storageClassMaxSizes": [
{
"storageClass": "string",
"classSize": "string"
}
],
"storageClassUsedSizes": [
{
"storageClass": "string",
"classSize": "string"
}
],
"storageClassCounters": [
{
"storageClass": "string",
"counters": {
"simpleObjectSize": "string",
"simpleObjectCount": "string",
"objectsPartsSize": "string",
"objectsPartsCount": "string",
"multipartObjectsSize": "string",
"multipartObjectsCount": "string",
"activeMultipartCount": "string"
}
}
],
"defaultStorageClass": "string",
"anonymousAccessFlags": {
"read": "boolean",
"list": "boolean",
"configRead": "boolean"
},
"createdAt": "string",
"updatedAt": "string"
}
A bucket statistics resource.
Field |
Description |
name |
string Name of the bucket. |
maxSize |
string (int64) Maximum size of the bucket, in bytes. |
usedSize |
string (int64) Size of used space in the bucket, in bytes. |
storageClassMaxSizes[] |
Size of available space in the bucket by storage class, in bytes. |
storageClassUsedSizes[] |
Size of used space in the bucket by storage class, in bytes. |
storageClassCounters[] |
Object-related statistics by storage class and type of upload (simple vs. multipart), in bytes. |
defaultStorageClass |
string Default storage class for objects in the bucket. Supported classes are standard storage ( |
anonymousAccessFlags |
Flags for configuring public (anonymous) access to the bucket's content and settings. |
createdAt |
string (date-time) Bucket creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Bucket latest update timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
OptionalSizeByClass
A resource for size of available space in a bucket for a storage class.
Field |
Description |
storageClass |
string Storage class. Supported classes are standard storage ( |
classSize |
string (int64) Size of available space in the bucket for the storage class. |
SizeByClass
A resource for size of used space in a bucket for a storage class.
Field |
Description |
storageClass |
string Storage class. Supported classes are standard storage ( |
classSize |
string (int64) Size of used space in the bucket for the storage class. |
CountersByClass
A resource for object-related statistics for a storage class by type of upload (simple vs. multipart).
Field |
Description |
storageClass |
string Storage class. Supported classes are standard storage ( |
counters |
Object-related statistics for the storage class by type of upload. |
Counters
Field |
Description |
simpleObjectSize |
string (int64) Total size of objects uploaded in single operation, in bytes. |
simpleObjectCount |
string (int64) Number of objects uploaded in single operation. |
objectsPartsSize |
string (int64) Total size of uploaded parts in incomplete multipart uploads, in bytes. |
objectsPartsCount |
string (int64) Number of uploaded parts in incomplete multipart uploads. |
multipartObjectsSize |
string (int64) Total size of objects uploaded in multiple parts, in bytes. |
multipartObjectsCount |
string (int64) Number of objects uploaded in multiple parts. |
activeMultipartCount |
string (int64) Number of incomplete multipart uploads. |
AnonymousAccessFlags
Field |
Description |
read |
boolean Specifies whether public (anonymous) access to read objects in the bucket is enabled. |
list |
boolean Specifies whether public (anonymous) access to the list of objects in the bucket is enabled. |
configRead |
boolean Specifies whether public (anonymous) access to read CORS, |