Contact UsGet started
© 2024 Iron Hive LLC Belgrade

listParts method

Written by
Updated at September 30, 2024

Returns a list of already uploaded parts for the specified multipart upload.

The response may not contain more than 1,000 elements. If there are more parts in the multipart upload, Object Storage will return the IsTruncated marker and the NextPartNumberMarker element. You can get the remaining elements with consecutive requests where the part-number-marker parameter is set to NextPartNumberMarker from the previous 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}/{key}?uploadId=UploadId HTTP/2

Path parameters

Parameter Description
bucket Bucket name.
key Object key.

Query parameters

You can change a response from Object Storage using the parameters described in the table below.

Parameter Description
encoding-type Encoding of server response.

Object Storage can encode responses in the format requested by the client.
max-parts Maximum number of elements in a response per request.

The default value is 1,000.
part-number-marker Number of the part to start a response from.

Object Storage will only include in the response the parts whose numbers are greater than the one specified.
uploadId ID of multipart upload.

Only the uploadId parameter is required.

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

<ListPartsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Bucket>example-bucket</Bucket>
  <Key>example-object</Key>
  <UploadId>0005B465********</UploadId>
  <Initiator>
      <ID>ajeanexa********</ID>
      <DisplayName>ajeanexampleuser</DisplayName>
  </Initiator>
  <Owner>
      <ID>ajeanexa********</ID>
      <DisplayName>ajeanexampleuser</DisplayName>
  </Owner>
  <StorageClass>STANDARD</StorageClass>
  <PartNumberMarker>0</PartNumberMarker>
  <NextPartNumberMarker>2</NextPartNumberMarker>
  <MaxParts>2</MaxParts>
  <IsTruncated>true</IsTruncated>
  <Part>
    <PartNumber>1</PartNumber>
    <LastModified>2020-11-18T17:33:46.787Z</LastModified>
    <ETag>"1430884b802ee5206cbe0ca0cf9b73d4"</ETag>
    <Size>8388608</Size>
  </Part>
  <Part>
    <PartNumber>2</PartNumber>
    <LastModified>2020-11-18T17:33:46.812Z</LastModified>
    <ETag>"449aa7eaff2e841923b0da9ff2be5946"</ETag>
    <Size>8388608</Size>
  </Part>
</ListPartsResult>

Possible response tags are described in the table below.

Tag Description
ListPartsResult Root element of response.

Path: /ListPartsResult.
Bucket Bucket the multipart upload belongs to.

Path: /ListPartsResult/Bucket.
Encoding-Type Encoding used by Object Storage to provide a key in an XML response.

You will get this tag if the client provided the encoding-type parameter in the request.

Path: /ListPartsResult/Encoding-Type.
Key Key the multipart upload is performed for.

Path: /ListPartsResult/Key.
UploadId Multipart upload ID.

Path: /ListPartsResult/UploadId.
Initiator Information about the user who initiated the upload.

Path: /ListPartsResult/Initiator.
ID User ID.

Path: /ListPartsResult/Initiator/ID.
DisplayName Displayed user name.

Path: /ListPartsResult/Initiator/DisplayName.
Owner Information about the object owner, matches Initiator.

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

Path: /ListPartsResult/StorageClass.
PartNumberMarker Number of the part immediately preceeding the list.

The number of the first list item is the next one after PartNumberMarker.

Path: /ListPartsResult/PartNumberMarker.
NextPartNumberMarker Number of the part the list ends with.

You will get this tag if there are more parts than listed in the response.

Path: /ListPartsResult/NextPartNumberMarker.
MaxParts Maximum list size per response.

Path: /ListPartsResult/MaxParts.
IsTruncated Marker indicating that a list is incomplete.

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

Path: /ListPartsResult/IsTruncated.
Part Upload part description.

Path: /ListPartsResult/Part.
PartNumber Part number.

Unique integer ID that defines the position of a part in the upload.

Path: /ListPartsResult/Part/PartNumber.
LastModified Date and time when the part was uploaded.

Path: /ListPartsResult/Part/LastModified.
ETag ETag of the uploaded part.

Path: /ListPartsResult/Part/ETag.
Size Size of the uploaded part.

Path: /ListPartsResult/Part/Size.

See also

Previous
copyPart
Next
abortUpload