Подключиться
Yandex Object Storage

Метод listUploads

Статья создана

Возвращает список текущих составных загрузок.

Ответ не может содержать более 1000 элементов. Если загрузок больше, то Object Storage возвращает элемент IsTruncated, а также элементы NextKeyMarker и NextUploadIdMarker, которые необходимо использовать для параметров key-marker и upload-id-​marker последующего запроса.

Запрос

GET /{bucket}?uploads HTTP/2

Path параметры

Параметр Описание
bucket Имя бакета.

Query параметры

Параметр Описание
delimiter Символ-разделитель.

Если параметр указан, то Object Storage рассматривает ключ как путь к файлу, где имена каталогов разделяются символом delimiter. На выходе пользователь увидит перечень файлов и каталогов в корне бакета. Файлы будут выведены в элементах Uploads, а каталоги в элементах CommonPrefixes.

Если в запросе указан еще и параметр prefix, то Object Storage вернет перечень файлов и каталогов в каталогеprefix.
max-uploads Максимальное количество загрузок в ответе.

По умолчанию Object Storage выдает не более 1000 ключей. Этот параметр следует использовать, если вам нужно получать менее 1000 ключей в одном ответе.

Если под критерии отбора попадает больше ключей, чем поместилось в выдаче, то ответ содержит <IsTruncated>true</IsTruncated>.

Чтобы получить все объекты выдачи, если их больше max-keys, необходимо выполнить несколько последовательных запросов к Object Storage с параметром key-marker, где для каждого запроса key-marker равен значению элемента NextKeyMarker предыдущего ответа.
key-marker Ключ. Выдача начнется с ключа, следующего за указанным в значении параметра.

Используется вместе с upload-id-marker для фильтрации выдачи.

Если upload-id-marker указан, то в выдачу попадет и key-marker тоже.
prefix Строка, с которой должен начинаться ключ.

Object Storage выберет только те ключи, которые начинаются с prefix.
upload-id-​marker Идентификатор загрузки.

Выдача начнется с той загрузки, идентификатор которой следует за указанной в параметре. При обработке учитывается key-marker, т.е. в выдачу попадут те загрузки для которых пересекутся фильтр по upload-id-​marker и фильтр по key-marker.

Если key-marker не указан, то upload-id-​marker игнорируется.
uploads Флаг, обозначающий операцию составной загрузки.

Заголовки

Используйте в запросе необходимые общие заголовки.

Ответ

Заголовки

Ответ может содержать только общие заголовки.

Коды ответов

Перечень возможных ответов смотрите в разделе Ответы.

Успешный ответ содержит дополнительные данные в формате XML, схема которого описана ниже.

Схема данных

<ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Bucket>bucket</Bucket>
  <KeyMarker></KeyMarker>
  <UploadIdMarker></UploadIdMarker>
  <NextKeyMarker>my-movie.m2ts</NextKeyMarker>
  <NextUploadIdMarker>0005B4661731B011</NextUploadIdMarker>
  <MaxUploads>3</MaxUploads>
  <IsTruncated>true</IsTruncated>
  <Upload>
    <Key>my-divisor</Key>
    <UploadId>0005B46503714F29</UploadId>
    <Initiator>
      <ID>ajeanexampleuser</ID>
      <DisplayName>ajeanexampleuser</DisplayName>
    </Initiator>
    <Owner>
      <ID>aje2v5og9qplr6pe0c59</ID>
      <DisplayName>aje2v5og9qplr6pe0c59</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2020-11-18T17:33:46.007Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-movie.m2ts</Key>
    <UploadId>0005B46508244E72</UploadId>
    <Initiator>
      <ID>ajeanexampleuser</ID>
      <DisplayName>ajeanexampleuser</DisplayName>
    </Initiator>
    <Owner>
      <ID>aje2v5og9qplr6pe0c59</ID>
      <DisplayName>aje2v5og9qplr6pe0c59</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2020-11-18T18:34:47.017Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-movie.m2ts</Key>
    <UploadId>0005B4661731B011</UploadId>
    <Initiator>
      <ID>ajeanexampleuser</ID>
      <DisplayName>ajeanexampleuser</DisplayName>
    </Initiator>
    <Owner>
      <ID>aje2v5og9qplr6pe0c59</ID>
      <DisplayName>aje2v5og9qplr6pe0c59</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2020-11-18T18:35:41.231Z</Initiated>
  </Upload>
