tencent cloud

All product documents
Cloud Object Storage
DocumentationCloud Object StorageAPI DocumentationBucket APIs Intelligent TieringLIST Bucket IntelligentTiering Configurations
LIST Bucket IntelligentTiering Configurations
Download PDF
Last updated: 2024-11-19 17:46:17
LIST Bucket IntelligentTiering Configurations
Last updated: 2024-11-19 17:46:17
Download PDF

Description

The List Bucket IntelligentTiering Configurations API returns all intelligent tiering configurations in a bucket, including low-frequency tier rules (id is default), archiving, and deep archive tier rules (id is not default). Up to 1000 rules can be configured in each bucket.
Note:
When calling this request, please ensure that you have sufficient permissions to operate the intelligent tiering configurations of the bucket.
The bucket owner has such permission by default. If you do not have the permission, you can request it from the bucket owner.

Request

Sample request

GET /?intelligent-tiering HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Note
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com, where <BucketName-APPID> is the bucket name with the APPID suffix, for example, examplebucket-1250000000. For more information, refer to Bucket Overview>Basic Information and Bucket Overview>Bucket Naming Conventions documentation; <Region> refers to the available regions of COS, for details refer to Regions and Access Endpoints documentation.
Authorization: Auth String (for more details, please refer to the Request Signature documentation).

Request parameters

This API has no request parameter.

Request headers

This interface uses only common request headers. For more details, please refer to the Common Request Headers documentation.

Request body

The request body of this request is empty.

Response

Response headers

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

Response body

The response body returns application/xml data, showcasing the contents as follows:
<ListBucketIntelligentTieringConfigurationOutput>
    <IntelligentTieringConfiguration>
        <Id>default</Id>
        <Status>Enabled</Status>
        <Tiering>
            <AccessTier>INFREQUENT</AccessTier>
            <Days>30</Days>
            <RequestFrequent>1</RequestFrequent>
        </Tiering>
    </IntelligentTieringConfiguration>
    <IntelligentTieringConfiguration>
        <Id></Id>
        <Status></Status>
        <Filter>
            <And>
                <Prefix>string</Prefix>
                <Tag>
                    <Key>string</Key>
                    <Value>string</Value>
                </Tag>
                <Tag>
                    <Key>string</Key>
                    <Value>string</Value>
                </Tag>
            </And>
        </Filter>
        <Tiering>
            <AccessTier>ARCHIVE_ACCESS</AccessTier>
            <Days></Days>
        </Tiering>
        <Tiering>
            <AccessTier>DEEP_ARCHIVE_ACCESS</AccessTier>
            <Days></Days>
        </Tiering>
    </IntelligentTieringConfiguration>
    <IntelligentTieringConfiguration>
        <Id></Id>
        <Status></Status>
        <Filter>
            <And>
                <Prefix>string</Prefix>
                <Tag>
                    <Key>string</Key>
                    <Value>string</Value>
                </Tag>
                <Tag>
                    <Key>string</Key>
                    <Value>string</Value>
                </Tag>
            </And>
        </Filter>
        <Tiering>
            <AccessTier>ARCHIVE_ACCESS</AccessTier>
            <Days></Days>
        </Tiering>
        <Tiering>
            <AccessTier>DEEP_ARCHIVE_ACCESS</AccessTier>
            <Days></Days>
        </Tiering>
    </IntelligentTieringConfiguration>
</ListBucketIntelligentTieringConfigurationOutput>
The nodes are described as follows:
Name
Parent Node
Description
Type
ListBucketIntelligentTieringConfigurationOutput
No
List of all intelligent tiering configuration rules in the bucket
Container
IntelligentTieringConfiguration
ListBucketIntelligentTieringConfigurationOutput
Detailed information on intelligent tiering configuration, see the XML structure in
Container

Error code

This API adheres to standardized error responses and codes. For more details, see the Error Codes document.

Real-world case

Request

The following request example demonstrates how to obtain intelligent tiering configuration rules from bucket examplebucket-1250000000.
GET /?intelligent-tiering HTTP/1.1
Date: Mon, 28 Aug 2018 02:53:38 GMT
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1503895278;1503895638&q-key-time=1503895278;1503895638&q-header-list=host&q-url-param-list=inventory&q-signature=****************************************
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com

Response

After the request, COS returns the following response, indicating that there are currently the low-frequency tier rule default, and archiving and deep archive tier rules rule1 and rule2 within this bucket.
Low-frequency rule default
After 30 consecutive days without access, objects in intelligent tiering move from the frequent access tier to the infrequent access tier.
Archiving and deep archiving tier rules rule1
Effective for intelligent tiering objects in bucket examplebucket-1250000000, with the prefix folder1.
After 100 consecutive days without access, intelligent tiering objects move from the infrequent access tier to the archive tier.
After 200 consecutive days without access, intelligent tiering objects move from the archive tier to the deep archive tier.
Archiving and deep archiving tier rules rule2
Effective for intelligent tiering objects with the prefix folder2 in the bucket examplebucket-1250000000.
After 91 consecutive days without access, intelligent tiering objects move from the infrequent access tier to the archive tier.
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 331
Date: Mon, 28 Aug 2018 02:53:39 GMT
Server: tencent-cos
x-cos-request-id: NTlhMzg1ZWVfMjQ4OGY3MGFfMWE1NF8****

<ListBucketIntelligentTieringConfigurationOutput>
    <IntelligentTieringConfiguration>
        <Id>default</Id>
        <Status>Enabled</Status>
        <Tiering>
            <AccessTier>INFREQUENT</AccessTier>
            <Days>30</Days>
            <RequestFrequent>1</RequestFrequent>
        </Tiering>
    </IntelligentTieringConfiguration>
    <IntelligentTieringConfiguration>
        <Id>rule1</Id>
        <Status>Enabled</Status>
        <Filter>
            <Prefix>folder1</Prefix>
        </Filter>
        <Tiering>
            <AccessTier>ARCHIVE_ACCESS</AccessTier>
            <Days>100</Days>
        </Tiering>
        <Tiering>
            <AccessTier>DEEP_ARCHIVE_ACCESS</AccessTier>
            <Days>200</Days>
        </Tiering>
    </IntelligentTieringConfiguration>
    <IntelligentTieringConfiguration>
        <Id>rule2</Id>
        <Status>Enabled</Status>
        <Filter>
            <Prefix>folder2</Prefix>
        </Filter>
        <Tiering>
            <AccessTier>ARCHIVE_ACCESS</AccessTier>
            <Days>91</Days>
        </Tiering>
    </IntelligentTieringConfiguration>
</ListBucketIntelligentTieringConfigurationOutput>


Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon