GET Bucket replication

最近更新时间:2025-04-21 19:07:12

我的收藏

功能描述

GET Bucket replication 接口用于查询存储桶中用户存储桶复制配置信息。用户发起该请求时需获得请求签名,表明该请求已获得许可。


授权说明

授权策略 中 action 设置为 cos:GetBucketReplication。查看所有 action

请求

请求示例

GET /?replication HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
说明
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com,其中 <BucketName-APPID> 为带 APPID 后缀的存储桶名字,例如 examplebucket-1250000000,详情请参见 存储桶概览 > 基本信息存储桶概述 > 存储桶命名规范 文档;<Region> 为 COS 的可用地域,详情请参见 地域和访问域名 文档。
Authorization: Auth String(详情请参见 请求签名 文档)。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求的请求体为空。

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<ReplicationConfiguration>
<Role>qcs::cam::uin/OwnerUin:uin/SubUin</Role>
<Rule>
<Status></Status>
<Priority></Priority>
<ID></ID>
<Prefix></Prefix>
<Destination>
<Bucket>qcs::cos:Region::BucketName-APPID</Bucket>
<StorageClass></StorageClass>
<EncryptionConfiguration>
<ReplicaKmsKeyID></ReplicaKmsKeyID>
</EncryptionConfiguration>
</Destination>
<DeleteMarkerReplication>
<Status></Status>
</DeleteMarkerReplication>
<SourceSelectionCriteria>
<SseKmsEncryptedObjects>
<Status>Enabled</Status>
</SseKmsEncryptedObjects>
</SourceSelectionCriteria>
</Rule>
</ReplicationConfiguration>
具体的节点描述如下:
节点名称(关键字)
父节点
描述
类型
ReplicationConfiguration
说明所有复制配置信息
Container
Role
ReplicationConfiguration
发起者身份标示:
qcs::cam::uin/&lt;OwnerUin>:uin/&lt;SubUin>
String
Rule
ReplicationConfiguration
具体配置信息,最多支持1000个,所有策略只能指向一个目标存储桶
Container
ID
ReplicationConfiguration.Rule
用来标注具体 Rule 的名称
String
Status
ReplicationConfiguration.Rule
标识 Rule 是否生效,枚举值:Enabled,Disabled
String
Priority
ReplicationConfiguration.Rule
执行优先级,用于处理目标存储桶相同、复制规则命中同一个对象的情况。
注意:
支持设置1 - 1000范围内的正整数,不同规则的 Priority 值不可重复。
存储桶复制规则必须全部携带 Priority 或全部不携带 Priority。
所有规则都携带 Priority 时,当目标存储桶相同时,不同规则的筛选 prefix 可以存在重叠。不同规则命中同一个对象时,会优先触发 Priority 值最小的规则。
所有规则都不携带 Priority 时,不同规则的筛选 prefix 不允许重叠。
Integer
Filter
ReplicationConfiguration.Rule
筛选待复制对象。存储桶功能将复制符合 Filter 中设置的前缀、标签的对象
Container
And
ReplicationConfiguration.Rule
筛选待复制对象时,如果同时需要前缀与对象标签条件,或需要使用多个对象标签条件时,需要用 And 包装
Container
Prefix
ReplicationConfiguration.Rule 或
ReplicationConfiguration.Rule.Filter 或ReplicationConfiguration.Rule.Filter.And
前缀匹配策略,不可重叠,重叠返回错误,前缀匹配根目录为空
String
Tag
ReplicationConfiguration.Rule.Filter.And
筛选待复制对象时,可以用对象标签(支持多个)作为过滤条件,最多支持填入10个标签。添加标签作为筛选条件后,同步删除标记选项必须置为 false
Container
Key
ReplicationConfiguration.Rule.Filter.And.Tag
筛选标签的 Key 值
String
Value
ReplicationConfiguration.Rule.Filter.And.Tag
筛选标签的 Value 值
String
Bucket
ReplicationConfiguration.Rule.Destination
资源标识符:
qcs::cos:[region]::[BucketName-APPID]
String
StorageClass
ReplicationConfiguration.Rule.Destination
目标存储类型,代表存储到目标存储桶使用的存储类型。例如 STANDARD、INTELLIGENT_TIERING、STANDARD_IA、ARCHIVE,DEEP_ARCHIVE 等,详情请参见 存储类型。默认值:原存储类型
String
EncryptionConfiguration
Destination
当 SseKmsEncryptedObjects.Status 设置为 Enabled 后,必须包含此字段。用于设置复制到目标桶的 KMS 加密对象所使用的 KMS 密钥
String
ReplicaKmsKeyID
EncryptionConfiguration
KMS 密钥
String
DeleteMarkerReplication
ReplicationConfiguration.Rule
是否同步删除标记
Container
Status
ReplicationConfiguration.Rule. DeleteMarkerReplication
是否同步删除标记,支持 DisabledEnabled。默认值为 Enabled,即同步删除标记
String
SourceSelectionCriteria
ReplicationConfiguration.Rule
用于说明存储桶复制规则支持复制的对象的额外条件。当前,仅支持选择是否复制 KMS 加密的对象
Container
SseKmsEncryptedObjects
ReplicationConfiguration.Rule.SourceSelectionCriteria
选择是否复制 KMS 加密的对象
Container
Status
ReplicationConfiguration.Rule.SseKmsEncryptedObjects
选择是否复制 KMS 加密的对象,支持枚举值 EnabledDisabled
String

错误码

此接口遵循统一的错误响应和错误码,详情请参见 错误码 文档。

实际案例

请求

下述请求示例展示了从存储桶originbucket-1250000000中查询配置信息。
GET /?replication HTTP/1.1
Date: Fri, 14 Apr 2019 07:17:19 GMT
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1503895278;1503895638&q-key-time=1503895278;1503895638&q-header-list=host&q-url-param-list=replication&q-signature=****************************************
Host: originbucket-1250000000.cos.ap-guangzhou.myqcloud.com
Content-Length: 0

响应

上述请求后,COS 返回以下响应,表明当前该存储桶内的存储桶复制配置处于启用状态。该规则配置信息中,复制的内容为存储桶 originbucket-1250000000 内包含 testPrefix 前缀的所有对象。对象副本的存储类型默认跟随源存储桶内对象的存储类型。
Content-Type: application/xml
Content-Length: 309
Connection: keep-alive
Date: Fri, 14 Apr 2019 07:17:19 GMT
Server: tencent-cos
x-cos-replication-rule-creation-time: Fri, 14 Apr 2019 07:06:19 GMT
x-cos-request-id: NWQwMzQ5ZmZfMjBiNDU4NjRfNjAwOV84MzA2****
<ReplicationConfiguration>
<Role>qcs::cam::uin/100000000001:uin/100000000001</Role>
<Rule>
<Status>Enabled</Status>
<ID>RuleId_01</ID>
<Prefix>testPrefix</Prefix>
<Priority>1</Priority>
<Destination>
<Bucket>qcs::cos:ap-guangzhou::destinationbucket-1250000000</Bucket>
<StorageClass>MAZ_Standard</StorageClass>
</Destination>
</Rule>
</ReplicationConfiguration>