Configuring a Storage Class_Object Storage Service

Scenarios

This section describes how to configure storage classes for buckets or objects when creating buckets or uploading objects. If you want to change the storage class of a bucket or object, see Changing the Storage Classes of Buckets and Objects.

Bucket and Object Storage Classes

When creating a bucket, you can specify a storage class for it. You can also change the storage class after the bucket has been created.

You can specify a storage class for an object when uploading it, or you can change the object storage class after the object has been uploaded.

Changing the storage class of a bucket does not change the storage class of existing objects in the bucket. However, any new objects uploaded to the bucket will inherit the bucket's new storage class.

Configuring a Storage Class During Bucket Creation

You can use OBS Console, APIs, SDKs, OBS Browser+, or obsutil to configure storage classes for buckets during creation.

Using OBS Console

In the navigation pane of OBS Console, choose Object Storage.
In the upper right corner, click Create Bucket. The Create Bucket page is displayed.

Figure 1 Creating a bucket

Configure bucket parameters.

**Table 1** Bucket parameters
Parameter	Description
Replicate Existing Settings	Optional. To use this function, click Select Bucket and select a bucket from the list as the replication source. After the replication source is selected, the following settings are replicated to the bucket you are creating: region, data redundancy policy, storage class, bucket policy, server-side encryption, direct reading, enterprise project, and tags. You can still change some or all of the replicated settings as needed.
Region	Geographic area where a bucket resides. For low latency and fast access, select the region nearest to you. Once the bucket is created, its region cannot be changed. Most OBS features are available in all regions, but some are only available for certain regions. Consider the feature availability in each region when you select a region for a bucket. For details, see Function Overview. If your ECS needs to access an OBS bucket over an intranet, ensure that the bucket and the ECS are in the same region. For details, see Accessing OBS over an Intranet.
Bucket Name	Name of the bucket. A bucket name must be unique across all accounts and regions. Once a bucket is created, its name cannot be changed. According to the globally applied DNS naming rules, an OBS bucket name: Must be unique across all accounts and regions. The name of a deleted bucket can be reused for another bucket or a parallel file system at least 30 minutes after the deletion. Must be 3 to 63 characters long. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot start or end with a period (.) or hyphen (-), and cannot contain two consecutive periods (..) or contain a period (.) and a hyphen (-) adjacent to each other. Cannot be formatted as an IP address. NOTE: When you access OBS through HTTPS using virtual hosted-style URLs, if the bucket name contains a period (.), the certificate verification will fail. To work around this issue, you are advised not to use periods (.) in bucket names.
Data Redundancy Policy	Multi-AZ storage: Data is stored in multiple AZs to achieve higher reliability. Single-AZ storage: Data is stored in a single AZ, with lower costs. For details about the performance comparison between multi-AZ and single-AZ storage, see Comparison of Storage Classes. Once a bucket is created, the data redundancy policy cannot be changed, so choose the policy that can meet your needs. Multi-AZ storage is not available for buckets in the Archive storage class. Multi-AZ storage is not available for buckets in the Deep Archive storage class.
Default Storage Class	The storage class of a bucket. Different storage classes meet different requirements for storage performance and costs. The Standard storage class is for storing a large number of hot files or small files that are frequently accessed (multiple times per month on average) and require quick retrieval. The Infrequent Access storage class is for storing data that is less frequently accessed (less than 12 times per year on average) but requires quick retrieval. The Archive storage class is for archiving data that is rarely accessed (once a year on average) and has less demanding requirements for quick retrieval. The Deep Archive storage class is for storing data that is rarely accessed (a lower frequency than the archived data) and has less demanding requirements for quick retrieval. For details, see Storage Classes.
Bucket Policy	Controls read and write permissions for buckets. Private: Only users granted permissions by the bucket ACL can access the bucket. Public Read: Anyone can read objects in the bucket. Public Read and Write: Anyone can read, write, or delete objects in the bucket.
Server-Side Encryption	Choose SSE-KMS. For the encryption key type, you can choose Default or Custom. If Default is used, the default key of the current region will be used to encrypt your objects. If there is no such a default key, OBS creates one the first time you upload an object. If Custom is used, you can choose a custom key you created on the KMS console to encrypt your objects. If SSE-OBS is chosen, the keys created and managed by OBS are used for encryption. After you enable server-side encryption for the bucket, any object you upload to it will inherit encryption from the bucket by default. You can also configure new encryption with SSE-KMS or SSE-OBS for the object.
WORM	When you enable write-once-read-many (WORM), you can configure a retention policy for the current bucket. The object version which the retention policy is applied to cannot be deleted within a specified period. You can only enable WORM when you create a bucket. Once enabled for a bucket, WORM cannot be disabled. When you enable WORM, OBS automatically enables versioning for the bucket, and versioning cannot be suspended later for that bucket.
Direct Reading	Direct reading allows you to directly download objects from the Archive storage class without restoring them first. Direct reading is a billable function. For details, see Product Pricing Details. No matter which default storage class you select, you can enable direct reading for your bucket. For example, if you select the Standard storage class and enable direct reading for your bucket, you can directly download objects stored in the Archive storage class from your bucket.
Enterprise Project	You can add a bucket to an enterprise project for unified management. Create an enterprise project by referring to Creating an Enterprise Project. The default enterprise project is named default. On the Enterprise Project Management page, create an enterprise project, and add a user group to the enterprise project. By doing so, users in this user group obtain the operation permissions for the buckets and objects in the enterprise project. NOTE: Only an enterprise account can configure enterprise projects. OBS ReadOnlyAccess and OBS OperateAccess are the fine-grained authorizations of the enterprise project user group in OBS.
Tags	Optional. Tags are used to identify and classify buckets in OBS. Each tag is represented by a key-value pair. For more information, see Tags.

