listUploads method

Written by

Request
Response

Returns a list of current multipart uploads.

The response may contain no more than 1,000 elements. If there are more uploads, Object Storage returns the IsTruncated element and the NextKeyMarker and NextUploadIdMarker elements to be used for the key-marker and upload-id-marker parameters of a subsequent request.

Request

GET /{bucket}?uploads HTTP/1.1

Path parameters

Parameter	Description
`bucket`	Bucket name.

Query parameters

Parameter	Description
`delimiter`	Delimiter character. If this parameter is specified, Object Storage interprets the key as the path to the file with folder names separated by the `delimiter` character. The user gets a list of files and folders in the root of the bucket. Files are output in the `Uploads` elements, and the folders in the `CommonPrefixes` elements. If the request also specifies the `prefix` parameter, Object Storage returns the a of files and folders in the `prefix` folder.
`max-uploads`	Maximum number of uploads in a response. By default, Object Storage outputs a maximum of 1000 keys. This parameter should be used if you need to get less than 1000 keys in a single response. If the number of keys meeting the selection criteria is greater than the number that could fit in the output, the response contains `<IsTruncated>true</IsTruncated>`. To get all output objects if their number exceeds the `max-keys` value, make several consecutive requests to Object Storage with the `key-marker` parameter, where the `key-marker` of each request is equal to the value of the `NextKeyMarker` element in the previous response.
`key-marker`	Key. Output begins with the key that follows the one specified in the parameter value. Use it together with the `upload-id-marker` for output filtering. If the `upload-id-marker` is specified, then the output also contains the `key-marker`.
`prefix`	String to start the key from. Object Storage selects only those keys that start with `prefix`.
`upload-id-marker`	Upload ID. Output begins with the upload whose ID follows the one specified in the parameter value. The `key-marker` value is processed, meaning that the output contains the uploads that match filtering by both `upload-id-marker` and `key-marker`. If no`key-marker` is specified, the `upload-id-marker` is ignored.
`uploads`	Flag indicating a multipart upload operation.

Headers

Use the necessary common request headers in requests.

Response

Headers

Responses can only contain common response headers.

Response codes

For a list of possible responses, see Responses.

A successful response contains additional data in XML format with the schema described below.

Data schema

<ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Bucket>bucket</Bucket>
  <KeyMarker></KeyMarker>
  <UploadIdMarker></UploadIdMarker>
  <NextKeyMarker>my-movie.m2ts</NextKeyMarker>
  <NextUploadIdMarker>YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ</NextUploadIdMarker>
  <MaxUploads>3</MaxUploads>
  <IsTruncated>true</IsTruncated>
  <Upload>
    <Key>my-divisor</Key>
    <UploadId>XMgbGlrZSBlbHZpbmcncyBub3QgaGF2aW5nIG11Y2ggbHVjaw</UploadId>
    <Initiator>
      <ID>arn:aws:iam::111122223333:user/user1-11111a31-17b5-4fb7-9df5-b111111f13de</ID>
      <DisplayName>user1-11111a31-17b5-4fb7-9df5-b111111f13de</DisplayName>
    </Initiator>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2010-11-10T20:48:33.000Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-movie.m2ts</Key>
    <UploadId>VXBsb2FkIElEIGZvciBlbHZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>
    <Initiator>
      <ID>b1d16700c70b0b05597d7acd6a3f92be</ID>
      <DisplayName>InitiatorDisplayName</DisplayName>
    </Initiator>
    <StorageClass>COLD</StorageClass>
    <Initiated>2010-11-10T20:48:33.000Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-movie.m2ts</Key>
    <UploadId>YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ</UploadId>
    <Initiator>
      <ID>arn:aws:iam::444455556666:user/user1-22222a31-17b5-4fb7-9df5-b222222f13de</ID>
      <DisplayName>user1-22222a31-17b5-4fb7-9df5-b222222f13de</DisplayName>
    </Initiator>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2010-11-10T20:49:33.000Z</Initiated>
  </Upload>
</ListMultipartUploadsResult>

Tag	Description
`ListMultipartUploadsResult`	Root tag for the response. Path: `/ListMultipartUploadsResult`.
`Bucket`	The bucket that the multipart upload belongs to. Path: `/ListMultipartUploadsResult/Bucket`.
`KeyMarker`	Key. The output begins with the key that follows the one specified in the element value. See the `key-marker` request parameter description. Path: `/ListMultipartUploadsResult/KeyMarker`.
`UploadIdMarker`	Upload ID. Output begins with the upload whose ID follows the one specified in the parameter value. See the `upload-id-marker` parameter description. Path: `/ListMultipartUploadsResult/UploadIdMarker`.
`NextKeyMarker`	Key. If the output failed to include all the elements the user should have received, this value is to be used in the `key-marker` parameter for subsequent requests. Present if some of the elements do not fit in the response. Path: `/ListMultipartUploadsResult/NextKeyMarker`.
`NextUploadIdMarker`	Upload ID. If the output failed to include all the elements the user should have received, this value is to be used in the `upload-id-marker` parameter for subsequent requests. Present if some of the elements do not fit in the response. Path: `/ListMultipartUploadsResult/NextUploadMarker`.
`Encoding-Type`	Encoding in which Object Storage provides a key in an XML response. See the `encoding-type` request parameter description. Path: `/ListMultipartUploadsResult/Encoding-Type`.
`MaxUploads`	Maximum list length for a single response. See the `max-uploads` request parameter description. Path: `/ListMultipartUploadsResult/MaxUploads`.
`IsTruncated`	Flag indicating that a list is incomplete. If `IsTruncated` is `true`, this means that Object Storage returned an incomplete list of uploads. Path: `/ListMultipartUploadsResult/IsTruncated`.
`Upload`	Upload description. Path: `/ListMultipartUploadsResult/Upload`.
`Key`	Key of the last upload object. Path: `/ListMultipartUploadsResult/Upload/Key`.
`UploadId`	Multipart upload ID. Path: `/ListMultipartUploadsResult/Upload/UploadId`.
`Initiator`	Multipart upload initiator. Path: `/ListMultipartUploadsResult/Upload/Initiator`.
`ID`	User ID. Possible paths: - `/ListMultipartUploadsResult/Upload/Initiator/ID`
`DisplayName`	User name displayed. Possible paths: - `/ListMultipartUploadsResult/Upload/Initiator/DisplayName`
`StorageClass`	Object storage class: `STANDARD` or `COLD`. Path: `/ListMultipartUploadsResult/Upload/StorageClass`.
`Initiated`	Date and time of the request for starting multipart upload.
`/ListMultipartUploadsResult/Prefix`	Key prefix. See the `prefix` request parameter description. Path: `/ListMultipartUploadsResult/Prefix`.
`Delimiter`	Delimiter character that was used when generating output. See the description of the `delimiter` request parameter. Path: `/ListMultipartUploadsResult/Delimiter`.
`CommonPrefixes`	Contains the `Prefix` element. Path: `/ListMultipartUploadsResult/CommonPrefixes`.
`CommonPrefixes/Prefix`	Part of the key name identified when processing the `delimiter` and `prefix` request parameters. Path: `/ListMultipartUploadsResult/CommonPrefixes/Prefix`.