Cross-Region Replication Within an Account_Data Replication_Data Management_User Guide

Scenarios

Cross-region replication within an account allows you to create a cross-region replication rule to automatically replicate data from a source bucket in one region to a destination bucket in another region under the same account in near real time. Objects replicated to the destination bucket are exact copies of the objects in the source bucket.

Replication scope: objects with specified prefix or all objects in the bucket

Replicable object data: object content, metadata (object name, size, last modification time, creator, version number, and user-defined metadata), ACL, and storage class (default configuration)

If Change storage class for replicated objects is selected when you create a cross-region replication rule, the storage class of the object copies is different from that of the source objects.

Figure 1 Cross-region replication within an account

Cross-region replication within an account applies to the following scenarios:

Regulatory compliance
OBS stores data across AZs that are relatively far apart from each other, but regulatory compliance may require further distances. Cross-region replication enables you to meet regulatory requirements.
Low latency
The same OBS resources may need to be accessed from different locations. To minimize the access latency, you can use cross-region replication to create object copies in the nearest region.
Data replication
You want to migrate data stored in OBS to the data center in another region.
Data backup and disaster recovery
You want to create explicit backups for all data written to OBS in the data center of another region to ensure data remains available if there is any damage.
Ease of maintenance
You have compute clusters used to analyze the same group of objects in two different OBS regions and may need to maintain object copies in these two regions.

OBS helps you replicate your service data stored in OBS to a specified region, but Huawei Cloud has no access to your data. You need to ensure the legal compliance of your use of OBS on your own. If your replication involves cross-border transfer, ensure that your use complies with relevant laws and regulations.

Constraints

**Table 1** Constraints on cross-region replication within an account
Item	Description
Bucket version	Only buckets whose version is 3.0 or later support cross-region replication. The version of a bucket can be viewed in the Basic Information area of the bucket's Overview page on OBS Console. For details, see Viewing Bucket Information.
Functions	If objects in the source bucket are in the Archive, or Deep Archive storage class, they cannot be replicated to the destination bucket. If the destination region does not support a specific storage class, object copies will be stored in the Standard storage class. OBS currently only supports the replication between one source bucket and one destination bucket. Replication from one source bucket to multiple destination buckets is not supported. The destination bucket can be modified. However, modifying the destination bucket will change the destination bucket of all existing rules. Cross-region replication does not replicate appendable objects. A source bucket can have only one cross-region replication rule that is applied to all objects in the bucket, or it can have up to 100 rules that are applied to objects with the specified prefix. Objects encrypted using SSE-C cannot be replicated across regions.
Time	A cross-region replication rule may not take effect immediately upon its configuration. Accordingly, the objects that this rule is applied to may not be replicated immediately after the rule is configured.
Area	The source and destination buckets must be in two different regions. Before replicating data, ensure that the source and destination regions can have their data replicated from each other. Figure 2 lists the supported regions. "√" indicates that data can be replicated between regions. "x" indicates that data cannot be replicated between regions.
Synchronization of historical objects	By default, objects uploaded before cross-region replication is enabled are not replicated to the destination bucket unless the function for synchronizing existing objects is enabled. Modifying cross-region replication settings may prevent existing objects from being replicated, so do not make modifications before the synchronization of existing objects is complete. If a copied object in the destination bucket is deleted and a new replication rule that allows replication of existing objects is configured within three days of the deletion, the same version of the deleted object will not be replicated to the destination bucket again. For example, you first configure cross-region replication rule 1 to replicate the current version of object test.txt from the source bucket to the destination bucket. Later, you delete test.txt from the destination bucket and delete rule 1. Two days afterward, you create cross-region replication rule 2 that allows replication of existing objects. In this case, test.txt will not be replicated to the destination bucket again.
Versioning	The versioning status (enabled or disabled) of the source bucket must be the same as that of the destination bucket. If versioning is enabled or suspended for both the source and destination buckets and cross-region replication is also enabled for both buckets, deleting an object without specifying its version in the source bucket will also delete the object in the destination bucket. For an enabled cross-region replication rule, if you change the versioning status of the destination bucket, the replication of objects will fail. If you want to change the versioning status of the source bucket, delete the replication configuration first, and then make the change.
Access control	Bucket owners must have the read and write permissions for both source and destination buckets for successful replication. If OBS does not have permission to read source objects or write destination objects, objects cannot be replicated successfully. Even if OBS is granted required permissions later, the replication will not be resumed. Do not delete or overwrite object copies in a destination bucket or modify their ACLs. Doing so may result in inconsistent latest object versions and access control settings between the destination and source buckets. After a replication with Synchronize Existing Objects enabled is complete, if the replication policy keeps unchanged, any ACL changes of source objects will be synchronized to object copies. However, ACL changes of source historical objects will not be synchronized to the copies of historical objects.
Tags	A cross-region replication rule will not replicate tags applied to the source bucket and objects to the destination bucket and objects.
Others	Objects in a source bucket can be replicated to only one destination bucket, and cannot be replicated further from that destination bucket to another bucket. For example, bucket A and bucket B are in two different regions. You can copy data from bucket A to bucket B or the other way round. However, data copies in either bucket A or bucket B cannot be replicated anymore. If you delete the OBS agency for an enabled cross-region replication rule, the object replication will be in the FAILED status. If BlockPublicAcls is enabled for the destination bucket but the ACL of source bucket allows public access, cross-region replication will fail because of ACL conflicts.