Click Create Now.

Using the API

Specifying a Storage Class During Bucket Creation (adding the x-obs-storage-class header)

Using SDKs

Using the GUI Tool - OBS Browser+

Log in to OBS Browser+.
In the upper part of the page, click Create Bucket.

In the displayed dialog box, configure bucket parameters, as shown in Figure 2.

Figure 2 Creating buckets

**Table 2** Creating buckets
Parameter	Description
Region	Enter the region where you want to create a bucket. Once the bucket is created, its region cannot be changed.
Storage Class	The storage class of a bucket. Different storage classes meet customers' needs for storage performance and costs. The Standard storage class is for storing a large number of hot files or small files that are frequently accessed (multiple times per month on average) and require quick retrieval. The Infrequent Access storage class is for storing data that is less frequently accessed (less than 12 times per year on average) but requires quick retrieval. The Archive storage class is for archiving data that is rarely accessed (once a year on average) and has less demanding requirements for quick retrieval. For details, see Storage Classes.
Bucket ACL	Controls read and write permissions for buckets. Private: Only users granted permissions by the bucket ACL can access the bucket. Public Read: Anyone can read objects in the bucket. Public Read and Write: Anyone can read, write, or delete objects in the bucket.
Multi-AZ Mode	If multi-AZ storage is enabled, data will be stored in multiple AZs. Once a bucket is created, its multi-AZ status cannot be changed. So, plan in advance and determine whether to enable the multi-AZ function during bucket creation.
Bucket Name	Name of the bucket you want to create, which must be globally unique. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.

You can click next to the bucket name to learn about the bucket naming rules. A user can create a maximum of 100 buckets in OBS.

NOTE:

