Object Storage API, gRPC: BucketService.Create

Статья создана

Yandex Cloud

Обновлена 1 июля 2026 г.

Открыть в Markdown

gRPC request
CreateBucketRequest
AnonymousAccessFlags
ACL
Grant
Tag
Encryption
EncryptionRule
BucketAllowedPrivateEndpoints
LifecycleRule
RuleFilter
And
Expiration
Transition
AfterDays
NoncurrentExpiration
NoncurrentTransition
NoncurrentDeleteMarkers
operation.Operation

Creates a bucket in the specified folder.

gRPC request

rpc Create (CreateBucketRequest) returns (operation.Operation)

CreateBucketRequest

{
  "name": "string",
  "folder_id": "string",
  "default_storage_class": "string",
  "max_size": "int64",
  "anonymous_access_flags": {
    "read": "google.protobuf.BoolValue",
    "list": "google.protobuf.BoolValue",
    "config_read": "google.protobuf.BoolValue"
  },
  "acl": {
    "grants": [
      {
        "permission": "Permission",
        "grant_type": "GrantType",
        "grantee_id": "string"
      }
    ]
  },
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "encryption": {
    "rules": [
      {
        "kms_master_key_id": "string",
        "sse_algorithm": "string"
      }
    ]
  },
  "versioning": "Versioning",
  "allowed_private_endpoints": {
    "enabled": "bool",
    "private_endpoints": [
      "string"
    ],
    "force_cloud_console_access": "bool"
  },
  "disabled_statickey_auth": "bool",
  "lifecycle_rules": [
    {
      "id": "google.protobuf.StringValue",
      "enabled": "bool",
      "filter": {
        "prefix": "string",
        "object_size_greater_than": "google.protobuf.Int64Value",
        "object_size_less_than": "google.protobuf.Int64Value",
        "tag": {
          "key": "string",
          "value": "string"
        },
        "and_operator": {
          "prefix": "string",
          "object_size_greater_than": "google.protobuf.Int64Value",
          "object_size_less_than": "google.protobuf.Int64Value",
          "tag": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        }
      },
      "expiration": {
        "date": "google.protobuf.Timestamp",
        "days": "google.protobuf.Int64Value",
        "expired_object_delete_marker": "google.protobuf.BoolValue"
      },
      "transitions": [
        {
          "date": "google.protobuf.Timestamp",
          "days": "google.protobuf.Int64Value",
          "storage_class": "string"
        }
      ],
      "abort_incomplete_multipart_upload": {
        "days_after_expiration": "google.protobuf.Int64Value"
      },
      "noncurrent_expiration": {
        "noncurrent_days": "google.protobuf.Int64Value",
        "newer_noncurrent_versions": "google.protobuf.Int64Value"
      },
      "noncurrent_transitions": [
        {
          "noncurrent_days": "google.protobuf.Int64Value",
          "storage_class": "string",
          "newer_noncurrent_versions": "google.protobuf.Int64Value"
        }
      ],
      "noncurrent_delete_markers": {
        "noncurrent_days": "google.protobuf.Int64Value"
      }
    }
  ]
}