Figure 2 Replication between regions
Click to enlarge

Important Notes

After a bucket is created, you are advised to wait at least 5 minutes before creating a cross-region replication rule for the bucket, or the rule may fail to be created.
If the cross-region replication rule is enabled but the function of synchronizing existing objects is disabled, there is a delay of about five minutes to apply the rule. Objects uploaded during that delay may not be replicated.
If the cross-region replication rule and the function of synchronizing existing objects are both enabled, existing objects will be replicated 5 minutes later.
Objects encrypted using server-side encryption (including SSE-KMS and SSE-OBS) can be replicated. The replication traffic cost is calculated based on the length of the plaintext for SSE-KMS and SSE-OBS. For details, see Billing for Cross-Region Replication Within an Account.

Billing for Cross-Region Replication Within an Account

Figure 3 shows the items that will be billed when data is replicated from one region to another.

Figure 3 Items billed for cross-region replication
Click to enlarge

**Table 2** Billing for data replication across regions
Action	Billing Item	Description	Billing Mode
Replicate data across regions	Requests	You are billed for the number of successfully replicated objects. Successfully replicating one object creates a copy request. For details, see Copying Objects. For non-multipart objects, replicating an object creates a GET request to the source bucket and a PUT request to the destination bucket; deleting an object from the source bucket creates a DELETE request to the destination bucket. For multipart objects, replicating each part creates a GET request to the source bucket and a PUT request to the destination bucket. For details about how requests are billed, see Requests.	Pay-per-use
	Data transfer	Traffic generated when you replicate data from the source bucket to the destination bucket in another region. Billing only applies to the data transferred out of the source bucket. If objects are encrypted using server-side encryption, the cost of their cross-region replication traffic is calculated based on the length of the plaintext for SSE-KMS and SSE-OBS.	Pay-per-use
	Storage space	Space occupied by the replicated objects in the destination bucket If you have specified another storage class for object copies in the destination bucket, these copies are billed based on the new storage class. If objects are encrypted using server-side encryption, their storage cost is calculated based on the length of the ciphertext.	Pay-per-use Resource packages
Synchronize existing objects	Requests	You are billed for the number of existing objects that are successfully replicated to the destination bucket. Billing applies to the number of objects that are successfully replicated. You are also billed for listing the existing objects.	Pay-per-use
	Data transfer	Traffic generated when OBS replicates existing objects to the destination bucket in another region. Billing only applies to the data transferred out of the source bucket. If historical objects are encrypted using server-side encryption, the cost of their cross-region replication traffic is calculated based on the length of the plaintext for SSE-KMS and SSE-OBS.	Pay-per-use
	Storage space	Space occupied by the replicated objects in the destination bucket If you have specified another storage class for object copies in the destination bucket, these copies are billed based on the new storage class. If historical objects are encrypted using server-side encryption, their storage cost is calculated based on the length of the ciphertext.	Pay-per-use Resource packages

Prerequisites

A source bucket has been created in a region of an account. The version of the source bucket is 3.0 or later, and cross-region replication is available in the region of the source bucket. For details about the support for cross-region replication in each region, search for "cross-region replication" on the Function Overview page.
A destination bucket has been created in another region of the same account. To create a bucket, see Creating a Bucket.

Creating a Rule for Cross-Region Replication Within an Account