When a URL is used to access a bucket, the bucket name will become a part of the URL. According to the DNS rule, URLs do not support uppercase letters and cannot be used to access a bucket whose name contains uppercase letters. Therefore, a bucket name can contain only lowercase letters, digits, hyphens (-), and periods (.) For example, if you attempt to access bucket MyBucket using a URL, MyBucket will be parsed as mybucket. This results in an access error.
DNS naming rules standardize bucket names globally, facilitating the resolution during bucket access. With the DNS naming rules used, you can benefit from new functions and optimized features, and configure static website hosting for buckets.
Once you have created a bucket, you cannot change the name of it. Make sure that the bucket name you set is appropriate.

Click OK. If the bucket is successfully created, it is displayed in the bucket list. If the creation fails, an error message will be displayed.

Using the CLI Tool - obsutil

Command Line Structure

Windows:

obsutil mb obs://bucket [-fs] [-az=xxx] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Linux or macOS:

./obsutil mb obs://bucket [-fs] [-az=xxx] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Examples

Take the Windows OS as an example. Run the obsutil mb obs://bucket-test command to create a bucket. The example bucket was created.
```
obsutil mb obs://bucket-test

Create bucket [bucket-test] successfully, request id [0000016979E1D2EA860BB5E80A6B8FCC]
```

Take the Windows OS as an example. Run the obsutil mb obs://bucket001 command to create a namesake bucket. The example bucket failed to be created.

obsutil mb obs://bucket001

Create bucket [bucket001] failed, http status [409], error code [BucketAlreadyExists], error message [The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.], request id [04030000016757F31A0333281A6B1E92]

Parameter Description

Parameter	Optional or Mandatory	Description
bucket	Mandatory	Bucket name NOTE: A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
fs	Optional (additional parameter)	Creates a parallel file system.
az	Optional (additional parameter)	Specifies a bucket's data redundancy policy. Possible values are: multi-az NOTE: If multi-az is used, a bucket with the multi-AZ storage policy will be created. If this parameter is not specified, a bucket with the single-AZ storage policy will be created.
acl	Optional (additional parameter)	Access control policies that can be specified when creating a bucket. Possible values are: private public-read public-read-write NOTE: The three values above indicate, respectively, private read and write, public read, and public read and write.
sc	Optional (additional parameter)	Default bucket storage class that can be specified when creating a bucket. Possible values are: standard: Standard storage class. It features low access latency and high throughput, and is applicable to 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 (less than 12 times a year) data, but when needed, the access has to be fast. cold: Archive storage class. It provides secure, durable, and inexpensive storage for rarely-accessed (once a year) data. deep-archive: Deep Archive storage class (under a beta test). It is suitable for storing data that is barely (once every few years) accessed. This storage class costs less than the Archive storage class, but takes longer time (usually several hours) to restore data.
location	Mandatory unless the region where a bucket will be created is the default region (additional parameter)	Region where the bucket will be located NOTE: This parameter indicates the region where a bucket will be created. It is mandatory if the endpoint belongs to any region other than CN North-Beijing1 (cn-north-1). To view the currently valid regions, see Regions and Endpoints.
config	Optional (additional parameter)	User-defined configuration file for executing a command. For details about parameters that can be configured, see Parameter Description.
e	Optional (additional parameter)	Specifies the endpoint.
i	Optional (additional parameter)	Specifies the user's AK.
k	Optional (additional parameter)	Specifies the user's SK.
t	Optional (additional parameter)	Specifies the user's security token.

Configuring a Storage Class During Object Uploads

You can use OBS Console, APIs, SDKs, OBS Browser+, or obsutil to configure storage classes for objects during uploads.

Using OBS Console

In the navigation pane of OBS Console, choose Object Storage.
In the bucket list, click the bucket you want to operate. The Objects page is displayed.
Go to the folder where you want to upload files and click Upload Object. The Upload Object dialog box is displayed.

Batch upload is used as an example here. If the region you are using does not support batch upload, perform operations as instructed.

NOTE:

If the files that you want to upload to OBS are stored in Microsoft OneDrive, it is recommended that the names of these files contain a maximum of 32 characters to ensure compatibility.

Figure 3 Uploading objects
Select a storage class. If you do not specify a storage class, the objects you upload inherit the storage class of the bucket.

NOTE:

An object can have a different storage class from its bucket. You can specify a storage class for an object when uploading it, or you can change the object storage class after the object has been uploaded.
In the Upload Object area, drag and drop the files or folders you want to upload.

You can also click add files in the Upload Object area to select files.
Server-Side Encryption: Choose Disable, SSE-KMS, or SSE-OBS. For details, see Uploading a File with Server-Side Encryption.

NOTE:

If the bucket has server-side encryption configured, the object you upload will inherit encryption from the bucket by default.
(Optional) To configure metadata or WORM retention policies, click Next: (Optional) Configure Advanced Settings.

NOTE:

WORM retention policies can be configured in the advanced settings only when WORM is enabled for the bucket.

Configuring metadata: Add metadata ContentDisposition, ContentLanguage, WebsiteRedirectLocation, ContentEncoding, or ContentType as needed. For more information, see OBS Object Metadata. Metadata is a set of name-value pairs. The metadata value cannot be left blank. You can add two or more metadata entries by clicking Add.

Configuring WORM retention: Choose Inherit from bucket, or choose Configure and then specify a retention period, to automatically protect new objects uploaded to the bucket from being deleted.

Figure 4 Configuring metadata or WORM retention
Click Upload.

Using the API

Specifying a Storage Class During Object Uploads with PUT (adding the x-obs-storage-class header)

Specifying a Storage Class During Object Uploads with POST (adding the x-obs-storage-class header)

Initiating a Multipart Upload (adding the x-obs-storage-class header during the initiation process if a multipart upload is used)

Using SDKs

Uploading objects	Java	Python	C	Go	BrowserJS	.NET	Android	iOS	PHP	Node.js
Multipart upload	Java	Python	C	Go	BrowserJS	.NET	Android	iOS	PHP	Node.js

Using the GUI Tool - OBS Browser+

Log in to OBS Browser+.
Click the bucket where you want to upload files or folders.
Click Upload and then Add File or Folder, as shown in Figure 5.

Figure 5 Uploading a file or folder

For better experience when using the Add File function, you are advised to upload a maximum of 100 files at a time. If you need to upload more, place all the files in a folder and upload them by adding a folder.
NOTE:
1. If message "Service Unavailable" is displayed when files are being uploaded, try again later.
2. If an access deny message is displayed when you are uploading a file or folder, possible causes are as follows:
- Access to the bucket is restricted by an ACL. For example, you do not have the write permission for the bucket.
- Access to the bucket is restricted by a bucket policy. For example, you do not have the write permission for the bucket, or write operations cannot be performed on the bucket during the current period.
  If such message is displayed, check ACL and policy settings of the bucket and resolve the problem accordingly.
CAUTION:

You must have access to the file you want to upload, or the file upload will fail.
In the displayed dialog box, select the file or folder you want to upload and click Open.

You can upload one folder or multiple files at a time. To upload multiple files, hold down Ctrl or Shift to select multiple files and batch upload them. You can also press Ctrl+A to select all files. The operations are consistent with those in Windows operating systems.
Click OK.

Using the CLI Tool - obsutil

Command Line Structure

Windows:

Uploading a file

obsutil cp file_url obs://bucket[/key] [-arcDir=xxx] [-dryRun] [-link] [-u] [-vlength] [-vmd5] [-p=1] [-threshold=5248800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-o=xxx] [-cpd=xxx] [-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Uploading a folder

obsutil cp folder_url obs://bucket[/key] -r [-arcDir=xxx] [-dryRun] [-link] [-f] [-flat] [-u] [-vlength] [-vmd5] [-j=1] [-p=1] [-threshold=52428800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Uploading multiple files/folders

