All Products
Search
Document Center

Object Storage Service:get-bucket-replication-progress

Last Updated:Aug 26, 2024

Queries the progress of a data replication task of a bucket.

Usage notes

  • To query the progress of a data replication task of a bucket, you must have the oss:GetBucketReplicationProgress permission. For more information, see Attach a custom policy to a RAM user.

  • Only the bucket owner can query the data replication rules of the bucket. You can initiate a get-bucket-replication-location request from an OSS endpoint.

Command syntax

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

Parameter

Type

Description

--bucket

string

The name of the bucket.

--rule-id

string

The ID of the data replication rule.

Note
  • The get-bucket-replication-location command corresponds to the GetBucketReplicationProgress operation. For more information about the parameters in the GetBucketReplicationProgress operation, see GetBucketReplicationProgress.

  • For more information about supported global command-line options, see Global command-line options.

Examples

  • Run the following command to query the progress of a data replication rule named replication_1 of a bucket named examplebucket:

    ossutil api get-bucket-replication-progress --bucket examplebucket --rule-id replication_1
  • Run the following command to query the progress of a data replication rule named replication_1 of a bucket named examplebucket and display the progress in the JSON format:

    ossutil api get-bucket-replication-progress --bucket examplebucket --rule-id replication_1 --output-format json
  • Run the following command to query the progress of a data replication rule named replication_1 of a bucket named examplebucket and display the progress in the YAML format:

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