</ListMultipartUploadsResult>
Тег Описание
ListMultipartUploadsResult Корневой тег ответа.

Путь: /ListMultipartUploadsResult.
Bucket Бакет, к которому относится составная загрузка.

Путь: /ListMultipartUploadsResult/Bucket.
KeyMarker Ключ.

Выдача начинается с ключа, следующего за указанным в значении элемента.

Смотрите описание параметра запроса key-marker.

Путь: /ListMultipartUploadsResult/KeyMarker.
UploadIdMarker Идентификатор загрузки.

Выдача начнется с той загрузки, идентификатор которой следует за указанной в параметре.

Смотрите описание параметра запроса upload-id-​marker.

Путь: /ListMultipartUploadsResult/UploadIdMarker.
NextKeyMarker Ключ.

Если выдача не вместила все элементы, которые должен получить пользователь, то это значение необходимо использовать в параметре key-marker для последующих запросов.

Присутствует в случае, когда в ответ не поместился все элементы.

Путь: /ListMultipartUploadsResult/NextKeyMarker.
NextUploadIdMarker Идентификатор загрузки.

Если выдача не вместила все элементы, которые должен получить пользователь, то это значение необходимо использовать в параметре upload-id-marker для последующих запросов.

Присутствует в случае, когда в ответ не поместились все элементы.

Путь: /ListMultipartUploadsResult/NextUploadMarker.
Encoding-Type Кодировка, в которой Object Storage представляет ключ в XML-ответе.

Смотрите описание параметра запроса encoding-type.

Путь: /ListMultipartUploadsResult/Encoding-Type.
MaxUploads Максимальная длина списка для одного ответа.

Смотрите параметр запроса max-uploads.

Путь: /ListMultipartUploadsResult/MaxUploads.
IsTruncated Признак неполноты списка.

Если IsTruncated — true, то это означает, что Object Storage вернуло не полный список загрузок.

Путь: /ListMultipartUploadsResult/IsTruncated.
Upload Описание загрузки.

Путь: /ListMultipartUploadsResult/Upload.
Key Ключ конечного объекта загрузки.

Путь: /ListMultipartUploadsResult/Upload/Key.
UploadId Идентификатор составной загрузки.

Путь: /ListMultipartUploadsResult/Upload/UploadId.
Initiator Инициатор составной загрузки.

Путь: /ListMultipartUploadsResult/Upload/Initiator.
ID Идентификатор пользователя.

Возможные пути:
- /ListMultipartUploadsResult/Upload/Initiator/ID
DisplayName Отображаемое имя пользователя.

Возможные пути:
- /ListMultipartUploadsResult/Upload/Initiator/DisplayName
Owner Информация о владельце объекта, совпадает с Initiator.

Путь: /ListMultipartUploadsResult/Owner.
StorageClass Класс хранения объекта: STANDARD или COLD.

Путь: /ListMultipartUploadsResult/Upload/StorageClass.
Initiated Дата и время запроса на начало составной загрузки.
/ListMultipartUploadsResult/Prefix Префикс ключа.

Смотрите параметр запроса prefix.

Путь: /ListMultipartUploadsResult/Prefix.
Delimiter Символ-разделитель, который использовался при формировании выдачи.

Смотрите описание параметра запроса delimiter.

Путь: /ListMultipartUploadsResult/Delimiter.
CommonPrefixes Содержит элемент Prefix.

Путь: /ListMultipartUploadsResult/CommonPrefixes.
CommonPrefixes/Prefix Часть имени ключа, которая определяется при обработке параметров запроса delimiter и prefix.

Путь: /ListMultipartUploadsResult/CommonPrefixes/Prefix.
В этой статье: