Yandex Cloud
Search
Discuss with expertTry it for free
  • Customer Stories
  • Documentation
  • Blog
  • All Services
    • Cloud Interconnect
    • Cloud Backup
    • Cloud Registry
    • Yandex AI Studio
    • Compute Cloud
    • Object Storage
    • Managed Service for Kubernetes®
    • Yandex BareMetal
    • Smart Web Security
    • Security Deck
    • Managed Service for PostgreSQL
    • Managed Service for ClickHouse®
    • Monium
    • Cloud CDN
    • Network Load Balancer
    • Virtual Private Cloud
    • Cloud DNS
    • Application Load Balancer
    • Yandex Cloud Video
    • Stackland
    • Yandex Cloud Router
    • Yandex Managed Service for Trino
    • Managed Service for MySQL®
    • Managed Service for Valkey™
    • Managed Service for Apache Spark™
    • Yandex StoreDoc
    • Managed Service for OpenSearch
    • Managed Service for Apache Kafka®
    • Data Transfer
    • Yandex MPP Analytics Engine for PostgreSQL
    • Yandex Managed Service for Apache Airflow®
    • Data Processing
    • Yandex MetaData Hub
    • Managed Service for YDB
    • Managed Service for Sharded PostgreSQL
    • Managed Service for YTsaurus
    • Yandex WebSQL
    • DataLens
    • Yandex Search API
    • SpeechSense
    • SpeechKit
    • DataSphere
    • Vision OCR
    • Translate
    • Yandex Identity Hub
    • Key Management Service
    • Certificate Manager
    • Yandex Lockbox
    • Audit Trails
    • SmartCaptcha
    • Cloud Desktop
    • SourceCraft Code Assistant
    • Container Registry
    • Managed Service for GitLab
    • Managed Service for Prometheus®
    • Cloud Functions
    • API Gateway
    • Yandex Cloud Postbox
    • Message Queue
    • Serverless Integrations
    • IoT Core
    • Data Streams
    • Serverless Containers
    • Cloud Notification Service
    • Yandex Query
    • Identity and Access Management
    • Yandex Cloud Console
    • Resource Manager
    • Yandex Cloud Billing
    • Yandex Cloud Quota Manager
    • Cloud Apps
  • System Status
  • Marketplace
    • Featured
    • Infrastructure & Network
    • Data Platform
    • AI for business
    • Security
    • DevOps tools
    • Serverless
    • Monitoring & Resources
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
    • Price calculator
    • Pricing plans
  • Customer Stories
  • Documentation
  • Blog
© 2026 Direct Cursus Technology L.L.C.
Yandex Object Storage
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • List
        • Get
        • Create
        • Update
        • Delete
        • GetStats
        • GetHTTPSConfig
        • SetHTTPSConfig
        • DeleteHTTPSConfig
        • SetAccessBindings
        • UpdateAccessBindings
        • ListAccessBindings
        • CreateInventoryConfiguration
        • GetInventoryConfiguration
        • DeleteInventoryConfiguration
        • ListInventoryConfigurations
  • 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. Yandex Cloud gRPC
  3. Bucket
  4. GetStats

Object Storage API, gRPC: BucketService.GetStats

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

Returns the statistics for the specified bucket.

gRPC requestgRPC request

rpc GetStats (GetBucketStatsRequest) returns (BucketStats)

GetBucketStatsRequestGetBucketStatsRequest

{
  "name": "string"
}

Field

Description

name

string

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

BucketStatsBucketStats

{
  "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.

OptionalSizeByClassOptionalSizeByClass

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.

SizeByClassSizeByClass

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.

CountersByClassCountersByClass

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.

CountersCounters

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.

AnonymousAccessFlagsAnonymousAccessFlags

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
© 2026 Direct Cursus Technology L.L.C.