You can use OBS Console, APIs, or obsutil to configure cross-region replication within an account.

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.
In the navigation pane, choose Data Management > Cross-Region Replication.
Click Create Rule. The Create Cross-Region Replication Rule dialog box is displayed. See Figure 4.

Figure 4 Creating a cross-region replication rule
- The source and destination buckets must have the same versioning status.
- A bucket can have only one destination bucket and one IAM agency configured for cross-region replication. The destination bucket and IAM agency specified in a later replication rule will overwrite those in the previous replication rule of the bucket.

Configure a cross-region replication rule according to your needs.

**Table 3** Cross-region replication parameters
Parameter		Description
Status		Indicates whether the rule is enabled or disabled after being created. The source and destination buckets must have the same versioning status.
Source Bucket	Replicate	Indicates the objects the rule will apply to. All objects: The rule applies to all objects in the bucket. Match by prefix: The rule applies only to objects with the specified prefix.
	Prefix	If you select Match by prefix for Replicate, you need to specify an object name prefix. The rule will apply only to objects with the specified prefix in the source bucket. You must set Prefix to a value no longer than 1,024 characters. If the specified prefix overlaps with the prefix of an existing rule, OBS regards these two rules as one and forbids you to configure the one you are configuring. For example, if there is already a rule with prefix abc in OBS, you cannot configure another rule whose prefix starts with abc. To copy a folder, end the prefix with a slash (/), for example, folder1/.
	Synchronize Existing Objects	Indicates whether to synchronize the objects that were already in the source bucket before the rule configuration to the destination bucket. By default, these objects are not synchronized.
Destination Bucket	Region	Indicates the region of the destination bucket. The destination and source buckets must be in different regions.
	Bucket	Indicates the destination bucket. NOTE: If a bucket is newly created, you may need to wait for several minutes before you can view the bucket in the drop-down list of the destination bucket.
	Change storage class for replicated objects	Changes the storage class of objects replicated from the source bucket to the destination bucket. By default, this option is not selected, indicating that the storage class of object copies is the same as that of the source objects. If you need to change the storage class of object copies, select this parameter, then you can specify a storage class.
Permissions	Replicate KMS encrypted objects	Replicates KMS encrypted objects from the source bucket to the destination bucket. OBS will try to copy KMS encrypted objects no matter whether this option is selected or not. If this option is selected, only the IAM agencies that have any permission for the global project and have the KMS Administrator permission for both source and destination regions are displayed in the drop-down list of IAM Agency in the Create Cross-Region Replication Rule dialog box. If this option is not selected, only the IAM agencies that have any permission for the global project, but do not have the KMS Administrator permission for either the source or destination region are displayed in the drop-down list of IAM Agency in the Create Cross-Region Replication Rule dialog box. If KMS is not available in the destination region or the agency does not have the KMS Administrator permission in the source and destination regions, KMS encrypted objects will fail to be replicated to the destination bucket, and the object replication status will be failed. After a KMS-encrypted object is replicated to the destination bucket, the key for encrypting the object copy changes to the default key obs/default of the destination region.
Permissions	IAM Agency	Delegates OBS to operate your resources, so that OBS can use this agency to implement cross-region replication. If there is no IAM agency available, click View IAM Agencies to create one. If you have already created IAM agencies, select one from the drop-down list. The IAM agency must meet the following requirements: The IAM agency must be for OBS and the OBS project must have the Tenant Administrator permission. If Replicate KMS encrypted objects is selected, the agency must have the KMS Administrator permission. The authorization scope of the agency must be set to Region-specific projects, and the source and destination regions must be selected.

(Optional) Create an IAM agency. For details, see Creating an Agency for Cross-Region Replication.
Click OK. The cross-region replication rule is created.

Using APIs

Configuring Cross-Region Replication for a Bucket

Using the CLI Tool - obsutil

To use obsutil to replicate objects across regions within an account, you must enable the cross-region replication mode, which means that the crr parameter is mandatory.

Do not change the source objects in the OBS bucket when copying a single object or objects in batches. Otherwise, the operation may fail or data may be inconsistent.
If the storage class of the object to be copied is cold, you must restore the object to be copied first. Otherwise, the copy fails.
To copy objects, you must have the read permission on the objects to be copied and the write permission on the destination bucket.
If the client-side cross-region replication function is not enabled, ensure that the source bucket and destination bucket are in the same region.
If the source bucket is a parallel file system (supporting POSIX), the destination bucket must also be a parallel file system.

Constraints

