Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

ListUploads method

Written by
Updated at September 30, 2024

Returns a list of current multipart uploads.

The response may not contain more than 1,000 elements. If there are more uploads, Object Storage will return the IsTruncated element, as well as the NextKeyMarker and NextUploadIdMarker elements to use for the key-marker and upload-id-marker parameters of a subsequent request.

For more information on getting started with the API and the general request format, see How to use the S3 API.

Request

GET /{bucket}?uploads HTTP/2

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 delimiter. The user will see a list of files and folders in the root of the bucket. Files will be output in the Uploads elements, and folders, in the CommonPrefixes elements.

If the request also specifies the prefix parameter, Object Storage will return the list of files and folders in the folder named prefix.
max-uploads Maximum number of uploads in a response.

By default, Object Storage outputs no more than 1,000 keys. Use this parameter if you need less than 1,000 keys in a single response.

If the selection criteria are met by more keys than can fit into the output, the response contains <IsTruncated>true</IsTruncated>.

To get all output objects if their number exceeds max-keys, run multiple 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. The output begins with the key that follows the one specified in the parameter value.

Use it along with upload-id-marker for output filtering.

If upload-id-marker is specified, the output also contains key-marker.
prefix String to start the key from.

Object Storage selects only those keys which start with prefix.
upload-id-marker Upload ID.

The first upload in the output is the one whose ID follows the upload specified in this parameter. The key-marker parameter is used in processing, i.e., the output includes uploads filtered by both upload-id-marker and key-marker.

If key-marker is not specified, upload-id-marker is ignored.
uploads Flag indicating the multipart upload operation.

Headers

Use the appropriate common headers in your request.

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>0005B466********</NextUploadIdMarker>
  <MaxUploads>3</MaxUploads>
  <IsTruncated>true</IsTruncated>
  <Upload>
    <Key>my-divisor</Key>
    <UploadId>0005B465********</UploadId>
    <Initiator>
      <ID>ajeanexa********</ID>
      <DisplayName>ajeanexa********</DisplayName>
    </Initiator>
    <Owner>
      <ID>aje2v5og9qpl********</ID>
      <DisplayName>aje2v5og9qplr6pe0c59</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2020-11-18T17:33:46.007Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-movie.m2ts</Key>
    <UploadId>0005B465********</UploadId>
    <Initiator>
      <ID>ajeanexa********</ID>
      <DisplayName>ajeanexampleuser</DisplayName>
    </Initiator>
    <Owner>
      <ID>aje2v5og9qpl********</ID>
      <DisplayName>aje2v5og9qplr6pe0c59</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2020-11-18T18:34:47.017Z</Initiated>
  </Upload>
  <Upload>
    <Key>my-movie.m2ts</Key>
    <UploadId>0005B466********</UploadId>
    <Initiator>
      <ID>ajeanexa********</ID>
      <DisplayName>ajeanexa********</DisplayName>
    </Initiator>
    <Owner>
      <ID>aje2v5og9qpl********</ID>
      <DisplayName>aje2v5og9qplr6pe0c59</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
    <Initiated>2020-11-18T18:35:41.231Z</Initiated>
  </Upload>
</ListMultipartUploadsResult>
Tag Description
ListMultipartUploadsResult Response root tag.

Path: /ListMultipartUploadsResult.
Bucket Bucket 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.

The first upload in the output is the one whose ID follows the upload specified in this parameter.

See the upload-id-​marker request parameter description.

Path: /ListMultipartUploadsResult/UploadIdMarker.
NextKeyMarker Key.

If the output fails to include all the elements the user should get, use this value in the key-marker parameter for subsequent requests.

It appears if there are more elements than the response returns.

Path: /ListMultipartUploadsResult/NextKeyMarker.
NextUploadIdMarker Upload ID.

If the output fails to include all the elements the user should get, use this value in the upload-id-marker parameter for subsequent requests.

It appears if there are more elements than the response returns.

Path: /ListMultipartUploadsResult/NextUploadMarker.
Encoding-Type Encoding used by Object Storage to provide a key in an XML response.>
See the encoding-type request parameter description.

Path: /ListMultipartUploadsResult/Encoding-Type.
MaxUploads Maximum list size per response.

See the max-uploads request parameter.

Path: /ListMultipartUploadsResult/MaxUploads.
IsTruncated Marker indicating that a list is incomplete.

If IsTruncated is true, this means Object Storage returned an incomplete list of uploads.

Path: /ListMultipartUploadsResult/IsTruncated.
Upload Upload description.

Path: /ListMultipartUploadsResult/Upload.
Key Target upload object key.

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 Displayed user name.

Possible paths:
- /ListMultipartUploadsResult/Upload/Initiator/DisplayName
Owner Information about the object owner, matches Initiator.

Path: /ListMultipartUploadsResult/Owner.
StorageClass Object storage class: STANDARD, COLD, or ICE.

Path: /ListMultipartUploadsResult/Upload/StorageClass.
Initiated Date and time of the request for starting multipart upload.
/ListMultipartUploadsResult/Prefix Key prefix.

See the prefix request parameter.

Path: /ListMultipartUploadsResult/Prefix.
Delimiter Delimiter character used when generating output.

See the delimiter request parameter description.

Path: /ListMultipartUploadsResult/Delimiter.
CommonPrefixes It contains the Prefix element.

Path: /ListMultipartUploadsResult/CommonPrefixes.
CommonPrefixes/Prefix Key name part identified when processing the delimiter and prefix request parameters.

Path: /ListMultipartUploadsResult/CommonPrefixes/Prefix.

See also

Previous
completeUpload
Next
All methods