全部產品
Search
文件中心

Object Storage Service:GetBucketReplicationProgress

更新時間:Jun 08, 2024

GetBucketReplicationProgress用於擷取某個儲存空間(Bucket)的資料複製進度。

請求文法

GET /?replicationProgress&rule-id=RuleId HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

要求標頭

此介面僅涉及公用要求標頭。更多資訊,請參見公用要求標頭(Common Request Headers)

請求參數

名稱

類型

是否必須

描述

rule-id

字串

複製規則對應的ID。此ID可從GetBucketReplication中擷取。

回應標頭

此介面僅涉及公用回應標頭。更多資訊,請參見公用回應標頭(Common Response Headers)

響應元素

名稱

類型

描述

ReplicationProgress

容器

儲存複製進度的容器。

父節點:無

子節點:Rule

Rule

容器

儲存每個複製規則進度條目的容器。

父節點:ReplicationConfiguration

子節點:ID、Destination、Status和Progress

ID

字串

複製規則對應的ID。

父節點:Rule

子節點:無

PrefixSet

容器

儲存Prefix 的容器,每個複製規則中,最多能指定10個Prefix。

父節點:Rule

子節點:Prefix

Prefix

字串

待覆制Object的Prefix,只有匹配該Prefix的Object才會被複製到目標Bucket。

父節點:PrefixSet

子節點:無

Action

字串

表示被同步到目標Bucket的操作。

Action允許以下操作類型,您可以指定一項或者多項。

  • ALL(預設操作):表示PUT、DELETE、ABORT操作均會被同步到目標Bucket。

  • PUT:表示被同步到目標Bucket的寫入操作,包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、 InitiateMultipartUpload 、 UploadPart、UploadPartCopy和CompleteMultipartUpload。

父節點:Rule

子節點:無

Destination

容器

儲存目標Bucket資訊的容器。

父節點:Rule

子節點:Bucket和Location

Bucket

字串

資料被複製到的目標Bucket。

父節點:Destination

子節點:無

Location

字串

目標Bucket所在的Location。

父節點:Destination

子節點:無

TransferType

字串

資料複製時使用的資料轉送類型。

  • internal(預設值):OSS預設傳輸鏈路。

  • oss_acc:傳輸加速鏈路。只有建立跨地區複製規則時才能使用傳輸加速鏈路。

HistoricalObjectReplication

字串

是否複製歷史資料。即開啟資料複製前,是否將源Bucket中的資料複製到目標Bucket。

取值:

  • enabled(預設值):表示複製歷史資料。

  • disabled:表示不複製歷史資料,僅複製跨地區複製規則生效後新寫入的資料。

Progress

容器

儲存複製進度的容器,僅當資料處於同步狀態(doing)時才返回此元素。

父節點:Rule

子節點:HistoricalObject、NewObject

HistoricalObject

字串

顯示已複製歷史資料的百分比。僅對開啟了歷史資料複製的Bucket有效。

父節點:Progress

子節點:無

NewObject

字串

顯示資料複製到目標Bucket的時間點(GMT格式)。

例如Thu, 24 Sep 2015 15:39:18 GMT,表示早於該時間點寫入的資料都已複製到目標Bucket。

父節點:Progress

子節點:無

樣本

  • 請求樣本

    GET /?replicationProgress&rule-id=test_replication_1 HTTP/1.1
    Host: oss-example.oss-cn-hangzhou.aliyuncs.com
    Date: Thu, 24 Sep 2015 15:39:15 GMT
    Authorization: OSS qn6q**************:77Dv****************
  • 返回樣本

    說明

    僅當傳輸類型為oss_acc時,返回的XML訊息體中才會包含<TransferType>元素。

    HTTP/1.1 200 OK
    x-oss-request-id: 534B371674E88A4D8906****
    Date: Thu, 24 Sep 2015 15:39:15 GMT
    Content-Length: 234
    Content-Type: application/xml
    Connection: close
    Server: AliyunOSS
    
    <?xml version="1.0" ?>
    <ReplicationProgress>
     <Rule>
       <ID>test_replication_1</ID>
       <PrefixSet>
        <Prefix>source_image</Prefix>
        <Prefix>video</Prefix>
       </PrefixSet>
       <Action>PUT</Action>
       <Destination>
        <Bucket>target-bucket</Bucket>
        <Location>oss-cn-beijing</Location>
        <TransferType>oss_acc</TransferType>
       </Destination>
       <Status>doing</Status>
       <HistoricalObjectReplication>enabled</HistoricalObjectReplication>
       <Progress>
        <HistoricalObject>0.85</HistoricalObject>
        <NewObject>2015-09-24T15:28:14.000Z </NewObject>
       </Progress>
     </Rule>
    </ReplicationProgress>

錯誤碼

錯誤碼

HTTP狀態代碼

描述

NoSuchBucket

404 NotFound

請求的Bucket不存在。

NoSuchReplicationRule

404 NotFound

指定的RuleId不存在。

NoSuchReplicationConfiguration

404 NotFound

請求的Bucket沒有配置資料複製。

TooManyReplicationRules

400 BadRequest

請求中配置的資料複製規則超過一條。

單次請求中只能配置一條資料複製規則。