List Multipart Uploads

Last Updated: Mar 21, 2017

The List Multipart Uploads interface can be used to list all Multipart Upload events in execution, that is, Multipart Upload events that have been initiated but not completed or aborted. The listing result returned by the OSS contains a maximum of 1000 Multipart Upload messages. If you want to specify the number of Multipart Upload messages in the listing result returned by the OSS, you can add the max-uploads parameter to the request. In addition, the IsTruncated element in the listing result returned by the OSS indicates whether there are other Multipart Upload messages.

Request syntax

  1. Get /?uploads HTTP/1.1
  2. Host: BucketName.oss-cn-hangzhou.aliyuncs.com
  3. Date: GMT Date
  4. Authorization: Signature

Request parameters

Name Description
delimiter A character used to group object names. All those objects whose names contain the specified prefix and behind which the delimiter occurs for the first time act as a group of elements - CommonPrefixes.
Type: string
max-uploads Specify the maximum number of multipart upload tasks returned for one request. If this parameter is not specified, the default value 1,000 is used. The max-uploads value cannot exceed 1,000.
Type: string
key-marker Used together with the upload-id-marker parameter to specify the starting position of the returned result. l If the upload-id-marker parameter is not set, the query result includes Multipart tasks in which the lexicographic orders of all object names are greater than the value of the key-marker parameter. l If the upload-id-marker parameter is set, the query result includes Multipart tasks in which the lexicographic orders of all object names are greater than the value of the key-marker parameter and all Multipart Upload tasks in which the object names are the same as the value of the key-marker parameter but the Upload IDs are greater than the value of the upload-id-marker parameter.
Type: string
prefix Limit that the returned object key must be prefixed accordingly. Note that the keys returned from queries using a prefix will still contain the prefix.
Type: string
upload-id-marker Used together with the key-marker parameter to specify the starting position of the returned result. If the key-marker parameter is not set, the OSS ignores the upload-id-marker parameter. l If the key-marker parameter is set, the query result includes Multipart tasks in which the lexicographic orders of all object names are greater than the value of the key-marker parameter and all Multipart Upload tasks in which the object names are the same as the value of the key-marker parameter but the Upload IDs are greater than the value of the upload-id-marker parameter.
Type: string
encoding-type Specify the encoding of the returned content and the encoding type. Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key use UTF-8 characters, but the XML 1.0 Standard does not support parsing certain control characters, such as characters with ASCII values ranging from 0 to 10. If some elements in the returned results contain control characters that are not supported by the XML 1.0 Standard, encoding-type can be specified to encode these elements, such as Delimiter, KeyMarker, Prefix, NextMarker, and Key.
Data type: string
Default value: none

Response elements

Name Description
ListMultipartUploadsResult The container that saves the result of the List Multipart Upload request.
Type: container
Sub-nodes: Bucket, KeyMarker, UploadIdMarker, NextKeyMarker, NextUploadIdMarker, MasUploads, Delimiter, Prefix, CommonPrefixes, IsTruncated, Upload
Parent node: none
Bucket Specify the bucket name.
Type: string
Parent node: ListMultipartUploadsResult
EncodingType Specify the encoding type for the returned results. If encoding-type is specified in the request, those elements including Delimiter, KeyMarker, Prefix, NextKeyMarker and Key will be encoded in the returned result.
Type: string
Parent node: ListMultipartUploadsResult
KeyMarker Position of the starting object in the list.
Type: string
Parent node: ListMultipartUploadsResult
UploadIdMarker Position of the starting Upload ID in the list.
Type: string
Parent node: ListMultipartUploadsResult
NextKeyMarker If not all results are returned this time, the response request will include the NextKeyMarker element to indicate the value of KeyMarker in the next request.
Type: string
Parent node: ListMultipartUploadsResult
NextUploadMarker If not all results are returned this time, the response request will include the NextUploadMarker element to indicate the value of UploadMarker in the next request.
Type: string
Parent node: ListMultipartUploadsResult
MaxUploads The maximum upload number returned by the OSS.
Type: integer
Parent node: ListMultipartUploadsResult
IsTruncated Specify whether the returned Multipart Upload result list is truncated. The “true” indicates that not all results are returned; “false” indicates that all results are returned.
Type: enumerative string Valid values: false, true
Default value: false
Parent node: ListMultipartUploadsResult
Upload The container that saves the information about the Multipart Upload event.
Type: container
Sub-nodes: Key, UploadId, Initiated
Parent node: ListMultipartUploadsResult
Key Name of an object for which a Multipart Upload event is initiated.
Type: string
Parent node: Upload
UploadId ID of a Multipart Upload event.
Type: string
Parent node: Upload
Initiated Time when a Multipart Upload event is initiated.
Type: date
Parent node: Upload

Detail analysis

  • The maximum value of the “max-uploads” parameter is 1,000.
  • The results returned by the OSS are listed in ascending order based on the lexicographic orders of object names; for the same object, the results are listed in ascending time order.
  • Using the prefix parameter, you can flexibly manage objects in a bucket in groups (similar to the folder function).
  • The List Multipart Uploads request supports five request parameters: prefix, marker, delimiter, upload-id-marker, and max-keys. Based on the combinations of these parameters, you can set rules for querying Multipart Uploads events to obtain the desired query results.

Example

Request example:

  1. Get /?uploads HTTP/1.1
  2. Host:oss-example. oss-cn-hangzhou.aliyuncs.com
  3. Date: Thu, 23 Feb 2012 06:14:27 GMT
  4. Authorization: OSS qn6qrrqxo2oawuk53otfjbyc:JX75CtQqsmBBz+dcivn7kwBMvOY=

Response example:

  1. HTTP/1.1 200
  2. Server: AliyunOSS
  3. Connection: keep-alive
  4. Content-length: 1839
  5. Content-type: application/xml
  6. x-oss-request-id: 58a41847-3d93-1905-20db-ba6f561ce67a
  7. Date: Thu, 23 Feb 2012 06:14:27 GMT
  8. <?xml version="1.0" encoding="UTF-8"?>
  9. <ListMultipartUploadsResult xmlns=”http://doc.oss-cn-hangzhou.aliyuncs.com”>
  10. <Bucket>oss-example</Bucket>
  11. <KeyMarker></KeyMarker>
  12. <UploadIdMarker></UploadIdMarker>
  13. <NextKeyMarker>oss.avi</NextKeyMarker>
  14. <NextUploadIdMarker>0004B99B8E707874FC2D692FA5D77D3F</NextUploadIdMarker>
  15. <Delimiter></Delimiter>
  16. <Prefix></Prefix>
  17. <MaxUploads>1000</MaxUploads>
  18. <IsTruncated>false</IsTruncated>
  19. <Upload>
  20. <Key>multipart.data</Key>
  21. <UploadId>0004B999EF518A1FE585B0C9360DC4C8</UploadId>
  22. <Initiated>2012-02-23T04:18:23.000Z</Initiated>
  23. </Upload>
  24. <Upload>
  25. <Key>multipart.data</Key>
  26. <UploadId>0004B999EF5A239BB9138C6227D69F95</UploadId>
  27. <Initiated>2012-02-23T04:18:23.000Z</Initiated>
  28. </Upload>
  29. <Upload>
  30. <Key>oss.avi</Key>
  31. <UploadId>0004B99B8E707874FC2D692FA5D77D3F</UploadId>
  32. <Initiated>2012-02-23T06:14:27.000Z</Initiated>
  33. </Upload>
  34. </ListMultipartUploadsResult>
Thank you! We've received your feedback.