All Products
Search
Document Center

Object Storage Service:get-bucket-replication-progress

Last Updated:Mar 20, 2026

Check the progress of a data replication task for a specific bucket and replication rule.

Prerequisites

Before you begin, ensure that you have:

Usage notes

  • Only the bucket owner can query replication progress.

  • You can run this command from any OSS endpoint.

Syntax

ossutil api get-bucket-replication-progress --bucket <value> --rule-id <value> [flags]

Parameters in [ ] are optional. All other parameters are required.

ParameterTypeDescription
--bucketstringThe name of the bucket.
--rule-idstringThe ID of the data replication rule.
get-bucket-replication-progress corresponds to the GetBucketReplicationProgress API operation. For the full parameter reference, see GetBucketReplicationProgress. For supported global flags, see Global command-line options.

Examples

All examples query the progress of the replication rule replication_1 for the bucket examplebucket. Use --output-format to control the output format.

Default output

ossutil api get-bucket-replication-progress --bucket examplebucket --rule-id replication_1

JSON output

ossutil api get-bucket-replication-progress --bucket examplebucket --rule-id replication_1 --output-format json

YAML output

ossutil api get-bucket-replication-progress --bucket examplebucket --rule-id replication_1 --output-format yaml

What's next