文档首页/ 对象存储服务 OBS/ API参考/ API/ 桶的高级配置/ 设置桶的跨区域复制配置-SetBucketReplication
更新时间：2025-12-18 GMT+08:00
查看PDF
分享

设置桶的跨区域复制配置-SetBucketReplication

功能介绍

跨区域复制是指跨不同区域中的桶自动、异步地复制对象。通过激活跨区域复制，OBS可将新创建的对象及修改的对象从一个源桶复制到不同区域中的目标桶。

配置跨区域复制需要选择IAM委托，配置方法请参见创建IAM委托。

设置桶的跨区域复制，需要满足以下两个要求：

  1. 要求源桶和目标桶多版本状态保持一致，否则不能设置replication。如何设置桶的多版本，请参见设置桶的多版本状态-SetBucketVersioning。
  2. 源桶的拥有者和代理人（OBS）必须要有目标桶的写权限（目标桶需要配置BucketPolicy），同时代理人（OBS）还要有源桶的读权限。这需要通过“BucketPolicy”来实现这个权限委托。

如何设置桶策略，请参见设置桶策略-SetBucketPolicy。设置桶策略后，代理人（OBS）就有权限可以读取源桶的对象，也有权限将对象复制到目标桶中。

授权信息

您必须是桶拥有者或拥有设置桶的跨区域复制配置的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。

  • 如果使用IAM授权，那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种，并配置相应权限：
    • 如果使用角色与策略授权（旧版IAM，即IAM v3接口），需具备obs:bucket:PutReplicationConfiguration权限，授权操作请参见创建IAM自定义策略。
    • 如果使用身份策略授权（新版IAM，即IAM v5接口），如下表所示，需具备obs:bucket:putReplicationConfiguration权限，授权操作请参见创建IAM自定义身份策略。

      授权项

      Action

      访问级别

      Access Level

      资源类型（*为必须）

      Resource Type (*: required)

      条件键

      Condition Key

      别名

      Alias

      依赖的授权项

      Dependencies

      obs:bucket:putReplicationConfiguration

      Write

      bucket *

      -

      -

      -
      • obs:EpochTime
      • obs:SourceIp
      • obs:TlsVersion
      • obs:CustomDomain
  • 如果使用桶策略进行授权，需具备obs:bucket:PutReplicationConfiguration权限，具体操作请参见自定义创建桶策略。

请求消息样式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
 
PUT /?replication HTTP/1.1 
Host: bucketname.obs.cn-north-4.myhuaweicloud.com 
x-obs-date: date 
Content-MD5: MD5
Authorization: authorization string 
Content-Length: contentlength 

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

请求消息参数

该请求消息中不使用消息参数。

请求消息头

该请求使用的消息头如下所示。

表1 设置桶的复制配置请求消息头

参数

是否必选

参数类型

描述

Content-MD5

是

string

参数解释：

按照RFC 1864标准计算出消息体的MD5摘要字符串，即消息体128bit MD5值经过base64编码后得到的字符串。如何计算Content-MD5可参考Java中Content-MD5的计算方法示例。

取值范围：

不涉及

默认取值：

不涉及

请求消息元素

在此请求中，需要在请求的消息体中配置桶的复制配置，通知的配置信息（请求body）以XML格式上传。具体的配置元素如下描述。

表2 设置桶的复制配置元素

参数

是否必选

参数类型

描述

ReplicationConfiguration

是

Container

参数解释：

跨区域复制规则的容器。ReplicationConfiguration是Rule和Agency的父节点。

约束限制：

  • 单桶可以配置1~100条跨区域复制规则。
  • 单次配置跨区域复制规则的请求body大小不能超过50K。

取值范围：

不涉及

默认取值：

不涉及

Rule

是

Container

参数解释：

一条特定跨区域复制规则信息的容器。

约束限制：

一个桶上可以配置1~100条跨区域复制规则。

取值范围：

请详见Rule参数说明。

默认取值：

不涉及

Agency

是

String

参数解释：

用户创建用于跨区域复制的委托的名称。

约束限制：

  • 委托必须为“对象存储服务 OBS”的云服务委托，委托需要具有表5 委托需要的OBS权限中的权限。
  • 如果勾选了“复制使用KMS加密的对象”，委托还需要具有“KMS CMKFullAccess”权限，委托的授权范围选择“指定区域项目资源”并选择源桶和目标桶所在区域。

取值范围：

长度为0~64的字符串。

默认取值：

不涉及

表3 委托需要的OBS权限

操作

描述

obs:object:GetObject