The source path and destination path cannot be the same.
The source path and destination path cannot be overlapped either.
- If the source path overlaps with the prefix of the destination path, recursive replication applies.
- If the destination path overlaps with the prefix of the source path, the replication may overwrite objects in the source path.

Command Line Structure

In Windows

Copying a single object

obsutil cp obs://srcbucket/key obs://dstbucket/[dest] [-dryRun][-u] [-crr] [-vlength] [-vmd5] [-p=1] [-threshold=52428800] [-versionId=xxx] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-cpd=xxx] [-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Copying objects in batches

obsutil cp obs://srcbucket[/key] obs://dstbucket[/dest] -r [-dryRun][-f] [-flat] [-u] [-crr] [-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]

In Linux or macOS

Copying a single object

./obsutil cp obs://srcbucket/key obs://dstbucket/[dest] [-dryRun] [-u] [-crr] [-vlength] [-vmd5] [-p=1] [-threshold=52428800] [-versionId=xxx] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-cpd=xxx] [-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Copying objects in batches

./obsutil cp obs://srcbucket[/key] obs://dstbucket[/dest] -r [-dryRun] [-f] [-flat] [-u] [-crr] [-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]

Examples

Take the Windows OS as an example. Run the obsutil cp obs://bucket-test/key obs://bucket-test2 command to copy a single object.

obsutil cp obs://bucket-test/key obs://bucket-test2
Start at 2024-09-30 08:30:09.0815415 +0000 UTC

Parallel:      3                   Jobs:          3
Threshold:     50.00MB             PartSize:      auto
CheckpointDir: xxxx

[=====================================================] 100.00% 6/s 0s
Waiting for the copied key to be completed on server side.
Copy successfully, 19B, obs://bucket-test/key --> obs://bucket-test2/key
ext.txt, cost [1708], status [200], request id [00000192420D227E4017336A12F1DC22]

Take the Windows OS as an example. Run the obsutil cp obs://bucket-test/temp/ obs://bucket-test2 -f -r command to copy objects in batches.

obsutil cp obs://bucket-test/temp/ obs://bucket-test2 -r -f
Start at 2024-09-30 08:34:02.7819703 +0000 UTC

Parallel:      5                   Jobs:          5
Threshold:     50.00MB             PartSize:      auto
CheckpointDir: xxxx

Task id: 0476929d-9d23-4dc5-b2f8-0a0493f027c5
OutputDir: xxxx

[=============================================================] 100.00% 10/s 0s
Succeed count:   5         Failed count:    0
Metrics [max cost:298 ms, min cost:192 ms, average cost:238.00 ms, average tps:9.71, transferred size: 7.20MB]
Task id: 0476929d-9d23-4dc5-b2f8-0a0493f027c5

For more examples, see Copy.

Parameter Description

