PutBucket

API

Action

Description

PutBucket

oss:PutBucket

Creates a bucket.

oss:PutBucketAcl

After creating a bucket, this permission is required to modify the bucket ACL.

Name

Type

Required

Example

Description

bucket

String

Yes

examplebucket

The name of the bucket. The naming conventions for a bucket are as follows:

• The name can contain only lowercase letters, digits, and hyphens (-).

• The name must start and end with a lowercase letter or a digit.

• The name must be 3 to 63 characters in length.

x-oss-acl

String

No

private

The access control list (ACL) of the bucket. Valid values:

• public-read-write: Grants public read and write permissions.

• public-read: Public Read

• private (default)

For more information about bucket ACLs, see Set bucket ACLs.

x-oss-resource-group-id

String

No

rg-aek27tc****

The ID of the resource group.

• If you include this header in the request and specify a resource group ID, the created bucket belongs to the specified resource group.

  If you set the resource group ID to rg-default-id, the created bucket belongs to the default resource group.

• If you do not include this header in the request, the created bucket belongs to the default resource group.

You can obtain the resource group ID on the Resource Management console or by calling the ListResourceGroups operation. For more information, see View resource groups and ListResourceGroups.

x-oss-bucket-tagging

String

No

k1=v1&k2=v2

Specifies the bucket tags.

x-oss-server-side-encryption

String

No

AES256

Sets the default server-side encryption method.

Valid values: KMS, AES256, and SM4

Using the KMS feature incurs a small fee for KMS API calls. For more information about the pricing, see KMS pricing.

During cross-region replication, if the destination bucket has default server-side encryption enabled and the replication rule is configured with a ReplicaCMKID, the following situations apply:

• If an object in the source bucket is not encrypted, the object is encrypted using the default encryption method of the destination bucket after it is replicated.

• If an object in the source bucket is encrypted using SSE-KMS or SSE-OSS, the object retains its original encryption method in the destination bucket.

For more information, see Cross-region replication with server-side encryption.

x-oss-server-side-data-encryption

String

No

SM4

Specifies the encryption algorithm for the object. If you do not specify this header, the AES256 encryption algorithm is used. This header is valid only when x-oss-server-side-encryption is set to KMS.

Valid value: SM4

If you use OSS on CloudBox, this parameter is not supported.

x-oss-server-side-encryption-key-id

String

No

9468da86-3509-4f8d-a61e-6eab1eac****

The ID of the KMS key. This header is required only when x-oss-server-side-encryption is set to KMS. In other cases, this header must be empty.

If you use OSS on CloudBox, this parameter is not supported.

Name

Type

Required

Example

Description

StorageClass

String

No

Standard

The storage class of the bucket. Valid values:

• Standard (default)

  Note

  • When you create an Anywhere Bucket, only the Standard storage class is supported.

  • In OSS ON CloudBox scenarios, only the Standard storage class is supported.

• IA: Infrequent Access

• Archive: Archive Storage

• ColdArchive: Cold Archive

• DeepColdArchive: Deep Cold Archive

Parent node: CreateBucketConfiguration

Child nodes: None

DataRedundancyType

String

No

LRS

The data redundancy type of the bucket. Valid values:

• LRS (default)

  Locally redundant storage (LRS) stores copies of your data on different storage devices in the same zone. This ensures data durability and availability even if two storage devices are damaged at the same time.

  Note

  When you create an Anywhere Bucket, only the LRS type is supported.

• ZRS

  Zone-redundant storage (ZRS) uses a data redundancy mechanism within multiple zones. ZRS stores the data of an object across multiple zones in the same region. If a zone becomes unavailable, you can still access the data.

Parent node: CreateBucketConfiguration

Child nodes: None

Name

Type

Example

Description

Location

String

/oss-example

The address of the bucket. The value is a forward slash (/) followed by the bucket name.

Default value: None

Error code

HTTP status code

Description

InvalidBucketName

400

The bucket name does not comply with the naming conventions.

AccessDenied

403

The following are possible causes of the error:

• User authentication information is not included in the PutBucket request.

• You do not have the required permissions.

TooManyBuckets

400

The number of created buckets exceeds the upper limit. An Alibaba Cloud account can create a maximum of 100 buckets in the same region.

BucketAlreadyExists

409

• If a bucket has been deleted, the time requirement for creating a bucket with the same name is not met.

  You attempt to create a bucket with a name that was used by a bucket that was recently deleted. After a bucket is deleted, you must wait for several hours (typically 4 to 8 hours) before you can create a bucket with the same name.

• You call the PutBucket operation using methods such as a RAM user or STS to create a bucket with the same name as an existing bucket.

  Only the original Alibaba Cloud account can re-create a bucket with the same name.

• You do not have the permissions to call the PutBucketAcl operation. Make sure that the caller is granted the oss:PutBucketAcl permission using a bucket policy or a RAM policy.