GET Bucket replication

Last updated: 2021-01-08 18:01:46

    Overview

    This API (GET Bucket replication) is used to query the cross-bucket replication configuration of a bucket. When initiating this request, you need to get the request signature to show that the request has been authorized.

    Request

    Sample request

    GET /?replication HTTP/1.1
    Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
    Date: GMT Date
    Authorization: Auth String

    Note:

    Authorization: Auth String (See Request Signature for details.)

    Request headers

    This API only uses common request headers. For more information, please see Common Request Headers.

    Request body

    This request has no request body.

    Response

    Response headers

    This API returns only common response headers. For more information, please see Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes:

    <ReplicationConfiguration>
        <Role>qcs::cam::uin/[UIN]:uin/[Subaccount]</Role>
        <Rule>
            <Status></Status>
            <ID></ID>
            <Prefix></Prefix>
            <Destination>
                <Bucket>qcs::cos:[Region]::[BucketName-APPID]</Bucket>
            </Destination>
        </Rule>
    </ReplicationConfiguration>

    The detailed nodes are described as follows:

    Node Name (Keyword) Parent Node Description Type
    ReplicationConfiguration None All replication configurations Container
    Role ReplicationConfiguration Request initiator identifier, formatted as
    qcs::cam::uin/<OwnerUin>:uin/<SubUin>
    String
    Rule ReplicationConfiguration Specific configuration. You can set a maximum of 1,000 rules, which should apply to the same destination bucket Container
    ID ReplicationConfiguration.Rule Name of a specific rule String
    Status ReplicationConfiguration.Rule Rule status identifier. Enumerated values: Enabled, Disabled String
    Prefix ReplicationConfiguration.Rule Prefix matching policy. Policies cannot overlap; otherwise, an error will be returned. To match the root directory, leave this parameter empty. String
    Destination ReplicationConfiguration.Rule Destination bucket information Container
    Bucket ReplicationConfiguration.Rule.Destination Resource identifier, formatted as
    qcs::cos:[region]::[BucketName-APPID]
    String
    StorageClass ReplicationConfiguration.Rule.Destination Storage class. Enumerated values: STANDARD, INTELLIGENT_TIERING, STANDARD_IA, ARCHIVE, DEEP_ARCHIVE. Defaults to the storage class of the source bucket. String

    Error codes

    This API returns common error responses and error codes. For more information, please see Error Codes.

    Sample

    Request

    The following sample request queries the configuration of the originbucket-1250000000 bucket:

    GET /?replication HTTP/1.1
    Date: Fri, 14 Apr 2019 07:17:19 GMT
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR98JM&q-sign-time=1503895278;1503895638&q-key-time=1503895278;1503895638&q-header-list=host&q-url-param-list=replication&q-signature=f77900be432072b16afd8222b4b349aabd837cb9
    Host: originbucket-1250000000.cos.ap-guangzhou.myqcloud.com
    Content-Length: 0

    Response

    After the request above is made, COS returns the following response, indicating that the cross-bucket replication configuration of the bucket is enabled. The ReplicationConfiguration indicates that all objects prefixed with testPrefix in the originbucket-1250000000 bucket are to be replicated. Storage classes of the replicated objects are subject to those of the source bucket.

    Content-Type: application/xml
    Content-Length: 309
    Connection: keep-alive
    Date: Fri, 14 Apr 2019 07:17:19 GMT
    Server: tencent-cos
    x-cos-replication-rule-creation-time: Fri, 14 Apr 2019 07:06:19 GMT
    x-cos-request-id: NWQwMzQ5ZmZfMjBiNDU4NjRfNjAwOV84MzA2****
    <ReplicationConfiguration>
        <Role>qcs::cam::uin/100000000001:uin/100000000001</Role>
        <Rule>
            <Status>Enabled</Status>
            <ID>RuleId_01</ID>
            <Prefix>testPrefix</Prefix>
            <Destination>
                <Bucket>qcs::cos:ap-guangzhou::destinationbucket-1250000000</Bucket>
            </Destination>
        </Rule>
    </ReplicationConfiguration>