On this page

Functions
Request Syntax
Request Parameters
Request Headers
Request Elements
Response Syntax
Response Headers
Response Elements
Error Responses
Sample Request
Sample Response

Show all

Help Center/ Object Storage Service/ API Reference (Ankara Region)/ APIs/ Advanced Bucket Settings/ Configuring Cross-Region Replication for a Bucket

Configuring Cross-Region Replication for a Bucket

Updated on 2024-04-15 GMT+08:00

View PDF

Functions

Cross-region replication refers to the automatic and asynchronous replication of objects across buckets in different regions. By activating cross-region replication, OBS can copy new objects and modified objects from a source bucket in one region to a destination bucket in a different region.

NOTE:

If cross-cluster or cross-region replication has been configured for a bucket, configuring another replication policy will overwrite the existing one.

An IAM agency is required for configuring cross-region replication. For details, see section "Creating an IAM Agency" in the Object Storage Service User Guide.

To configure cross-region replication for a bucket, the following two requirements must be met:

The versioning statuses of the source and destination buckets are the same. For details, see Configuring Versioning for a Bucket.
The source bucket's owner and agency (OBS) have the write permission for the destination bucket (with a bucket policy configured), and the agency (OBS) also has the read permission for the source bucket. This permission delegation needs to be implemented by using a bucket policy.

For details about how to configure the bucket policy, see Configuring a Bucket Policy. After the bucket policy is set, the agency (OBS) can read objects from the source bucket and copy objects to the destination bucket.

Request Syntax

    
     
       
       PUT /?replication HTTP/1.1 
Host: bucketname.obs.region.example.com
x-obs-date: date 
Content-MD5: MD5
Authorization: authorization string 
Content-Length: contentlength 

<ReplicationConfiguration> 
    <Agency>testAcy</Agency>
    <Rule> 
        <ID>rule1</ID> 
        <Prefix>key-prefix</Prefix> 
        <Status>rule-status</Status> 
        <Destination> 
            <Bucket>targetbucketname</Bucket> 
            <DeleteData>Enabled</DeleteData>
        </Destination> 
        <HistoricalObjectReplication>Enabled</HistoricalObjectReplication>
    </Rule> 
</ReplicationConfiguration>

      

    
   

Request Parameters

This request contains no message parameters.

Request Headers

The request uses one header, as described in the following table.

**Table 1** Request header for cross-region replication
Element	Description	Mandatory
Content-MD5	Base64-encoded 128-bit MD5 digest of the message according to RFC 1864.	Yes

Request Elements

This request contains elements to specify the replication configuration for the bucket in XML format. The following table lists request elements:

**Table 2** Bucket replication configuration elements
Element	Description	Mandatory
ReplicationConfiguration	Container for the replication rules. A maximum of 100 rules can be configured. The size of the XML file can reach 50 KB. Type: container Child: Rule Parent: none	Yes
Agency	Name of the agency, which can have a maximum of 64 characters. Type: string Parent: ReplicationConfiguration	Yes
Rule	Container of a specified replication rule. The replication configuration must contain at least one rule. The maximum number of rules is 100. Type: container Parent: ReplicationConfiguration	Yes
ID	Unique identifier of a rule, with a maximum length of 255 characters. Type: string Parent: Rule	No
Status	If the value of this element is Disabled, this rule will be ignored. Type: string Parent: Rule Value options: Enabled, Disabled	Yes
Prefix	Prefix of an object key name, applicable to one or more objects. If the Prefix is left blank, the cross-region replication rule is applied to the whole bucket. The maximum length of a prefix is 1024 characters. Duplicated prefixes are not supported. Type: string Parent: Rule	Yes
Destination	Container for the destination bucket information. Type: container Parent: Rule	Yes
Bucket	Bucket used to store object copies that are marked by rules. If the replication configuration contains multiple rules, the rules must specify the same bucket as the destination bucket. Type: string Parent: Destination	Yes
DeleteData	Keyword for synchronizing object deletion operations. If the value is Enabled, the object deletion for the source bucket will be replicated to the destination bucket. Type: string Parent: Destination Value options: Enabled and Disabled (If this element is absent from the request, Disabled is applied by default.)	No
HistoricalObjectReplication	Keyword for copying a historical object. If the value is Enabled, historical objects meeting this rule are copied. Type: string Parent: Rule Value options: Enabled and Disabled (If this element is absent from the request, Disabled is applied by default.)	No

Response Syntax

    
       HTTP/1.1 status_code 
Server: OBS 
Date:date 
Content-Length: contentlength

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains no elements.

Error Responses

No special error responses are returned for this request.

Sample Request

    
     
       
       PUT /?replication HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: Wed, 27 Jun 2018 13:39:15 +0000
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:CdeqU0Vg9xNdJMZ0PGPgh5EnkO0=
Content-MD5: l/Z8mfSX+VyV8k5EhIQz5Q==
Content-Length: 330

<ReplicationConfiguration>
   <Agency>testAcy</Agency>
   <Rule>
       <ID>Rule-1</ID>
       <Status>Enabled</Status>
       <Prefix></Prefix>
       <Destination>
          <Bucket>dstbucket</Bucket>
          <DeleteData>Enabled</DeleteData>
       </Destination>      
       <HistoricalObjectReplication>Enabled</HistoricalObjectReplication>
     </Rule>
</ReplicationConfiguration>

      

    
   

Sample Response

    
       HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: B59500000164417839932E5A2295674C
x-obs-id-2: 32AAAQAAEAABKAAQAAEAABAAAQAAEAABCStv51t2NMMx+Ou+ow7IWV4Sxo231fKe
Date: Wed, 27 Jun 2018 13:39:15 GMT
Content-Length: 0

Parent topic: Advanced Bucket Settings

Previous topic: Obtaining the Event Notification Configuration of a Bucket

Next topic: Obtaining the Cross-Region Replication Configuration of a Bucket

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot