Data Synchronization Configuration

Updated at：2025-11-03

Bucket data synchronization configuration

Set data synchronization rules

Basic workflow
1. Create a BosClient instance.
2. Call the putBucketReplication() method.

Example code

                JavaScript
                
            

                const ReplicationInfo = {
  status:"enabled",
  resource:[
      bucketName + "/*"
    ],
  destination:
      {
          bucket: <dstBucketName>,
          storageClass: "COLD"
      },
  replicateHistory:
      {
          bucket: <dstBucketName>,
          storageClass:"COLD"
      },
  replicateDeletes:"enabled",
  id: <ruleId>
}
client.putBucketReplication(<BucketName>,<ReplicationInfo>)            
  .then(function(response) {
      if(response) {
        // TODO
      }
  })
  .catch(function() {});
            

Parameter: ReplicationInfo structure

Parameters	Required or not	Description
id	Yes	Rule name of replication. The ID must consist of numbers, letters, hyphens (-), and underscores (_), and shall not exceed 20 characters.
status	Yes	Is it effective
resource	Yes	Effective prefix of replication. The resource configuration format is ｛$BucketName/｝, and must start with `$BucketName`+`/`.
destination	Yes	Destination location configuration of replication
+bucket	Yes	Destination Bucket name
+storageClass	No	Storage class of destination object. If the storage class is to be consistent with that of the source Bucket, this parameter does not need to be configured; if you need to specify a separate storage class, it can be `STANDARD`, `STANDARD_IA` and `COLD`; if it is a multi-AZ type bucket, the available values are `MAZ_STANDARD_IA` and `MAZ_STANDARD`.
replicateHistory	No	Historical file replication: When enabled, all existing objects will be synchronously replicated to the destination bucket, sharing the same resource scope.
+storageClass	No	Storage class of destination object. If the storage class is to be consistent with that of the source Bucket, this parameter does not need to be configured; if you need to specify a separate storage class, it can be `STANDARD`, `STANDARD_IA` and `COLD`; if it is a multi-AZ type bucket, the available values are `MAZ_STANDARD_IA` and `MAZ_STANDARD`.
replicateDeletes	Yes	It indicates whether Delete synchronization function is enabled. It is `enabled`,`disabled`.

Note:

The user must own the source bucket with FULL_CONTROL permission and have write access to the target bucket.

Both the source bucket and the target bucket must exist.

The source bucket and target bucket can be in the same region or different regions.

The target bucket and source bucket can be under the same account or different accounts, but the source account must have the write permission for the destination bucket.

The total configuration size must not exceed 128 KB, and the combined length of all rules under the current bucket must not exceed 200 KB.

Data synchronization does not currently support archive storage class files; such files will be ignored during the synchronization process.

Users can configure up to 10 replication rules.

A single rule can include up to 20 resources.

The ID must consist of numbers, letters, hyphens (-), and underscores (_), and shall not exceed 20 characters

Get specified data synchronization rules

With this method, users can retrieve data synchronization information for a specified bucket ID, including the source bucket name, destination bucket name, storage class, whether historical replication is performed, data synchronization policy, destination region, etc.

Basic workflow

Plain Text

11.  Create a BosClient instance.
22.  Call the getBucketReplication() method.

Code example

                JavaScript
                
            

                    client.getBucketReplication(<BucketName>,<RuleId>)            
.then(function(response) {
    if(response) {
        // TODO
    }
    else {}
})
.catch(function() {});
    ```


**Delete specified data synchronization rule**

Users can delete the data synchronization rule with the specified ID of the bucket through this method

-   Basic workflow

  1.  Create a BosClient instance.
  2.  Call the deleteBucketReplication() method.

-   Code example
```js
    client.deleteBucketReplication(<BucketName>,<RuleId>)            
.then(function(response) {
    if(response) {
        // TODO
    }
    else {}
})
.catch(function() {});
    ```

** List all data synchronization rules **

Users can get all replication synchronization rules of the bucket through this method
-   Basic workflow

  1.  Create a BosClient instance.
  2.  Call the listBucketReplication() method.

-   Code example
```js
    client.listBucketReplication(<BucketName>)            
.then(function(response) {
    if(response) {
        // TODO
    }
    else {}
})
.catch(function() {});
    ```



** Get the process status of specified data synchronization rules **

Users can get the progress status of data synchronization replication with the specified ID of the bucket through this method
-   Basic workflow

  1.  Create a BosClient instance.
  2.  Call the getBucketReplicationProgress() method.

-   Code example
```js
    client.getBucketReplicationProgress(<BucketName>,<RuleId>)            
.then(function(response) {
    if(response) {
        // TODO
    }
    else {}
})
.catch(function() {});
    ```
            

Install SDK

Create Bucket

BOS

BOS

Data Synchronization Configuration

Bucket data synchronization configuration