Retrieving Bucket Data Synchronization Information
Updated at：2025-11-03
API description
This API retrieves data synchronization details for a specified bucket ID, including the source bucket name, destination bucket name, storage class, whether historical replication is activated, synchronization policy, destination region, and more.
Request URI
GET /v1/{bucketName}/?replication
| Parameter name | Parameter type | Required or not | Description | Example value | Parameter location |
|---|---|---|---|---|---|
| bucketName | String | Yes | Bucket name | "bucketName_example" | Path |
| id | String | Yes | Rule name of replication | "id_example" | Query |
Parameters of request body
Description of the data structure of request body fields
Response body parameters
Description of the data structure of response body fields
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| status | String | Is it effective | enabled |
| resource | List |
Effective prefix of replication | |
| destination | Destination | Destination location configuration of replication | |
| replicateHistory | ReplicateHistory | Historical file replication. Its existence indicates it is enabled. | |
| replicateDeletes | String | It indicates whether Delete synchronization function is enabled. It is enabled or disabled. | enabled |
| id | String | Rule name of replication | sample-bucket |
| create_time | Integer | Creation time of replication rule | 1583060606 |
| destRegion | String | Destination region | bj |
Description of the data structure of the Destination field
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| bucket | String | Destination Bucket name | dst-bucket-name |
| storageClass | String | The destination object's storage class can be left empty if it aligns with the source bucket's class. STANDARD refers to the standard storage class, STANDARD_IA refers to infrequent access storage, and COLD refers to cold storage. For multi-AZ type buckets, the options are MAZ_STANDARD_IA and MAZ_STANDARD. | COLD |
Description of the data structure of the ReplicateHistory field
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| storageClass | String | The storage class of the destination Object, which defaults to REMAIN, and can be STANDARD, STANDARD_IA, COLD, MAZ_STANDARD_IA, MAZ_STANDARD | COLD |
Request example
JSON
1GET /v1/bucketName_example/?replication&id=id_example
2 <Common request headers>
3{ }Response example
JSON
1HTTP/1.1 200 OK
2 <Common response headers>
3{
4 "destRegion" : "bj",
5 "create_time" : 1583060606,
6 "resource" : [ "src-bucket-name/abc", "src-bucket-name/abc" ],
7 "destination" : {
8 "bucket" : "dst-bucket-name",
9 "storageClass" : "COLD"
10 },
11 "id" : "sample-bucket",
12 "replicateHistory" : {
13 "storageClass" : "COLD"
14 },
15 "replicateDeletes" : "enabled",
16 "status" : "enabled"
17}Error code
Please refer to the general error codes