Help Center> Object Storage Service> API Reference> APIs> Advanced Bucket Settings> Obtaining the Cross-Region Replication Configuration of a Bucket
View PDF

Obtaining the Cross-Region Replication Configuration of a Bucket

Functions

This operation obtains the replication configuration information of a specified bucket. To perform this operation, you must have the GetReplicationConfiguration permission.

Request Syntax

1
2
3
4
 
GET /?replication HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
Date: date 
Authorization:authorization string

Request Parameters

This request contains no parameter.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

This request involves no elements.

Response Syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
 
HTTP/1.1 status_code 
Date: date 
Server:OBS 
Content-Length: contentlength 
<?xml version="1.0" encoding="UTF-8"?> 
<ReplicationConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2006-03-01/">
 
  <Agency>testAcy</Agency>
  <Rule> 
      <ID>rule1</ID> 
      <Status>Enabled</Status> 
      <Prefix></Prefix> 
      <Destination> 
         <Bucket>exampletargetbucket</Bucket> 
         <StorageClass>WARM</StorageClass> 
      </Destination> 
      <HistoricalObjectReplication>Enabled</HistoricalObjectReplication>
  </Rule> 
</ReplicationConfiguration>

Response Headers

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

Response Elements

This response contains elements to detail the configuration. The following table describes the elements.

Table 1 Bucket replication configuration elements

Element

Description

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

Children: Rule

Ancestor: none

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

Ancestor: ReplicationConfiguration

ID

Unique identifier of a rule, with a maximum length of 255 characters.

Type: string

Ancestor: Rule

Status

If the value of this element is Disabled, this rule will be ignored.

Type: string

Ancestor: Rule

Value options: Enabled, Disabled

Prefix

Prefix of an object key name, applicable to one or more objects.

The maximum length of a prefix is 1,024 characters. Duplicated prefixes are not supported.

Type: string

Ancestor: Rule

Destination

Container for the destination bucket information.

Type: container

Ancestor: Rule

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

Ancestor: Destination

StorageClass

Storage class of an object.

Type: enumeration

Ancestor: Destination

Value options: STANDARD | WARM | COLD

HistoricalObjectReplication

Keyword for copying a historical object. If the value is Enabled, historical objects meeting this rule are copied.

Type: string

Ancestor: Rule

Value options: Enabled, Disabled

Error Responses

The following table describes the error response for this request.

Table 2 Error response elements

Error Code

Description

HTTP Response Code

SOAP Error Code Prefix

NoSuchReplicationConfiguration

Cross-region replication configuration does not exist.

404 not found

Client

Sample Request

1
2
3
4
5
6
 
GET /?replication HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: Wed, 27 Jun 2018 13:42:40 +0000
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:jGHviInfRyOkT/EpySpua1hlBuY=

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: B59500000164417B57D02F7EF8823152
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSHu6lz4vgk5G3E32OFcIPEZZgdOEYE/
Content-Type: application/xml
Date: Wed, 27 Jun 2018 13:42:39 GMT
Content-Length: 337

<?xml version="1.0" encoding="utf-8"?>
<ReplicationConfiguration xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2006-03-01/">
 
  <Rule> 
    <ID>Rule-1</ID>  
    <Status>Enabled</Status>  
    <Prefix></Prefix>  
    <Destination> 
      <Bucket>dstbucket</Bucket>  
      <StorageClass>STANDARD</StorageClass> 
    </Destination>
    <HistoricalObjectReplication>Enabled</HistoricalObjectReplication> 
  </Rule>  
  <Agency>testAcy</Agency> 
</ReplicationConfiguration>
Parent topic: Advanced Bucket Settings