Parameter	Optional or Mandatory	Description
srcbucket	Mandatory	The source bucket name
dstbucket	Mandatory	The destination bucket name
dest	Optional	The destination object name when copying an object, or the name prefix of destination objects when copying objects in batches
key	Mandatory for copying an object. Optional for copying objects in batches.	The source object name when copying an object, or the name prefix of source objects when copying objects in batches The rules are as follows: This parameter cannot be left blank when copying an object. If dest is left blank, the source object is copied to the root directory of the destination bucket. If the value of dest ends with a slash (/), the destination object name is the value of dest plus the source object name. Otherwise, the destination object name is the value of dest. If this parameter is left blank when copying objects in batches, all objects in the source bucket are copied. If not, objects whose name prefix is the set value in the source bucket are copied. The rules for confirming the name of the destination object are as follows: If the value of dest ends with a slash (/), the destination object name is the value of dest plus the source object name. If the value of dest does not end with a slash (/), the destination object name is the value of dest/source object name. If this parameter is configured but the flat parameter is not when copying objects in batches, the name of the source object contains the name prefix of the parent object. If flat is configured, then the name of the source object does not contain the name prefix of the parent object. NOTE: For details about how to use this parameter, see Copy.
fr	Optional for copying an object (additional parameter)	Generates an operation result file when copying an object.
flat	Optional for copying objects in batches (additional parameter)	The name prefix of the parent object is excluded when copying objects in batches.
dryRun	Optional (additional parameter)	Conducts a dry run.
crr	Mandatory for cross-region replication within an account	Enables the client-side cross-region replication function. In this mode, data is directly copied to the destination bucket from the source bucket through data stream. The buckets can be any two OBS buckets. If this parameter is configured, the configuration of client-side cross-region replication must be updated in the configuration file. For details, see Updating a Configuration File. When cross-region replication is enabled, the upload/download bandwidth, CPU, and memory resources of the host where commands are executed will be occupied, which may deteriorate the host performance. NOTE: The configurations of the source bucket and destination bucket are respectively akCrr/skCrr/tokenCrr/endpointCrr and ak/sk/token/endpoint in the configuration file.
vlength	Optional (additional parameter)	Verifies whether the object size in the destination bucket is the same as that in the source bucket after the copy task completes. This parameter must be used together with crr.
vmd5	Optional (additional parameter)	Verifies whether the MD5 value of the destination bucket is the same as that of the source bucket after the copy task completes. This parameter must be used together with crr. Objects in the source bucket must contain metadata x-obs-meta-md5chksum, or MD5 verification will be skipped. After the MD5 verification is successful, this parameter value is used for metadata x-obs-meta-md5chksum of the destination object, for later MD5 verification during download or replication. If your object needs encryption, do not use this parameter.
u	Optional (additional parameter)	Indicates incremental copy. If this parameter is set, each object can be copied only when it does not exist in the destination bucket, its size is different from the namesake one in the destination bucket, or it has the latest modification time.
p	Optional (additional parameter)	The maximum number of concurrent multipart copy tasks when copying an object. The default value is the value of defaultParallels in the configuration file.
threshold	Optional (additional parameter)	The threshold for enabling multipart copy. If the size of the object to be copied is smaller than the threshold, copy the object directly. If not, a multipart copy is required. The default value is the value of defaultBigfileThreshold in the configuration file. Unit: byte This parameter value can contain a unit, for example, 1MB (indicating 1,048,576 bytes). NOTE: If you copy an object directly, no part record is generated, and resumable transmission is not supported.
versionId	Optional for copying an object (additional parameter)	The source object version ID that can be specified when copying an object
acl	Optional (additional parameter)	The access control policies for destination objects that can be specified when copying objects. Possible values are: private: Only users granted permissions by the object ACL can access the object. public-read: Anyone can read objects in the bucket. public-read-write: Anyone can read, write, or delete objects in the bucket. bucket-owner-full-control: Only the bucket owner has full control over objects in the bucket.
sc	Optional (additional parameter)	The storage classes of the destination objects that can be specified when copying objects. Possible values are: standard: The Standard storage class. It features low access latency and high throughput, and is suitable for storing frequently accessed data (multiple times per month on average) or data that is smaller than 1 MB. warm: The Infrequent Access storage class. It is suitable for storing infrequently accessed (less than 12 times per year on average) data, but when needed, the access has to be fast. It has a slightly lower availability than Standard. cold: The Archive storage class. It provides secure, durable, and inexpensive storage for rarely-accessed (once per year on average) data. deep-archive: The Deep Archive storage class (under limited beta testing). It is suitable for storing data that is barely accessed (once every few years on average). This storage class costs less than the Archive storage class, but takes longer (usually several hours) to restore data.
meta	Optional (additional parameter)	The standard or user-defined metadata that can be specified during object replication. Standard metadata includes Content-Type, Content-Encoding, Cache-Control, Content-Disposition, Content-Language and Expires. User-defined metadata must be in the format of key:value. Multiple user-defined metadata items are separated by number signs (#), for example, key1:value1#key2:value2#key3:value3, which indicates that the object copy in the destination bucket contains three groups of user-defined metadata: key1:value1, key2:value2, and key3:value3.
fs	Optional (additional parameter)	Specifies whether the method of listing parallel file systems is applied. If you are listing parallel file systems, you are recommended to add this parameter. After this parameter is enabled, marker and limit will be ignored. Then, the size of the bucket, parallel file system, or directory will be calculated. This parameter is only supported for obsutil 5.5.12 or later. With this method, the listing time required varies largely depending on the directory structures.
ps	Optional (additional parameter)	The size of each part in a multipart copy task The default value is the value of defaultPartSize in the configuration file. The parameter can be set to auto. In this case, obsutil automatically configures the part size for each multipart task based on the source file size. Range: 100KB to 5GB Unit: byte. This parameter value can contain a unit, for example, 1MB (indicating 1,048,576 bytes).
cpd	Optional (additional parameter)	The folder where the part records reside. The default value is .obsutil_checkpoint, the subfolder in the home directory of the user who executes obsutil commands. A part record is generated during a multipart copy and saved to the upload subfolder. After the copy succeeds, its part record is deleted automatically. If the copy fails or is suspended, the system attempts to resume the task according to its part record when you perform the copy the next time.
r	Mandatory for copying objects in batches (additional parameter)	Copies objects in batches based on a specified name prefix of objects in the source bucket.
f	Optional for copying objects in batches (additional parameter)	Runs in force mode.
j	Optional for copying objects in batches (additional parameter)	The maximum number of concurrent tasks for copying objects in batches. The default value is the value of defaultJobs in the configuration file. NOTE: The value is ensured to be greater than or equal to 1.
exclude	Optional for copying objects in batches (additional parameter)	The matching patterns of source objects that are excluded. After this parameter is specified, if the name of the object to be copied matches the value of this parameter, the object is skipped. For example, if this parameter is set to .txt, all files whose names end with .txt* are skipped and not copied. An asterisk () matches any number of characters. For instance, abc.txt matches all files whose names start with abc, contain any number of characters in the middle, and end with .txt. A question mark (?) matches any single character. For instance, abc?.txt matches all files whose names start with abc, contain any single character in the middle, and end with .txt*. You can use \ to represent * and \? to represent ?. Multiple exclude parameters can be specified, for example, *-exclude=.xxx -exclude=.xxx. Restrictions: This matching pattern applies only to objects whose names do not end with a slash (/). NOTE: 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 path of an object, including the object name prefix and object name starting from the root directory. For example, if the path of an object in the bucket is obs://bucket/src1/src2/test.txt, then the absolute path of the object is src1/src2/test.txt*.
include	Optional for copying objects in batches (additional parameter)	The included matching patterns of source objects. After this parameter is specified, if the name of the object to be copied matches the value of this parameter, the object is copied. For example, if this parameter is set to .txt, all objects whose names end with .txt* are copied. An asterisk () matches any number of characters. For instance, abc.txt matches all files whose names start with abc, contain any number of characters in the middle, and end with .txt. A question mark (?) matches any single character. For instance, abc?.txt matches all files whose names start with abc, contain any single character in the middle, and end with .txt*. You can use \ to represent * and \? to represent ?. Multiple include parameters can be specified, for example, *-include=.xxx -include=.xxx. Restrictions: This matching pattern applies only to objects whose names do not end with a slash (/). If both the exclude* and include parameters are configured, the exclude rules are applied first. If the name of an object to be copied does not match exclude, OBS checks whether the object name matches the value of include. If yes, the object is copied. If no, the object is skipped. Example: ./obsutil cp obs://src-bucket/ obs://target-bucket/ -include=/src-object/* -f -r This command copies files whose names start with src-object/ from the src-bucket bucket to the target-bucket bucket. NOTE: 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 path of an object, including the object name prefix and object name starting from the root directory. For example, if the path of an object in the bucket is obs://bucket/src1/src2/test.txt, then the absolute path of the object is src1/src2/test.txt.
timeRange	Optional for copying objects in batches (additional parameter)	The time range matching pattern when copying objects. Only objects whose latest modification time is within the configured time range are copied. This pattern has a lower priority than the file matching patterns (exclude/include). That is, the time range matching pattern is executed after the configured file matching patterns. Time in the matching pattern is the UTC time. 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 last modification time is earlier than time2* are matched. If it is set to time1-, all files whose last modification time is later than time1* are matched. This matching pattern applies only to objects whose names do not end with a slash (/).
mf	Optional (additional parameter)	Indicates that the name matching pattern (include or exclude) and the time matching pattern (timeRange) also take effect on objects whose names end with a slash (/).
o	Optional (additional parameter)	The folder that stores the result files. After the command is executed, result files (possibly success, failure, and warning files) will be created in the specified folder. The default value is .obsutil_output, a subfolder in the user's home directory where obsutil commands are executed. A result file should be named as follows: cp_{succeed \| failed \| warning}_report_time_TaskId.txt. By default, the maximum size of a single result file is 30 MB. You can set the maximum size by configuring recordMaxLogSize in the configuration file. By default, the maximum number of result files that can be retained is 1,024. You can set the maximum number by configuring recordBackups in the configuration file. If there are multiple folders and files and you need to confirm the details of a failed task, refer to the failure result file cp_failed_report_time_TaskId.txt in the result folder and the log files in the log path.
config	Optional (additional parameter)	The user-defined configuration file for executing the current command. To learn the parameters that can be configured in this file, 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

Response

Field	Description
Parallel	The parameter -p in the request
Jobs	The parameter -j in the request
Threshold	The parameter -threshold in the request
PartSize	The parameter -ps in the request
Exclude	The parameter -exclude in the request
Include	The parameter -include in the request
TimeRange	The parameter -timeRange in the request
VerifyLength	The parameter -vlength in the request
VerifyMd5	The parameter -vmd5 in the request
CheckpointDir	The parameter -cpd in the request
OutputDir	The parameter -o in the request
ArcDir	The parameter -arcDir in the request
Succeed count	The number of successful tasks
Failed count	The number of failed tasks
Skip count	The number of tasks that are skipped during incremental upload, download, or copy, and synchronous upload, download, or copy. NOTE: Skipped tasks are recorded into successful tasks.
Warning count	The number of tasks that are executed successfully but contain warnings. NOTE: The task for which a warning is generated may be a failure or a success, which needs to be further determined according to the corresponding result list. The number of tasks that generate warnings is independent of the number of successful or failed tasks. The total number of tasks is the number of successful tasks plus the number of failed tasks.
Succeed bytes	The number of bytes that are successfully uploaded or downloaded.
max cost	The maximum duration of all tasks, in ms
min cost	The minimum duration of all tasks, in ms
average cost	The average duration of all tasks, in ms
average tps	The average number of tasks completed per second
Task id	The unique ID of an operation, which is used to search for the result file generated for a batch task

Modifying, Disabling, Enabling, or Deleting a Cross-Region Replication Rule

You can use OBS Console or APIs to manage cross-region replication rules.

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.
In the navigation pane on the left, choose Data Management > Cross-Region Replication. The Cross-Region Replication page is displayed.

(Optional) Edit a cross-region replication rule.

Click Edit in the Operation column of the rule to be modified. The Edit Cross-Region Replication Rule dialog box is displayed.
Figure 5 Editing a cross-region replication rule

Modify the cross-region replication rule.

**Table 4** Parameters for modifying a cross-region replication rule
Parameter		Description
Status		Indicates the status of the cross-region replication rule. You can enable or disable the cross-region replication rule.
Source Bucket	Replicate	Indicates the objects the rule will apply to. All objects: The rule applies to all objects in the bucket. Match by prefix: The rule applies only to objects with the specified prefix.
	Prefix	If you select Match by prefix for Replicate, you need to specify an object name prefix. The rule will apply only to objects with the specified prefix in the source bucket. You must set Prefix to a value no longer than 1,024 characters. If the specified prefix overlaps with the prefix of an existing rule, OBS regards these two rules as one and forbids you to configure the one you are configuring. For example, if there is already a rule with prefix abc in OBS, you cannot configure another rule whose prefix starts with abc. To copy a folder, end the prefix with a slash (/), for example, folder1/.
	Synchronize Existing Objects	Indicates whether to synchronize the objects that were already in the source bucket before the rule configuration to the destination bucket. By default, these objects are not synchronized.
Destination Bucket	Region	Indicates the region of the destination bucket. The destination and source buckets must be in different regions. Click Modify Destination Bucket on the right to change the region where the destination bucket resides.
	Bucket	Indicates the destination bucket. Click Modify Destination Bucket on the right to modify the destination bucket. Modifying the destination bucket will change the destination bucket of all cross-region replication rules. NOTE: If a bucket is newly created, you may need to wait for several minutes before you can view the bucket in the drop-down list of the destination bucket.
	Change storage class for replicated objects	Changes the storage class of objects replicated from the source bucket to the destination bucket. By default, this option is not selected, indicating that the storage class of object copies is the same as that of the source objects. If you need to change the storage class of object copies, select this parameter, then you can specify a storage class.
Permissions	Replicate KMS encrypted objects	Replicates KMS encrypted objects from the source bucket to the destination bucket. OBS will try to copy KMS encrypted objects no matter whether this option is selected or not. If this option is selected, only the IAM agencies that have any permission for the global project and have the KMS Administrator permission for both source and destination regions are displayed in the drop-down list of IAM Agency in the Edit Cross-Region Replication Rule dialog box. If this option is not selected, only the IAM agencies that have any permission for the global project, but do not have the KMS Administrator permission for either the source or destination region are displayed in the drop-down list of IAM Agency in the Edit Cross-Region Replication Rule dialog box. If KMS is not available in the destination region or the agency does not have the KMS Administrator permission in the source and destination regions, KMS encrypted objects will fail to be replicated to the destination bucket, and the object replication status will be failed. After a KMS-encrypted object is replicated to the destination bucket, the key for encrypting the object copy changes to the default key obs/default of the destination region.
Permissions	IAM Agency	Delegates OBS to operate your resources, so that OBS can use this agency to implement cross-region replication. Click Modify IAM Agency on the right to modify the IAM agency. If there is no IAM agency available, click View IAM Agencies to create one. If you have already created IAM agencies, select one from the drop-down list. The IAM agency must meet the following requirements: The IAM agency must be for OBS and the OBS project must have the Tenant Administrator permission. If Replicate KMS encrypted objects is selected, the agency must have the KMS Administrator permission. The authorization scope of the agency must be set to Region-specific projects, and the source and destination regions must be selected.

Click OK to complete the modification of the cross-region replication rule.

(Optional) Disable a cross-region replication rule.
If a cross-region replication rule is enabled, you can disable it as follows:
1. Click Disable in the Operation column of the target rule.
  You can also select multiple rules and click Disable above the list to disable them in batches.
2. In the Disable This Cross-Region Replication Rule dialog box, click OK.
(Optional) Enable a cross-region replication rule.
If a cross-region replication rule is disabled, you can enable it as follows:
1. Click Enable in the Operation column of the target rule.
  You can also select multiple rules and click Enable above the list to enable them in batches.
2. In the Enable This Cross-Region Replication Rule dialog box, click OK.
(Optional) Delete a cross-region replication rule.
1. Click Delete in the Operation column of the target rule.
  You can also select multiple rules and click Delete above the list to delete them in batches.
2. In the Delete This Cross-Region Replication Rule dialog box, click OK.

Using APIs

Editing a cross-region replication rule: Use the API for configuring cross-region replication for a bucket to edit a rule by modifying the request elements.
Disabling a cross-region replication rule: Use the API for configuring cross-region replication for a bucket to disable a rule by changing the value of the request element Status to Disabled.
Enabling a cross-region replication rule: Use the API for configuring cross-region replication for a bucket to enable a rule by changing the value of the request element Status to Enabled.
Deleting a cross-region replication rule

References

Creating an Agency for Cross-Region Replication

In the Create Cross-Region Replication Rule dialog box on OBS Console, click View IAM Agencies to jump to the Agencies page on the IAM console.

Click Create Agency. On the displayed page, set the parameters related to the agency for cross-region replication and retain the default values for other parameters.

**Table 5** Parameters
Parameter	Description
Agency Name	Name of the agency to be created The agency name cannot be left blank.
Agency Type	You can grant permissions to another account or cloud service for managing resources in your account. Select Cloud service for Agency Type.
Cloud Service	You can grant permissions to a cloud service for managing resources in your account. This parameter is mandatory when Agency Type is set to Cloud service. Select Object Storage Service (OBS) for Cloud Service.

Click OK. In the Agency Created dialog box that is displayed, click Cancel. If the newly created agency is displayed in the agency list, the agency is created successfully.
Grant OBS permissions to the created agency.
1. In the navigation pane of the IAM console, choose Agencies.
2. Click Authorize in the Operation column of the agency created in 2.
3. On the Select Policy/Role page, select Tenant Administrator and click Next.
4. On the Select Scope page, select All resources and click OK.
5. In the Information dialog box that is displayed, click OK.
6. On the Finish page, click Finish.
(Optional) If Replicate KMS encrypted objects is selected, the IAM agency also needs the KMS Administrator permission for the regions where the source and destination buckets are located.
1. In the navigation pane of the IAM console, choose Agencies.
2. Click Authorize in the Operation column of the agency created in 2.
3. On the Select Policy/Role page, search for and select KMS Administrator. Then, click Next.
4. Select Region-specific projects for Scope, and select the projects for the regions where the source and destination buckets are located.
5. Click OK.

Cross-Region Replication Within an Account

Scenarios

Constraints

Important Notes

Billing for Cross-Region Replication Within an Account

Prerequisites

Creating a Rule for Cross-Region Replication Within an Account

Using OBS Console

Using APIs

Using the CLI Tool - obsutil

Modifying, Disabling, Enabling, or Deleting a Cross-Region Replication Rule

Using OBS Console

Using APIs

References

Creating an Agency for Cross-Region Replication

FAQs About Cross-Region Replication Within an Account

Feedback

Was this page helpful?