This interface retrieves the current data replication progress, cross-region replication rules, or same-region replication rules for the specified bucket (Bucket).

Request syntax

Request parameters and headers

This request uses public request headers. See Public Parameters.

Name	Location	Type	Required	Sample value	Description
replication	Query	String	Yes	-	Represents the special identifier for the GetBucketReplication request.
progress	Query	String	No	progress	Indicates whether to query the bucket’s data replication progress; must be used with the rule-id parameter.
rule-id	Query	String	No	1	Query the rule number for copying progress. Use it with the progress parameter.

Request body elements

No elements are used.

Response headers

This request returns public response headers. See Public Parameters.

Response body elements

Name	Type	Sample value	Note
Role	String	ServiceRoleforReplicationAccessTOS	role name.
Rules	Array	-	Copy rules.
ID	String	1	The unique identifier of the rule.
Status	String	Enabled	Specify whether to enable this rule. The values are as follows: Enabled: Enable this rule. Disabled: Disable this rule.
PrefixSet	Array	prefix_1	The object name prefix to which this rule applies.
Tags	Array	-	TOS can copy Objects with specific tags, allowing up to 10 tags to be configured. For detailed information about tags, refer to File Tag Management.
Key	String	key	The key of the object tag. Parent node: Tags
Value	String	value	The value of the object tag. Parent node: Tags
Destination	Object	-	save the target bucket information.
Bucket	String	Target Bucket Name	Name of the bucket storing copies of objects identified by the rule.
Location	String	cn-beijing	the region where the target bucket is located.
StorageClass	String	STANDARD	Specify the storage class of the objects copied to the destination bucket. The values are as follows: STANDARD: Standard storage. STANDARD_IA: Infrequent Access storage. GLACIER_IR: Glacier Instant Retrieval storage. INTELLIGENT_TIERING: Intelligent Tiering storage. ARCHIVE: Archive storage. COLD_ARCHIVE: Cold Archive storage. DEEP_COLD_ARCHIVE: Deep Cold Archive storage tip If both StorageClass and StorageClassInheritDirective parameters are set, the object's storage type is assigned based on the value specified in StorageClass.
StorageClassInheritDirective	String	DESTINATION_BUCKET	Set the storage class for objects replicated to the destination bucket. The options are as follows: SOURCE_OBJECT: inherit the storage class of the source bucket's object. DESTINATION_BUCKET: inherit the default storage class of the destination bucket.
HistoricalObjectReplication	String	Enabled	Enable or disable copying historical objects. When enabled, it copies historical objects that meet this rule. The value descriptions are as follows: Enabled: Enable copying historical objects. Disabled: Disable copying historical objects.
DeleteMarkerReplication	String	Enabled	Whether to enable synchronizing deletion markers. If enabled, deletion markers matching this rule will be synchronized. The options are as follows: Enabled：Enable synchronizing deletion markers. Disabled：Do not enable synchronizing deletion markers. warning Synchronizing deletion markers is an invitation-only feature. To try it, contact your account manager.
DeleteObjectReplication	String	Enabled	Whether to enable synchronizing object deletion. If enabled, after deleting an object in the source bucket, the object in the target bucket will be deleted synchronously. The options are as follows: Enabled：Enable synchronizing object deletion. Disabled：Do not enable synchronizing object deletion. warning Synchronizing object deletion is an invitation-only feature. To try it, contact your account manager. When synchronous object deletion is enabled, TOS automatically ensures eventual consistency of data between the source and destination buckets. However, if you set up bidirectional replication rules between multiple buckets and then delete an object in a destination bucket during replication, TOS cannot guarantee the eventual consistency of data across those buckets.
TransferType	String	tos_acc	Data transmission links used during data replication. The values are as follows: internal: The default TOS transmission link. This link is only allowed for cross-region data replication within mainland China. tos_acc: Transmission acceleration link. This link is only allowed for cross-region data replication between mainland China and regions outside mainland China. For detailed information on transfer acceleration, see Transfer Acceleration.
AccessControlTranslation	Object	-	Owner management permissions for the object. tip The AccessControlTranslation parameter is only returned when copying objects across accounts. If a bucket uses cross-account copying but the AccessControlTranslation parameter is not returned, it means the destination bucket has not been granted owner management permissions for the copied object. Specifically, the owner of the destination bucket can overwrite and delete the object but cannot read it or grant other accounts permission to read the object.
Owner	String	BucketOwnerEntrusted	The destination bucket has been granted owner management permissions for replicated objects, allowing it to read objects and grant read access to other accounts.
Progress	Object	-	Save the copying progress.
NewObject	String	2015-09-24T15:28:14.000Z	Show the time when data was replicated to the target bucket.
HistoricalObject	float64	0.99	Displays the percentage of copied historical data.

Sample request

Sample response

Torch Object Storage