Listing All Replication Synchronization Rules of a Bucket
Updated at：2025-11-03
API description
This API is designed to fetch all replication synchronization rules for a bucket.
Request URI
GET /v1/{bucketName}/?replication&list
| Parameter name | Parameter type | Required or not | Description | Example value | Parameter location |
|---|---|---|---|---|---|
| bucketName | String | Yes | Bucket name | "bucketName_example" | Path |
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 |
|---|---|---|---|
| rules | List |
replication rule list |
Description of the data structure of the Rules field
| 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-replication-config |
| 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: Leave this parameter empty to match the storage class of the source bucket. Use STANDARD for standard storage, STANDARD_IA for infrequent access, and COLD for cold storage. For multi-AZ buckets, use MAZ_STANDARD_IA for multi-AZ infrequent access or MAZ_STANDARD for multi-AZ standard storage. No other values are permitted. | 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,MAZ_STANDARD_IA | COLD |
Request example
JSON
1GET /v1/bucketName_example/?replication&list
2 <Common request headers>
3{ }Response example
JSON
1HTTP/1.1 200 OK
2 <Common response headers>
3{
4 "rules" : [ {
5 "destRegion" : "bj",
6 "create_time" : 1583060606,
7 "resource" : [ "src-bucket-name/abc", "src-bucket-name/abc" ],
8 "destination" : {
9 "bucket" : "dst-bucket-name",
10 "storageClass" : "COLD"
11 },
12 "id" : "sample-bucket-replication-config",
13 "replicateHistory" : {
14 "storageClass" : "COLD"
15 },
16 "replicateDeletes" : "enabled",
17 "status" : "enabled"
18 }, {
19 "destRegion" : "bj",
20 "create_time" : 1583060606,
21 "resource" : [ "src-bucket-name/abc", "src-bucket-name/abc" ],
22 "destination" : {
23 "bucket" : "dst-bucket-name",
24 "storageClass" : "COLD"
25 },
26 "id" : "sample-bucket-replication-config",
27 "replicateHistory" : {
28 "storageClass" : "COLD"
29 },
30 "replicateDeletes" : "enabled",
31 "status" : "enabled"
32 } ]
33}Error code
Please refer to the general error codes