Cross-Region Replication

1. In the navigation pane of OBS Console, choose Object Storage.
2. In the bucket list, click the bucket you want to operate. The Objects page is displayed.
3. In the navigation pane, click Cross-Region Replication.
4. Click Create Rule. The Create Cross-Region Replication Rule dialog box is displayed. See Figure 3.
   Figure 3 Creating a cross-region replication rule
   
   

   • The versioning status of the source and destination buckets must keep the same.
   • 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.

5. Configure a cross-region replication rule according to your service needs. For details about the parameters, see Table 1.

   Table 1 Cross-region replication parameters

   Parameter		Description
   Status		Indicates whether the rule is enabled or disabled after being created. The versioning status of the source and destination buckets must keep the same.
   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	To apply the rule to objects with the specified prefix, 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, imgs/.
   	Synchronize Existing Objects	Indicates whether to synchronize the objects that were already in the bucket before the rule configuration to the destination bucket. By default, these objects are not synchronized.
   	Replicate KMS encrypted objects	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 the KMS Administrator permission for both source and destination ends 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 do not have the KMS Administrator permission for either the source or destination end 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.
   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.
   	Change storage class for replicated objects	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 objects copies, select this parameter, then you can specify a storage class.
   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. NOTE: The IAM agency selected here must be of OBS. The OBS project must have the Tenant Administrator permission. If Replicate KMS encrypted objects is selected, you also need the KMS Administrator permission in the regions where the source and destination buckets are located.

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

Configuring Cross-Region Replication for a Bucket

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]

• The source path and destination path cannot be the same.
• The source path and destination path cannot be partly 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.

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, transfered size: 7.20MB]
  Task id: 0476929d-9d23-4dc5-b2f8-0a0493f027c5

• For more examples, see Copy.

Parameter Description

Response

1. 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.
2. Click Create Agency.
3. Enter an agency name.
4. Select Cloud service for the Agency Type.
5. Select Object Storage Service (OBS) for Cloud Service.
6. Set a validity period.
7. Click Next.
   

   The console for creating an agency has the new and old editions. The following steps use the new edition.

8. On the Select Policy/Role page, search for and select OBS Administrator and click Next.
9. On the Select Scope page, select Global services for Scope and click OK.
10. (Optional) If Replicate KMS encrypted objects is selected, the IAM agency also needs the KMS Administrator permission in the regions where the source and destination buckets are located.
    1. Go to the Agencies page of the IAM console and click the name of the agency created in the previous step.
    2. Choose the Permissions tab and click Authorize.
    3. On the Select Policy/Role page, search for and select KMS Administrator. Then, click Next.
    4. On the Select Scope page, select Region-specific projects for Scope. Then, select the projects in the regions where the source and destination buckets are located. Click OK.