obsutil cp file1_url,folder1_url|filelist_url obs://bucket[/prefix] -msm=1 [-r] [-arcDir=xxx] [-dryRun] [-link] [-f] [-u] [-vlength] [-vmd5] [-flat] [-j=1] [-p=1] [-threshold=52428800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx][-timeRange=time1-time2] [-at] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

NOTE:

In this command, /prefix is the name prefix for uploading folders.

Linux or macOS:

Uploading a file

./obsutil cp file_url obs://bucket[/key] [-arcDir=xxx] [-dryRun] [-link] [-u] [-vlength] [-vmd5] [-p=1] [-threshold=5248800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-o=xxx] [-cpd=xxx] [-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Uploading a folder

./obsutil cp folder_url obs://bucket[/key] -r [-arcDir=xxx] [-dryRun] [-link] [-f] [-flat] [-u] [-vlength] [-vmd5] [-j=1] [-p=1] [-threshold=52428800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-at] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Uploading multiple files/folders

./obsutil cp file1_url,folder1_url|filelist_url obs://bucket[/prefix] -msm=1 [-r] [-arcDir=xxx] [-dryRun] [-link] [-f] [-u] [-vlength] [-vmd5] [-flat] [-j=1] [-p=1] [-threshold=52428800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx][-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

NOTE:

In this command, /prefix is the name prefix for uploading folders.

Examples

Take the Windows OS as an example. Run the obsutil cp d:\temp\test.txt obs://bucket-test/key command to upload the test.txt file in the temp directory in the D: drive to bucket bucket-test and rename the file as key.

obsutil cp d:\temp\test.txt obs://bucket-test/key
Start at 2024-09-30 08:11:41.6724827 +0000 UTC

Parallel:      5                   Jobs:          5
Threshold:     50.00MB             PartSize:      auto
VerifyLength:  false               VerifyMd5:     false
CheckpointDir: C:\Users\Administrator\.obsutil_checkpoint

[====================================================] 100.00% 1.68 MB/s 8.46MB/8.46MB 5s
Upload successfully, 8.46MB, n/a, d:\temp\test.txt --> obs://bucket-test/key, cost [5], status [200], request id [0000016979E1D2B2860BB5181229C72C]

Take the Windows OS as an example. Run the obsutil cp d:\temp obs://bucket-test -f -r command to recursively upload all files and subfolders in the temp directory in the D: drive to the temp folder in bucket bucket-test.

obsutil cp d:\temp obs://bucket-test -f -r
Start at 2024-09-30 08:14:12.1406275 +0000 UTC

Parallel:      5                   Jobs:          5
Threshold:     50.00MB             PartSize:      auto
VerifyLength:  false               VerifyMd5:     false
CheckpointDir: C:\Users\Administrator\.obsutil_checkpoint

Task id: 104786c8-27c2-48fc-bc6a-5886596fb0ed
OutputDir: C:\Users\Administrator\.obsutil_output

[========================================================] 100.00% tps:35.71 2.02 KB/s 7.20MB/7.20MB 0s
Succeed count:   5         Failed count:    0
Succeed bytes:      xxx
Metrics [max cost:90 ms, min cost:45 ms, average cost:63.80 ms, average tps:35.71, transfered size: 7.20MB]

Task id: 104786c8-27c2-48fc-bc6a-5886596fb0ed

Parameter Description

