バケットのデータレプリケーションタスクの進捗状況を照会します。
リクエスト構文
GET /?replicationProgress&rule-id=RuleId HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueリクエストヘッダー
GetBucketReplicationProgress リクエストのすべてのヘッダーは、共通のリクエストヘッダーです。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
rule-id | String | はい | データレプリケーションルールの ID です。 GetBucketReplication 操作を呼び出して ID を照会できます。 |
レスポンスヘッダー
GetBucketReplicationProgress リクエストへのレスポンスのすべてのヘッダーは、共通のレスポンスヘッダーです。 詳細については、「共通レスポンスヘッダー」をご参照ください。
レスポンスパラメーター
パラメーター | タイプ | 説明 |
ReplicationProgress | コンテナー | データレプリケーションタスクの進捗状況を格納するために使用されるコンテナーです。 親ノード: なし 子ノード: Rule |
Rule | コンテナー | 各データレプリケーションルールに対応するデータレプリケーションタスクの進捗状況を格納するコンテナーです。 親ノード: ReplicationConfiguration 子ノード: ID、Destination、Status、および Progress |
ID | String | データレプリケーションルールの ID です。 親ノード: Rule 子ノード: なし |
PrefixSet | コンテナー | プレフィックスを格納するコンテナーです。 各データレプリケーションルールに最大 10 個のプレフィックスを指定できます。 親ノード: Rule 子ノード: Prefix |
Prefix | String | レプリケートするオブジェクトを指定するために使用されるプレフィックスです。 プレフィックスに一致するオブジェクトのみが宛先バケットにレプリケートされます。 親ノード: PrefixSet 子ノード: なし |
Action | String | 宛先バケットに同期される操作です。 Action には、次の操作タイプの 1 つ以上を設定できます。 デフォルト値: ALL。
親ノード: Rule 子ノード: なし |
Destination | コンテナー | 宛先バケットに関する情報を格納するコンテナーです。 親ノード: Rule 子ノード: Bucket および Location |
Bucket | String | データがレプリケートされる宛先バケットです。 親ノード: Destination 子ノード: なし |
Location | String | 宛先バケットが配置されているリージョンです。 親ノード: Destination 子ノード: なし |
TransferType | String | データレプリケーションでデータ転送に使用されるデータ転送タイプです。
|
HistoricalObjectReplication | String | データレプリケーションが有効になる前に、ソースバケットの既存データが宛先バケットにレプリケートされるかどうかを示します。 デフォルト値: enabled。 有効な値:
|
Progress | コンテナー | データレプリケーションタスクの進捗状況を格納するコンテナーです。 このパラメーターは、データレプリケーションタスクが実行中の状態にある場合にのみ返されます。 親ノード: Rule 子ノード: HistoricalObject および NewObject |
HistoricalObject | String | レプリケートされた既存データの割合です。 この要素は、HistoricalObjectReplication が enabled に設定されている場合にのみ有効です。 親ノード: Progress 子ノード: なし |
NewObject | String | データが宛先バケットにレプリケートされたかどうかを判断するために使用される時間です。 この時間より前にソースバケットに書き込まれたデータは、宛先バケットにレプリケートされます。 この要素の値は GMT 形式です。 例: Thu, 24 Sep 2015 15:39:18 GMT。 親ノード: 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****************レスポンスの例
説明TransferType パラメーターは、リクエストで TransferType の値が oss_acc に設定されている場合にのみ、レスポンスの XML 本文に含まれます。
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>
OSS SDK
次のプログラミング言語の OSS SDK を使用して、GetBucketReplicationProgress を呼び出すことができます。
ossutil
GetBucketReplicationProgress 操作に対応する ossutil コマンドについては、「get-bucket-replication-progress」をご参照ください。
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
NoSuchBucket | 404 NotFound | 指定されたバケットが存在しないために返されるエラーメッセージです。 |
NoSuchReplicationRule | 404 NotFound | 指定されたルール ID が存在しないために返されるエラーメッセージです。 |
NoSuchReplicationConfiguration | 404 NotFound | 指定されたバケットにデータレプリケーションルールが設定されていないために返されるエラーメッセージです。 |
TooManyReplicationRules | 400 BadRequest | リクエストに複数のデータレプリケーションルールが設定されているために返されるエラーメッセージです。 1 つのリクエストで設定できるデータレプリケーションルールは 1 つだけです。 |