获取对象内容、获取对象元数据。

obs:object:DeleteObjectVersion

删除对象、批量删除对象。

obs:object:PutObjectVersionAcl

设置对象ACL。

obs:object:AbortMultipartUpload

取消多段上传任务。

obs:object:PutObjectAcl

设置对象ACL。

obs:object:DeleteObject

删除对象、批量删除对象。

obs:bucket:HeadBucket

获取桶元数据。

obs:object:PutObject

PUT上传、POST上传、复制对象、追加写对象、初始化上传段任务、上传段、合并段

obs:object:GetObjectVersionAcl

获取对象ACL。

obs:bucket:GetBucketVersioning

获取桶的多版本状态。

obs:bucket:ListBucketMultipartUploads

列举多段上传任务。

obs:object:ListMultipartUploadParts

列举已上传的段。

obs:object:ModifyObjectMetaData

修改对象元数据。

obs:bucket:ListBucketVersions

列举桶内多版本对象。

obs:bucket:ListBucket

列举桶内对象。

obs:object:GetObjectVersion

获取对象内容、获取对象元数据。

obs:object:GetObjectAcl

获取对象ACL。

obs:bucket:GetReplicationConfiguration

获取桶的跨区域复制配置。
表4 Rule参数说明

参数

是否必选

参数类型

描述

ID

否

String

参数解释：

跨区域复制规则的规则ID。

约束限制：

规则ID不能重复。

取值范围：

长度为0~255的字符串。

默认取值：

不涉及

Status

是

String

参数解释：

是否启用此跨区域复制规则。

约束限制：

不涉及

取值范围：

  • Enabled：启用规则
  • Disabled：未启用规则

默认取值：

不涉及

Prefix

是

String

参数解释：

对象名的前缀。适配于一个或者多个对象。

约束限制：

  • 如果前缀配置为空，则跨区域复制规则将作用于整个桶。
  • 规则之间前缀的字符不支持重叠。例如用户配置了两条规则，规则1的前缀为object，规则2的前缀是obj，则这两条规则就有个重叠的前缀obj。

取值范围：

经过UTF-8编码的长度大于0且不超过1024的字符序列。

默认取值：

不涉及

Destination

是

Container

参数解释：

目标桶信息的容器。

约束限制：

不涉及

取值范围：

请详见Destination参数说明。

默认取值：

不涉及

HistoricalObjectReplication

否

String

参数解释：

是否复制符合跨区域复制规则的历史对象。

约束限制：

不涉及

取值范围：

  • Enabled：复制符合跨区域复制规则的历史对象
  • Disabled：不复制符合跨区域复制规则的历史对象

默认取值：

如果不设置，则默认为Disabled。
表5 Destination参数说明

参数

是否必选

参数类型

描述

Bucket

是

String

参数解释：

跨区域复制目标桶的桶名，该桶用于存储被跨区域复制规则标识的对象副本。

约束限制：

如果在跨区域复制配置中有多条规则，这些规则必须都要标识同一个桶作为目标桶。

取值范围：

长度为3~63的字符串。

默认取值：

不涉及

StorageClass

否

String

参数解释：

表示复制到目标桶的对象将被修改成的目标存储类别。

约束限制：

不涉及

取值范围：

  • STANDARD：标准存储
  • WARM：低频访问存储
  • COLD：归档存储
  • DEEP_ARCHIVE：深度归档存储（受限公测）

默认取值：

不涉及

DeleteData

否

String

参数解释：

源桶的对象删除后是否通过跨区域复制操作同步删除目标桶中的同名对象。

约束限制：

不涉及

取值范围：

  • Enabled：源桶的对象删除操作会同步到目标端。
  • Disabled：源桶的对象删除操作不会同步到目标端。

默认取值：

如果不设置，则默认为Disabled。

响应消息样式

1
2
3
4
 
HTTP/1.1 status_code 
Server: OBS 
Date:date 
Content-Length: contentlength

响应消息头

该请求的响应消息使用公共消息头，具体请参考表1。

响应消息元素

该请求的响应消息中不带有响应元素。

错误响应消息

在此请求的响应中不会返回特殊错误。

请求示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
PUT /?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: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>
          <StorageClass>STANDARD</StorageClass>
          <DeleteData>Enabled</DeleteData>
       </Destination>      
       <HistoricalObjectReplication>Enabled</HistoricalObjectReplication>
     </Rule>
</ReplicationConfiguration>

响应示例

1
2
3
4
5
6
 
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
父主题： 桶的高级配置

相关文档