Help Center/ Object Storage Service/ Tools Guide/ obsutil/ Bucket Commands/ Setting Bucket Properties
Updated on 2026-07-29 GMT+08:00
View PDF
Share

Setting Bucket Properties

Function

You can use this command to set the properties of a bucket, such as storage classes and access policies.

Command Line Structure

  • Windows 
    obsutil chattri obs://bucket [-sc=xxx] [-acl=xxx] [-aclXml=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
  • macOS or Linux 
    ./obsutil chattri obs://bucket [-sc=xxx] [-acl=xxx] [-aclXml=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Examples

  • In Windows, run obsutil chattri obs://bucket-test -acl=private to change the bucket ACL to private read/write. 
    obsutil chattri obs://bucket-test -acl=private

Start at 2024-09-29 07:58:46.0506904 +0000 UTC

Set the acl of bucket [bucket-test] to [private] successfully, request id [04050000016836C5DA6FB21F14A2A0C0]

Parameter Description

Parameter

Optional or Mandatory

Description

bucket

Mandatory

The bucket name

sc

Optional (additional parameter)

The default storage class of the bucket. The value can be:

  • standard: Standard storage class. It features low access latency and high throughput, and is suitable for storing frequently accessed data (multiple accesses per month) or data that is smaller than 1 MB.
  • warm: Infrequent Access storage class. It is ideal for storing infrequently accessed data (less than 12 times a year), but when needed, the access has to be fast.
  • cold: Archive storage class. It provides secure, durable, and inexpensive storage for rarely-accessed data (once a year).
NOTE:

If the multi-AZ mode is enabled for a bucket, the default storage class of the bucket cannot be set to cold.

acl

Optional (additional parameter)

The predefined access control policy of the bucket. The value can be:

  • private
  • public-read
  • public-read-write
NOTE:

The preceding three values indicate private read and write, public read, and public read and write.

aclXml

Optional (additional parameter)

The bucket's access control policy, in XML format

<AccessControlPolicy>
    <Owner>
        <ID>ownerid</ID>
    </Owner>
    <AccessControlList>
        <Grant>
            <Grantee>
                <ID>userid</ID>
            </Grantee>
            <Permission>[WRITE|WRITE_ACP|READ|READ_ACP|FULL_CONTROL]</Permission>
        </Grant>
        <Grant>
            <Grantee>
                <Canned>Everyone</Canned>
            </Grantee>
            <Permission>[WRITE|WRITE_ACP|READ|READ_ACP|FULL_CONTROL]</Permission>
        </Grant>
    </AccessControlList>
</AccessControlPolicy>
NOTE:
  • Owner: Optional. Specify the bucket owner's ID.
  • In AccessControlList, the Grant field contains the authorized users. Grantee specifies the IDs of authorized users. Canned specifies the authorized user group (currently, only Everyone is supported).
  • The following permissions can be granted: WRITE (write), WRITE_ACP (write ACL), READ (read), READ_ACP (read ACL), and FULL_CONTROL (full control).
NOTICE:

Because angle brackets (<) and (>) are unavoidably included in the parameter value, you must use quotation marks to enclose them for escaping when running the command. Use single quotation marks for Linux or macOS and double quotation marks for Windows.

bucket-cname

Optional (additional parameter)

The user-defined domain name bound to the bucket

NOTE:

This parameter is only supported by obsutil 5.7.9 and later.

config

Optional (additional parameter)

The user-defined configuration file for executing the current command. For details about parameters that can be configured, see Configuration Parameters.

e

Optional (additional parameter)

The endpoint

i

Optional (additional parameter)

The user's AK

k

Optional (additional parameter)

The user's SK

t

Optional (additional parameter)

The user's security token

Only one from sc, acl, or aclXml can be set for each command.

Parent topic: Bucket Commands