All Products
Search
Document Center

Object Storage Service:ListMultipartUploads

Last Updated:Feb 18, 2025

Use the ListMultipartUploads operation to retrieve a list of all ongoing Multipart Upload tasks that have been initialized but not yet completed or aborted.

Request syntax

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

Request parameters

Name

Type

Description

delimiter

String

The character used to group objects by name. Objects whose names contain the same string that ranges from the specified prefix to the delimiter that appears for the first time are grouped as a CommonPrefixes element.

max-uploads

Integer

The maximum number of Multipart Upload tasks that can be returned for the current request. Default value: 1000. Maximum value: 1000.

key-marker

String

This parameter is used together with the upload-id-marker parameter to specify the position from which the returned results start.

  • If the upload-id-marker parameter is not set, the query results include all Multipart Upload tasks whose object names are lexicographically greater than the value of the key-marker parameter.

  • If the upload-id-marker parameter is set, the query results include the following:

    • All Multipart Upload tasks whose object names are lexicographically greater than the value of the key-marker parameter.

    • Multipart Upload tasks whose object names are equal to the value of the key-marker parameter but whose UploadId is greater than the value of the upload-id-marker parameter.

prefix

String

The prefix that the names of returned objects must contain. Note that when you use the prefix to query, the returned keys still contain the prefix.

Note

You can flexibly use the prefix parameter to group and manage objects in a bucket (similar to the folder feature).

upload-id-marker

String

This parameter is used together with the key-marker parameter to specify the position from which the returned results start.

  • If the key-marker parameter is not set, OSS ignores the upload-id-marker parameter.

  • If the key-marker parameter is set, the query results include the following:

    • All Multipart Upload tasks whose object names are lexicographically greater than the value of the key-marker parameter.

    • Multipart Upload tasks whose object names are equal to the value of the key-marker parameter but whose UploadId is greater than the value of the upload-id-marker parameter.

encoding-type

String

Specifies the encoding type of the returned content. Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key use UTF-8 characters. However, the XML 1.0 standard does not support parsing some control characters, such as characters with ASCII values from 0 to 10. You can specify the encoding-type to encode the returned Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key that contain control characters not supported by the XML 1.0 standard.

Default value: none

Response elements

Name

Type

Description

ListMultipartUploadsResult

Container

The container that stores the response to the ListMultipartUpload request.

Child nodes: Bucket, KeyMarker, UploadIdMarker, NextKeyMarker, NextUploadIdMarker, MasUploads, Delimiter, Prefix, CommonPrefixes, IsTruncated, Upload

Parent node: None

Bucket

String

The name of the bucket.

Parent node: ListMultipartUploadsResult

EncodingType

String

The encoding type of the object names in the response. If the encoding-type is specified in the request parameters, the returned results will encode the Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key elements.

Parent node: ListMultipartUploadsResult

KeyMarker

String

The starting object position of the list.

Parent node: ListMultipartUploadsResult

UploadIdMarker

String

The starting UploadId position of the list.

Parent node: ListMultipartUploadsResult

NextKeyMarker

String

If not all results are returned this time, the response will contain the NextKeyMarker element, which indicates the KeyMarker value for the next request.

Parent node: ListMultipartUploadsResult

NextUploadMarker

String

If not all results are returned this time, the response will contain the NextUploadMarker element, which indicates the UploadMarker value for the next request.

Parent node: ListMultipartUploadsResult

MaxUploads

Integer

The maximum number of uploads returned.

Parent node: ListMultipartUploadsResult

IsTruncated

Enumerated string

Indicates whether the list of Multipart Upload results returned this time is truncated. The value range is as follows:

  • true: Not all results are returned this time.

  • false (default): All results are returned this time.

Parent node: ListMultipartUploadsResult

Upload

Container

The container that stores the information about multipart upload tasks.

Child nodes: Key, UploadId, Initiated

Parent node: ListMultipartUploadsResult

Key

String

The name of the object for which a multipart upload task was initiated.

Parent node: Upload

Note

The results returned by OSS are sorted in ascending lexicographic order by object name. For the same object, they are sorted in ascending lexicographic order by UploadId.

UploadId

String

The ID of the multipart upload task.

Parent node: Upload

Initiated

Date

The time when the multipart upload task was initiated.

Parent node: Upload

Examples

Request example

Get /?uploads  HTTP/1.1
Host:oss-example. oss-cn-hangzhou.aliyuncs.com
Date: Thu, 23 Feb 2012 06:14:27 GMT
Authorization: OSS qn6q**************:77Dv****************

Sample response

HTTP/1.1 200 
Server: AliyunOSS
Connection: keep-alive
Content-length: 1839
Content-type: application/xml
x-oss-request-id: 58a41847-3d93-1905-20db-ba6f561c****
Date: Thu, 23 Feb 2012 06:14:27 GMT

<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult xmlns="http://doc.oss-cn-hangzhou.aliyuncs.com">
    <Bucket>oss-example</Bucket>
    <KeyMarker></KeyMarker>
    <UploadIdMarker></UploadIdMarker>
    <NextKeyMarker>oss.avi</NextKeyMarker>
    <NextUploadIdMarker>0004B99B8E707874FC2D692FA5D77D3F</NextUploadIdMarker>
    <Delimiter></Delimiter>
    <Prefix></Prefix>
    <MaxUploads>1000</MaxUploads>
    <IsTruncated>false</IsTruncated>
    <Upload>
        <Key>multipart.data</Key>
        <UploadId>0004B999EF518A1FE585B0C9360DC4C8</UploadId>
        <Initiated>2012-02-23T04:18:23.000Z</Initiated>
    </Upload>
    <Upload>
        <Key>multipart.data</Key>
        <UploadId>0004B999EF5A239BB9138C6227D6****</UploadId>
        <Initiated>2012-02-23T04:18:23.000Z</Initiated>
    </Upload>
    <Upload>
        <Key>oss.avi</Key>
        <UploadId>0004B99B8E707874FC2D692FA5D7****</UploadId>
        <Initiated>2012-02-23T06:14:27.000Z</Initiated>
    </Upload>
</ListMultipartUploadsResult>

SDK

The following programming languages have OSS SDKs available for calling the operation:

Command line tool ossutil

For the ossutil command corresponding to the ListMultipartUploads operation, see list-multipart-uploads.