Parameter	Optional or Mandatory	Description
file_url	Optional for uploading multiple files/folders Mandatory for uploading a file	Local file path NOTE: Do not nest paths when uploading multiple files/folders. For example, you cannot specify /a/b/c and /a/b/ at the same time. If this parameter is configured when uploading multiple files/folders, msm must be set to 1. In this case, use commas (,) to separate multiple file paths, for example, file_url1,file_url2. Files and folders can both be included when uploading multiple files/folders. For example, file_url1,folder_url1,file_url2,folder_url2.
folder_url	Optional for uploading multiple files/folders Mandatory for uploading a folder	Local folder path NOTE: If flat is not configured when uploading a folder, the entire folder is uploaded. If flat is configured, all files in the folder are uploaded. Do not nest paths when uploading multiple files/folders. For example, you cannot specify /a/b/c and /a/b/ at the same time. If this parameter is configured when uploading multiple files/folders, msm must be set to 1. In this case, use commas (,) to separate multiple folder paths, for example, folder_url1,folder_url2. Files and folders can both be included when uploading multiple files/folders. For example, file_url1,folder_url1,file_url2,folder_url2.
filelist_url	Optional for uploading multiple files/folders	Indicates the path of the file that contains the list of files/folders to be uploaded. If this parameter is configured, msm must be set to 2. NOTE: The list file is in common text file formats, such as TXT and CSV. Each line in the file indicates a file or folder to be uploaded. For example: file_url1 file_url2 folder_url1 folder_url2 Do not nest paths in the list file. For example, you cannot specify /a/b/c and /a/b/ at the same time.
bucket	Mandatory	Bucket name
key	Optional	Indicates the object name or object name prefix specified when uploading a file, or the object name prefix specified when uploading a folder. The rules are as follows: If this parameter is left blank when uploading a file, the file is uploaded to the root directory of the bucket and the object name is the file name. If the value ends with a slash (/), the value is used as the object name prefix when the file is uploaded, and the object name is the value plus the file name. If the value does not end with a slash (/), the file is uploaded with the value as the object name. If this parameter is left blank when uploading a folder, the folder is uploaded to the root directory of the bucket. If the value ends with a slash (/), the value is used as the object name prefix of the folder to be uploaded. If the value does not end with a slash (/), the folder to be uploaded is prefixed with the value plus a slash (/).
fr	Optional for uploading a file (additional parameter)	Generates an operation result list when uploading a file.
flat	Optional for uploading a folder or multiple files/folders (additional parameter)	Uploads all files in a folder but excludes the folder itself.
arcDir	Optional (additional parameter)	Path to which the uploaded files are archived
dryRun	Optional (additional parameter)	Conducts a dry run.
link	Optional (additional parameter)	The actual path of the symbolic link of a file/folder NOTICE: If this parameter is not specified and the file to be uploaded is a symbolic-link file whose target file does not exist, the exception message "The system cannot find the file specified" will be displayed in Windows, while the exception message "No such file or directory" will be displayed in macOS or Linux. Avoid the symbolic link loop of a folder, or the upload will exit due to panic. If you do not want the system to panic, set panicForSymbolicLinkCircle to false in the configuration file.
u	Optional (additional parameter)	Indicates incremental upload. If this parameter is configured, each file can be uploaded only when it does not exist in the bucket, its size is different from the corresponding object in the bucket, or its latest modification time is later than that of the corresponding object in the bucket. CAUTION: When you compare each local file with data in the bucket, a billable HEAD request is generated. For details, see Requests.
vlength	Optional (additional parameter)	After the upload completes, check whether the sizes of the objects in the bucket are the same as those of the local files.
vmd5	Optional (additional parameter)	After the upload completes, check whether the MD5 values of the objects in the bucket are the same as those of the local files. NOTE: If the size of the file or folder to be uploaded is too large, using this parameter will degrade the overall performance due to MD5 calculation. After the MD5 verification is successful, this parameter value is used as the metadata x-obs-meta-md5chksum for later MD5 verification during download or copy.
p	Optional (additional parameter)	Indicates the maximum number of concurrent part uploads for a multipart upload. The default value is the value of defaultParallels in the configuration file.
threshold	Optional (additional parameter)	Indicates the threshold for enabling multipart upload, in bytes. The default value is the value of defaultBigfileThreshold in the configuration file. NOTE: If the size of a file to be uploaded is smaller than the threshold, the entire file is uploaded directly. Otherwise, a multipart upload is used. If the entire file is uploaded directly, resumable upload is not supported. This parameter value can contain a unit, for example, 1MB (indicating 1048576 bytes).
acl	Optional (additional parameter)	Access control policies that can be specified when uploading files. Possible values are: private public-read public-read-write bucket-owner-full-control NOTE: These four values indicate, respectively, private read and write, public read, public read and write, and bucket owner full control.
sc	Optional (additional parameter)	Indicates the storage classes of objects that can be specified when uploading files. Possible values are: standard: Standard storage class. It features low access latency and high throughput, and is applicable to 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 (less than 12 times a year) data, but when needed, the access has to be fast. cold: Archive storage class. It provides secure, durable, and inexpensive storage for rarely-accessed (once a year) data. deep-archive: Deep Archive storage class (under a beta test). It is suitable for storing data that is barely (once every few years) accessed. This storage class costs less than the Archive storage class, but takes longer time (usually several hours) to restore data.
meta	Optional (additional parameter)	Indicates the standard and custom metadata that can be specified during file upload. This parameter should be configured in the following format: key1:value1#key2:value2#key3:value3. NOTE: The format example above indicates that the destination object contains three groups of custom metadata: key1:value1, key2:value2, and key3:value3. Standard metadata headers include Content-Type, Content-Encoding, Cache-Control, Content-Disposition, Content-Language and Expires.
ps	Optional (additional parameter)	Indicates the size of each part in a multipart upload, in bytes. The value ranges from 100KB to 5GB. The default value is the value of defaultPartSize in the configuration file. NOTE: This parameter value can contain a unit, for example, 1MB (indicating 1048576 bytes). The parameter can be set to auto. In this case, obsutil automatically configures the part size for each multipart based on the source file size.
cpd	Optional (additional parameter)	Indicates the folder where the checkpoint file is stored. The default value is .obsutil_checkpoint, the subfolder in the home directory of the user who executes obsutil commands. NOTE: A checkpoint file is generated for each multipart upload and saved to the upload subfolder. After the upload succeeds, the checkpoint file is deleted automatically. If the upload fails or is suspended, when you resume the upload the next time, the system would start from the point recorded in the checkpoint file.
r	Mandatory for uploading a folder (additional parameter) Optional for uploading multiple files	Indicates that files and subfolders within the folder are uploaded recursively.
f	Optional for uploading a folder or multiple files/folders (additional parameter)	Runs in force mode.
j	Optional for uploading a folder or multiple files/folders (additional parameter)	Indicates the maximum number of concurrent tasks for uploading a folder. The default value is the value of defaultJobs in the configuration file. NOTE: The tool ensures that the value is at least 1.
msm	Mandatory for uploading multiple files/folders (additional parameter)	Enables the mode for uploading multiple files/folders. Possible values are 1 and 2. NOTE: If msm is set to 1, the source URL indicates a list of file/folder names separated by commas. If msm is set to 2, the source URL indicates a file containing a list of file/folder names. If the file or folder name already contains commas (,), do not set msm to 1. If parameter r is not specified, the folders in the list will not be uploaded.
exclude	Optional for uploading a folder or multiple files/folders (additional parameter)	Indicates the matching pattern of files that are excluded, for example, .txt. NOTE: The asterisk () represents any group of characters, and the question mark (?) represents any single character. For instance, *abc.txt indicates any file whose name starts with abc and ends with .txt*. You can use \ to represent * and \? to represent ?. If the name of the file to be uploaded matches the value of this parameter, the file is skipped. NOTICE: You are advised to use quotation marks for the matching pattern to prevent special characters from being escaped by the OS and leading to unexpected results. Use single quotation marks for Linux or macOS and double quotation marks for Windows. The matching pattern applies to the absolute file path (including the file name and file directory). The matching pattern takes effect only for files in the folder. Multiple exclude parameters can be specified, for example, *-exclude=.xxx -exclude=.xxx*.
include	Optional for uploading a folder or multiple files/folders (additional parameter)	Indicates the matching pattern of files that are included, for example: .jpg. NOTE: The asterisk () represents any group of characters, and the question mark (?) represents any single character. You can use \* to represent * and \? to represent ?. The exclude rules are preferentially matched. If the name of a file to be uploaded does not match the value of exclude, the system checks whether the file name matches the value of this parameter. If yes, the file is uploaded. If no, the file is skipped. NOTE: Example of uploading files in a request with the include parameter contained: ./obsutil cp /localpath/ obs://test/ -include=/localpath/2022-12-09/* -f -r This command uploads files that are under localpath and start with /localpath/2022-12-09/ to bucket test. NOTICE: You are advised to use quotation marks for the matching pattern to prevent special characters from being escaped by the OS and leading to unexpected results. Use single quotation marks for Linux or macOS and double quotation marks for Windows. The matching pattern applies to the absolute file path (including the file name and file directory). The matching pattern takes effect only for files in the folder. Multiple include parameters can be specified, for example, *-include=.xxx -include=.xxx*.
at	Optional for uploading a folder or multiple files/folders (additional parameter)	Indicates that only the files whose latest access time is within the value of timeRange are uploaded. NOTE: This parameter must be used together with timeRange.
disableDirObject	Optional for uploading multiple folders (additional parameter)	Indicates the folders themselves are not uploaded as an object. Configuring this parameter can avoid uploading empty folders to a bucket. If a folder contains files, the files will be uploaded and the original path format is retained.
timeRange	Optional for uploading a folder or multiple files/folders (additional parameter)	Only files whose latest modification time is within the configured time range are uploaded. This matching pattern has a lower priority than the file matching pattern exclude and include. NOTE: The matching time range is represented in time1-time2, where time1 must be earlier than or the same as time2. The time format is yyyyMMddHHmmss. Automatic formatting is supported. For example, yyyyMMdd is equivalent to yyyyMMdd000000, and yyyyMM is equivalent to yyyyMM01000000. If this parameter is set to -time2, all files whose latest modification time is earlier than time2* are matched. If it is set to time1-, all files whose latest modification time is later than time1* are matched. NOTICE: Time in the matching pattern is the UTC time.
mf	Optional (additional parameter)	Indicates that the name matching pattern (include or exclude) and the time matching pattern (timeRange) also take effect on folders.
o	Optional (additional parameter)	Indicates the folder where operation result lists are generated. After the command is executed, result lists (possibly success, failure, and warning files) are generated in the folder. The default value is .obsutil_output, the subfolder in the home directory of the user who executes obsutil commands. NOTE: The naming rule for result lists is as follows: cp_{succeed \| failed \| warning}_report_time_TaskId.txt. By default, the maximum size of a single result list is 30 MB and the maximum number of result lists that can be retained is 1024. You can set the maximum size and number by configuring, respectively, recordMaxLogSize and recordBackups in the configuration file. If there are multiple folders and files and you need to confirm the detailed error information about a failed task, refer to the failure list cp_failed_report_time_TaskId.txt in the result list folder and the log files in the log path.
config	Optional (additional parameter)	User-defined configuration file for executing a command. For details about parameters that can be configured, see Parameter Description.
e	Optional (additional parameter)	Specifies the endpoint.
i	Optional (additional parameter)	Specifies the user's AK.
k	Optional (additional parameter)	Specifies the user's SK.
t	Optional (additional parameter)	Specifies the user's security token.

Configuring a Storage Class

Scenarios

Bucket and Object Storage Classes

Configuring a Storage Class During Bucket Creation

Using OBS Console

Using the API

Using SDKs

Using the GUI Tool - OBS Browser+

Using the CLI Tool - obsutil

Configuring a Storage Class During Object Uploads

Using OBS Console

Using the API

Using SDKs

Using the GUI Tool - OBS Browser+

Using the CLI Tool - obsutil

Feedback

Was this page helpful?