Object Storage API, REST совместимый с Amazon S3: ListObjects
Возвращает список объектов в бакете.
Не возвращает содержимое объектов. Чтобы получить его, воспользуйтесь методом get.
При выдаче используется пагинация, за один запрос можно получить список не длиннее 1000 объектов. Если объектов больше, то необходимо выполнить несколько запросов подряд.
Примечание
У этого метода есть две версии:
listObjectsV2— актуальная версия, более удобная в использовании.listObjectsV1— предыдущая версия.
Для вызова обоих методов используется один и тот же URL, но он отличается query-параметром. Чтобы вызвать listObjectsV2, используйте параметр list-type=2.
Подробнее о подготовке к работе с API и общем виде запроса в разделе Как пользоваться S3 API.
listObjectsV2
Запрос
GET /{bucket}?list-type=2&continuation-token=ContinuationToken&delimiter=Delimiter&encoding-type=EncodingType&max-keys=MaxKeys&prefix=Prefix&start-after=StartAfter HTTP/2
Path параметры
|
Параметр |
Описание |
|
|
Имя бакета |
Query параметры
Все перечисленные в таблице параметры необязательные.
|
Параметр |
Описание |
|
|
Используется для получения следующей части списка, если все результаты не помещаются в один ответ. |
|
|
Символ-разделитель. Если параметр указан, то Object Storage рассматривает ключ как путь к файлу, где каталоги разделяются символом Если в запросе указан еще и параметр |
|
|
Кодировка ответа от сервера. Object Storage по требованию клиента может закодировать ответ в требуемом виде. Возможные значения: |
|
|
Максимальное количество элементов в ответе. По умолчанию Object Storage выдает не более 1000 элементов Если под критерии отбора попадает больше ключей, чем поместилось в выдаче, то ответ содержит Чтобы получить все элементы выдачи, если их больше |
|
|
Строка, с которой должен начинаться ключ. Object Storage выберет только те ключи, которые начинаются с Может использоваться одновременно с параметром |
|
|
Ключ, с которого нужно начать листинг. |
Заголовки
Используйте в запросе только общие заголовки.
Ответ
Заголовки
Ответ может содержать только общие заголовки.
Коды ответов
Перечень возможных ответов смотрите в разделе Ответы.
Успешный ответ содержит дополнительные данные в формате XML, схема которого описана ниже.
Схема данных
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<IsTruncated>boolean</IsTruncated>
<Contents>
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Size>integer</Size>
<StorageClass>string</StorageClass>
</Contents>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
<KeyCount>integer</KeyCount>
<ContinuationToken>string</ContinuationToken>
<NextContinuationToken>string</NextContinuationToken>
<StartAfter>string</StartAfter>
</ListBucketResult>
|
Элемент |
Описание |
|
|
Корневой элемент. |
|
|
Флаг, показывающий все ли результаты возвращены в этом ответе.
Путь: |
|
|
Описание объекта. Ответ будет содержать столько элементов Путь: |
|
|
MD5-хэш объекта. Метаданные в расчете хэша не участвуют. Путь: |
|
|
Ключ объекта. Путь: |
|
|
Дата и время последнего изменения объекта. Путь: |
|
|
Размер объекта в байтах. Путь: |
|
|
Класс хранилища объекта: Путь: |
|
|
Имя бакета. Путь: |
|
|
Значение query-параметра Путь: |
|
|
Значение query-параметра Путь: |
|
|
Значение query-параметра Путь: |
|
|
Часть имени ключа, которая определяется при обработке query-параметров Путь: |
|
|
Кодировка, в которой Object Storage представляет ключ в XML-ответе. Появляется, если клиент при запросе передал параметр Путь: |
|
|
Количество ключей, возвращенных запросом. Путь: |
|
|
Значение query-параметра Путь: |
|
|
Значение, которое надо подставить в query-параметр Путь: |
|
|
Значение query-параметра Путь: |
listObjectsV1
Запрос
GET /{bucket}?delimiter=Delimiter&encoding-type=EncodingType&marker=Marker&max-keys=MaxKeys&prefix=Prefix HTTP/2
Path параметры
|
Параметр |
Описание |
|
|
Имя бакета |
Query параметры
Все перечисленные в таблице параметры необязательные.
|
Параметр |
Описание |
|
|
Символ-разделитель. Если параметр указан, то Object Storage рассматривает ключ как путь к файлу, где каталоги разделяются символом Если в запросе указан еще и параметр |
|
|
Кодировка ответа от сервера. Object Storage по требованию клиента может закодировать ответ в требуемом виде. Возможные значения: |
|
|
Ключ, с которого начнется выдача. В результирующей выдаче Object Storage оставит ключи, начиная со следующего за |
|
|
Максимальное количество элементов в ответе. По умолчанию Object Storage выдает не более 1000 элементов Если под критерии отбора попадает больше ключей, чем поместилось в выдаче, то ответ содержит Чтобы получить все элементы выдачи, если их больше |
|
|
Строка, с которой должен начинаться ключ. Object Storage выберет только те ключи, которые начинаются с Может использоваться одновременно с параметром |
Заголовки
Используйте в запросе только общие заголовки.
Ответ
Заголовки
Ответ может содержать только общие заголовки.
Коды ответов
Перечень возможных ответов смотрите в разделе Ответы.
Успешный ответ содержит дополнительные данные в формате XML, схема которого описана ниже.
Схема данных
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<IsTruncated>boolean</IsTruncated>
<Marker>string</Marker>
<NextMarker>string</NextMarker>
<Contents>
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Size>integer</Size>
<StorageClass>string</StorageClass>
</Contents>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
</ListBucketResult>
|
Элемент |
Описание |
|
|
Корневой элемент. |
|
|
Флаг, показывающий все ли результаты возвращены в этом ответе.
Путь: |
|
|
Значение query-параметра Путь: |
|
|
Значение, которое надо подставить в query-параметр Путь: |
|
|
Описание объекта. Ответ будет содержать столько элементов Путь: |
|
|
MD5-хэш объекта. Метаданные в расчете хэша не участвуют. Путь: |
|
|
Ключ объекта. Путь: |
|
|
Дата и время последнего изменения объекта. Путь: |
|
|
Размер объекта в байтах. Путь: |
|
|
Класс хранилища объекта: Путь: |
|
|
Имя бакета. Путь: |
|
|
Значение query-параметра Путь: |
|
|
Значение query-параметра Путь: |
|
|
Значение query-параметра Путь: |
|
|
Часть имени ключа, которая определяется при обработке query-параметров Путь: |
|
|
Кодировка, в которой Object Storage представляет ключ в XML-ответе. Появляется, если клиент при запросе передал параметр Путь: |