Field	Description
name	string Required field. Name of the bucket. The name must be unique within the platform. For naming limitations and rules, see documentation.
folder_id	string Required field. ID of the folder to create a bucket in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
default_storage_class	string 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.
max_size	int64 Maximum size of the bucket. 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.
acl	ACL Access control list (ACL) of the bucket. For details, see documentation.
tags[]	Tag List of tags for the bucket. For details, see documentation.
encryption	Encryption Configuration for bucket's encryption. For details, see documentation.
versioning	enum Versioning Bucket versioning status. For details, see documentation. `VERSIONING_DISABLED`: The bucket is unversioned, i.e. versioning has never been enabled for the bucket, including at its creation. Objects that are stored in the bucket have a version ID of `null`. To enable versioning, change status to `VERSIONING_ENABLED` via a BucketService.Update request. Note that this action is irreversible, and a bucket with versioning enabled can never return to `VERSIONING_DISABLED` state. `VERSIONING_ENABLED`: Bucket versioning is enabled, i.e. all new objects are versioned and given a unique version ID, and objects that already existed at the time versioning was enabled will be versioned and given a unique version ID when modified by future requests. To suspend versioning, change status to `VERSIONING_SUSPENDED` via a BucketService.Update request. You cannot disable versioning altogether for a bucket that already had it enabled; objects that had version IDs will keep them. `VERSIONING_SUSPENDED`: Bucket versioning is suspended, i.e. new objects are not versioned, but objects that already existed at the time versioning was suspended are still versioned and keep their version IDs. To resume versioning, change status to `VERSIONING_ENABLED` via a BucketService.Update request.
allowed_private_endpoints	BucketAllowedPrivateEndpoints Configuration for bucket's allowed private endpoints. requires permission s3:PutBucketAllowedPrivateEndpoints
disabled_statickey_auth	bool An option to disable static key auth for a bucket. requires permission s3:UpdateBucketStaticKeyAuthSettings
lifecycle_rules[]	LifecycleRule Configuration for bucket's lifecycle rules. requires permission s3:PutLifecycleConfiguration

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.

ACL

Field

Description

grants[]

Grant

List of permissions granted and the grantees.

Grant

A grant resource, used to specify the permission granted and the grantee.

Field	Description
permission	enum Permission Required field. Permission granted by the grant. `PERMISSION_FULL_CONTROL`: Allows grantee the `PERMISSION_WRITE`, `PERMISSION_WRITE_ACP`, `PERMISSION_READ`, and `PERMISSION_READ_ACP` on the bucket. Maps to `x-amz-grant-full-control` header for bucketPutAcl method of Amazon S3-compatible HTTP API. `PERMISSION_WRITE`: Allows grantee to create new objects in the bucket. For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects. Maps to `x-amz-grant-write` header for bucketPutAcl method of Amazon S3-compatible HTTP API. `PERMISSION_WRITE_ACP`: Allows grantee to write the ACL for the bucket. Maps to `x-amz-grant-write-acp` header for bucketPutAcl method of Amazon S3-compatible HTTP API. `PERMISSION_READ`: Allows grantee to list the objects in the bucket. Maps to `x-amz-grant-read` header for bucketPutAcl method of Amazon S3-compatible HTTP API. `PERMISSION_READ_ACP`: Allows grantee to read the bucket ACL Maps to `x-amz-grant-read-acp` header for bucketPutAcl method of Amazon S3-compatible HTTP API.
grant_type	enum GrantType Required field. The grantee type for the grant. `GRANT_TYPE_ACCOUNT`: A grantee is an account on the platform. For this grantee type, you need to specify the user ID in `Bucket.acl.grants.grantee_id` field. To get user ID, see instruction. Maps to using `id=""` value for `x-amz-grant-` header (bucketPutAcl method of Amazon S3-compatible HTTP API). `GRANT_TYPE_ALL_AUTHENTICATED_USERS`: Grantees are all authenticated users, both from your clouds and other users' clouds. Access permission to this group allows any account on the platform to access the resource via a signed (authenticated) request. Maps to using `uri="http://acs.amazonaws.com/groups/global/AuthenticatedUsers"` value for `x-amz-grant-` header (bucketPutAcl method of Amazon S3-compatible HTTP API). `GRANT_TYPE_ALL_USERS`: Grantees are all internet users. Access permission to this group allows anyone in the world access to the resource via signed (authenticated) or unsigned (anonymous) requests. Maps to using `uri="http://acs.amazonaws.com/groups/global/AllUsers"` value for `x-amz-grant-` header (bucketPutAcl method of Amazon S3-compatible HTTP API).
grantee_id	string ID of the account who is a grantee. Required when the `grant_type` is `GRANT_TYPE_ACCOUNT`. The maximum string length in characters is 100.

Tag

Field

Description

key

string

Key of the bucket tag.

value

string

Value of the bucket tag.

Encryption

Field

Description

rules[]

EncryptionRule

Rules

EncryptionRule

Field

Description

kms_master_key_id

string

KMS master key ID

sse_algorithm

string

SSE algorithm

BucketAllowedPrivateEndpoints

Field	Description
enabled	bool if true, private endpoints white list check is enabled even if private_endpoints list is empty
private_endpoints[]	string white list of private endpoints bucket accessible from
force_cloud_console_access	bool if true, cloud console will be able to access a bucket regardless of private_endpoints list

LifecycleRule

An object lifecycle rule resource for the bucket.
For details about the concept, see documentation.

Field	Description
id	google.protobuf.StringValue ID of the rule. Provided by the client or generated at creation time.
enabled	bool Indicates whether the rule is in effect.
filter	RuleFilter Filter that identifies the objects to which the rule applies. If not specified, the rule applies to all objects in the bucket.
expiration	Expiration Expiration rule. The expiration of an object is described as follows. For the unversioned bucket (Bucket.versioning is `VERSIONING_DISABLED`), the object is deleted and cannot be recovered. For the bucket with versioning enabled (Bucket.versioning is `VERSIONING_ENABLED`), the current version of the object (if it exists and is not a delete marker) is retained as a non-current version, and a delete marker becomes the current version of the object. For the bucket with versioning suspended (Bucket.versioning is `VERSIONING_SUSPENDED`), the current version of the object is retained as a non-current version if it is not a delete marker, or is removed otherwise, and a delete marker becomes the current version of the object.
transitions[]	Transition List of transition rules. The transition of an object is described as follows. For the unversioned bucket (Bucket.versioning is `VERSIONING_DISABLED`), the object is transitioned to the specified storage class. For the bucket with versioning enabled (Bucket.versioning is `VERSIONING_ENABLED`) or suspended (`VERSIONING_SUSPENDED`), the current version of the object is transitioned to the specified storage class.
abort_incomplete_multipart_upload	AfterDays Configuration for aborting incomplete multipart uploads.
noncurrent_expiration	NoncurrentExpiration Expiration rule for non-current versions of objects in a bucket with versioning enabled (Bucket.versioning is `VERSIONING_ENABLED`) or suspended (`VERSIONING_SUSPENDED`). At expiration, the non-current version of the object is deleted and cannot be recovered.
noncurrent_transitions[]	NoncurrentTransition List of transition rules for non-current versions of objects in a bucket with versioning enabled (Bucket.versioning is `VERSIONING_ENABLED`) or suspended (`VERSIONING_SUSPENDED`). At transition, the non-current version of the object is transitioned to the specified storage class.
noncurrent_delete_markers	NoncurrentDeleteMarkers Expiration rule for non-current delete markers of an objects in a bucket with versioning enabled (Bucket.versioning is `VERSIONING_ENABLED`) or suspended (`VERSIONING_SUSPENDED`). Works in the same way as noncurrent_expiration rule, but only for delete markers. At expiration, the non-current delete marker of the object is deleted and cannot be recovered.

RuleFilter

Field	Description
prefix	string Key prefix that the object must have in order for the rule to apply.
object_size_greater_than	google.protobuf.Int64Value Size that the object must be greater.
object_size_less_than	google.protobuf.Int64Value Size that the object must be less t.
tag	Tag Tags that the object's tag set must have for the rule to apply.
and_operator	And Apply a logical AND to all of the predicates configured inside the And operator.

And

Field	Description
prefix	string Key prefix that the object must have in order for the rule to apply.
object_size_greater_than	google.protobuf.Int64Value Size that the object must be greater.
object_size_less_than	google.protobuf.Int64Value Size that the object must be less than.
tag[]	Tag Tags that the object's tag set must have for the rule to apply.

Expiration

Field	Description
date	google.protobuf.Timestamp Specific date of object expiration. The rule continues to apply even after the date has passed, i.e. any new objects created in the bucket expire immediately. Exactly one of `date`, `days`, and `expired_object_delete_marker` fields can be specified.
days	google.protobuf.Int64Value Time period, in number of days from the creation or modification of the object, after which an object expires. Exactly one of `days`, `date`, and `expired_object_delete_marker` fields can be specified.
expired_object_delete_marker	google.protobuf.BoolValue Indicates whether a delete marker of an object with no non-current versions (referred to as an expired object delete marker) is removed at the object's expiration. Exactly one of `expired_object_delete_marker`, `date`, and `days` fields can be specified.

