Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Object Storage
  • Terraform reference
    • Authentication with the API
        • Overview
          • Overview
          • List
          • Get
          • Create
          • Update
          • Delete
          • GetStats
          • GetHTTPSConfig
          • SetHTTPSConfig
          • DeleteHTTPSConfig
  • Monitoring metrics
  • Audit Trails events
  • Bucket logs
  • Release notes
  • FAQ

In this article:

  • gRPC request
  • GetBucketStatsRequest
  • BucketStats
  • OptionalSizeByClass
  • SizeByClass
  • CountersByClass
  • Counters
  • AnonymousAccessFlags
  1. API reference
  2. gRPC and REST
  3. gRPC
  4. Bucket
  5. GetStats

Object Storage API, gRPC: BucketService.GetStats

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • GetBucketStatsRequest
  • BucketStats
  • OptionalSizeByClass
  • SizeByClass
  • CountersByClass
  • Counters
  • AnonymousAccessFlags

Returns the statistics for the specified bucket.

gRPC request

rpc GetStats (GetBucketStatsRequest) returns (BucketStats)

GetBucketStatsRequest

{
  "name": "string"
}

Field

Description

name

string

Required field. Name of the bucket to return the statistics for.

BucketStats

{
  "name": "string",
  "max_size": "google.protobuf.Int64Value",
  "used_size": "int64",
  "storage_class_max_sizes": [
    {
      "storage_class": "string",
      "class_size": "google.protobuf.Int64Value"
    }
  ],
  "storage_class_used_sizes": [
    {
      "storage_class": "string",
      "class_size": "int64"
    }
  ],
  "storage_class_counters": [
    {
      "storage_class": "string",
      "counters": {
        "simple_object_size": "int64",
        "simple_object_count": "int64",
        "objects_parts_size": "int64",
        "objects_parts_count": "int64",
        "multipart_objects_size": "int64",
        "multipart_objects_count": "int64",
        "active_multipart_count": "int64"
      }
    }
  ],
  "default_storage_class": "google.protobuf.StringValue",
  "anonymous_access_flags": {
    "read": "google.protobuf.BoolValue",
    "list": "google.protobuf.BoolValue",
    "config_read": "google.protobuf.BoolValue"
  },
  "created_at": "google.protobuf.Timestamp",
  "updated_at": "google.protobuf.Timestamp"
}

A bucket statistics resource.

Field

Description

name

string

Name of the bucket.

max_size

google.protobuf.Int64Value

Maximum size of the bucket, in bytes.

used_size

int64

Size of used space in the bucket, in bytes.

storage_class_max_sizes[]

OptionalSizeByClass

Size of available space in the bucket by storage class, in bytes.

storage_class_used_sizes[]

SizeByClass

Size of used space in the bucket by storage class, in bytes.

storage_class_counters[]

CountersByClass

Object-related statistics by storage class and type of upload (simple vs. multipart), in bytes.

default_storage_class

google.protobuf.StringValue

Default storage class for objects in the bucket. Supported classes are standard storage (STANDARD), cold storage
(COLD, STANDARD_IA, NEARLINE all synonyms), and ice storage (ICE and GLACIER are synonyms).
For details, see documentation.

anonymous_access_flags

AnonymousAccessFlags

Flags for configuring public (anonymous) access to the bucket's content and settings.
For details, see documentation.

created_at

google.protobuf.Timestamp

Bucket creation timestamp.

updated_at

google.protobuf.Timestamp

Bucket latest update timestamp.

OptionalSizeByClass

A resource for size of available space in a bucket for a storage class.

Field

Description

storage_class

string

Storage class. Supported classes are standard storage (STANDARD), cold storage (COLD, STANDARD_IA, NEARLINE
all synonyms), and ice storage (ICE and GLACIER are synonyms).
For details, see documentation.

class_size

google.protobuf.Int64Value

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

storage_class

string

Storage class. Supported classes are standard storage (STANDARD), cold storage (COLD, STANDARD_IA, NEARLINE
all synonyms), and ice storage (ICE and GLACIER are synonyms).
For details, see documentation.

class_size

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

storage_class

string

Storage class. Supported classes are standard storage (STANDARD), cold storage (COLD, STANDARD_IA, NEARLINE
all synonyms), and ice storage (ice and GLACIER are synonyms).
For details, see documentation.

counters

Counters

Object-related statistics for the storage class by type of upload.

Counters

Field

Description

simple_object_size

int64

Total size of objects uploaded in single operation, in bytes.

simple_object_count

int64

Number of objects uploaded in single operation.

objects_parts_size

int64

Total size of uploaded parts in incomplete multipart uploads, in bytes.

objects_parts_count

int64

Number of uploaded parts in incomplete multipart uploads.

multipart_objects_size

int64

Total size of objects uploaded in multiple parts, in bytes.

multipart_objects_count

int64

Number of objects uploaded in multiple parts.

active_multipart_count

int64

Number of incomplete multipart uploads.

AnonymousAccessFlags

Field

Description

read

google.protobuf.BoolValue

Specifies whether public (anonymous) access to read objects in the bucket is enabled.

list

google.protobuf.BoolValue

Specifies whether public (anonymous) access to the list of objects in the bucket is enabled.

config_read

google.protobuf.BoolValue

Specifies whether public (anonymous) access to read CORS,
static website hosting, and
object lifecycles settings of the bucket is enabled.

Was the article helpful?

Previous
Delete
Next
GetHTTPSConfig
© 2025 Direct Cursus Technology L.L.C.