Knowledge base

Get Bucket

Returns a list of bucket objects.

GET /?max-keys=25 HTTP/1.1
Host: Host: {bucket}.{region}.cdn77-storage.com

Parameters

ParameterDescription
prefixstring

Only returns objects that contain the specified prefix.

delimiterstring

The delimiter between the prefix and the rest of the object name.

markerstring

A beginning index for the list of objects returned.

max-keysinteger

The maximum number of keys to return. Default is 1000.

allow-unorderedboolean

Non-standard extension. Allows results to be returned unordered. Cannot be used with delimiter.

HTTP Response

HTTP CodeDescription
200none

OK - Bucket retrieved

404none

NoSuchBucket - No bucket by that name under your account.

Bucket Response Entities

NameDescription
ListBucketResultnone

The container for the list of objects.

Namestring

The name of the bucket whose contents will be returned.

Prefixstring

A prefix for the object keys.

Markerstring

A beginning index for the list of objects returned.

MaxKeysinteger

The maximum number of keys returned.

Delimiterstring

If set, objects with the same prefix will appear in the CommonPrefixes list.

IsTruncatedboolean

If true, only a subset of the bucket's contents were returned.

CommonPrefixesnone

If multiple objects contain the same prefix, they will appear in this container.

Object Response Entities

The ListBucketResult contains objects, where each object is within a Contents container.

NameDescription
Contentsnone

A container for the object.

Keystring

The object's key.

LastModifiednone

The object's last-modified date/time.

ETagstring

An MD-5 hash of the object. (entity tag)

Sizeinteger

The object's size.

StorageClassstring

Should always return STANDARD.

Typestring

Appendable or Normal.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
    <Name>mypictures</Name>
    <Prefix></Prefix>
    <MaxKeys>25</MaxKeys>
    <IsTruncated>false</IsTruncated>
    <Contents>
        <Key>Flowers/</Key>
        <LastModified>2023-03-20T14:05:47.832Z</LastModified>
        <ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag>
        <Size>0</Size>
        <StorageClass>STANDARD</StorageClass>
        <Owner>
            <ID>946570e-8532-4f3b-af51-9ak7f650d6c2</ID>
            <DisplayName>John Smith</DisplayName>
        </Owner>
        <Type>Normal</Type>
    </Contents>
    <Contents>
        <Key>Flowers/cover.jpg</Key>
        <LastModified>2023-03-20T14:07:26.605Z</LastModified>
        <ETag>&quot;a5a35333ad675a15fe03b9b939e55975&quot;</ETag>
        <Size>58292</Size>
        <StorageClass>STANDARD</StorageClass>
        <Owner>
            <ID>946570e-8532-4f3b-af51-9ak7f650d6c2</ID>
            <DisplayName>John Smith</DisplayName>
        </Owner>
        <Type>Normal</Type>
    </Contents>
    <Contents>
        <Key>wow2.png</Key>
        <LastModified>2023-03-21T10:52:44.237Z</LastModified>
        <ETag>&quot;8b022b20c5dda80dbea3e23b3bd7c61c&quot;</ETag>
        <Size>889608</Size>
        <StorageClass>STANDARD</StorageClass>
        <Owner>
            <ID>946570e-8532-4f3b-af51-9ak7f650d6c2</ID>
            <DisplayName>John Smith</DisplayName>
        </Owner>
        <Type>Normal</Type>
    </Contents>
    <Marker></Marker>
</ListBucketResult>

Updated on 10th September, 2024

Can’t find what you are looking for?