List of transition rules.
The transition of an object is described as follows.
For the unversioned bucket (Bucket.versioning is VERSIONING_DISABLED), the object is transitioned to the
specified storage class.
For the bucket with versioning enabled (Bucket.versioning is VERSIONING_ENABLED) or suspended
(VERSIONING_SUSPENDED), the current version of the object is transitioned to the specified storage class.

Field	Description
date	google.protobuf.Timestamp Specific date of object transition. The rule continues to apply even after the date has passed, i.e. any new objects created in the bucket are transitioned immediately. At most one of `date` and `days` fields can be specified.
days	google.protobuf.Int64Value Time period, in number of days from the creation or modification of the object, after which an object is transitioned. At most one of `days` and `date` fields can be specified.
storage_class	string Required field. Storage class to which an object is transitioned from standard storage. The only supported class is cold storage (`COLD`, `STANDARD_IA`, `NEARLINE` all synonyms). Transitions from cold to standard storage and transitions to or from ice storage are not allowed.

AfterDays

Field

Description

days_after_expiration

google.protobuf.Int64Value

Time period, in number of days from the start of the multipart upload, after which the incomplete upload is
aborted.

NoncurrentExpiration

Field

Description

noncurrent_days

google.protobuf.Int64Value

Time period, in number of days since the version of an object was classified as non-current, after which the
version expires.

newer_noncurrent_versions

google.protobuf.Int64Value

Specifies how many noncurrent versions S3 will retain.
S3 will permanently delete any additional noncurrent versions beyond this specified number.

NoncurrentTransition

List of transition rules for non-current versions of objects in a bucket with versioning enabled
(Bucket.versioning is VERSIONING_ENABLED) or suspended (VERSIONING_SUSPENDED).
At transition, the non-current version of the object is transitioned to the specified storage class.

Field	Description
noncurrent_days	google.protobuf.Int64Value Time period, in number of days since the version of an object was classified as non-current, after which the version is transitioned.
storage_class	string Required field. Storage class to which a non-current version of an object is transitioned from standard storage. The only supported class is cold storage (`COLD`, `STANDARD_IA`, `NEARLINE` all synonyms). Transitions from cold to standard storage and transitions to or from ice storage are not allowed.
newer_noncurrent_versions	google.protobuf.Int64Value Specifies how many noncurrent versions S3 will retain. S3 will permanently delete any additional noncurrent versions beyond this specified number.

NoncurrentDeleteMarkers

Field

Description

noncurrent_days

google.protobuf.Int64Value

Time period, in number of days since the version of a delete marker was classified as non-current, after which
the delete marker expires.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Object Storage API, gRPC: BucketService.Create

gRPC requestgRPC request

CreateBucketRequestCreateBucketRequest

AnonymousAccessFlagsAnonymousAccessFlags

ACLACL

GrantGrant

TagTag

EncryptionEncryption

EncryptionRuleEncryptionRule

BucketAllowedPrivateEndpointsBucketAllowedPrivateEndpoints

LifecycleRuleLifecycleRule

RuleFilterRuleFilter

AndAnd

ExpirationExpiration

TransitionTransition

AfterDaysAfterDays

NoncurrentExpirationNoncurrentExpiration

NoncurrentTransitionNoncurrentTransition

NoncurrentDeleteMarkersNoncurrentDeleteMarkers

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

CreateBucketRequest

AnonymousAccessFlags

ACL

Grant

Tag

Encryption

EncryptionRule

BucketAllowedPrivateEndpoints

LifecycleRule

RuleFilter

And

Expiration

Transition

AfterDays

NoncurrentExpiration

NoncurrentTransition

NoncurrentDeleteMarkers

operation.Operation