List Multipart Uploads

You can perform this operation to query all in-progress multipart upload tasks that have been initiated but not combined and aborted.

Request Syntax

GET /?uploads&max-uploads=max HTTP/1.1
Host: bucketname.obs.cn-north-1.myhwclouds.com
Date: date
Authorization: authorization

Request Parameters

This request uses parameters to specify the query range for multipart upload tasks. Table 1 describes the parameters.

Table 1 Request parameters

Parameter

Description

Required or Optional

delimiter

Character used to group object keys.

All keys that contain the same string between prefix (if specified) and the first occurrence of the delimiter after prefix are grouped under a single result element CommonPrefixes. CommonPrefix contains no information about any multipart upload. It is only used for informing users of the following: multipart uploads are contained in this group.

Type: string

Optional

prefix

Lists in-progress uploads only for those object keys that begin with the specified prefix.

Type: string

Optional

max-uploads

Sets the maximum number (ranging from 1 to 1000) of multipart uploads to be returned in the response body. If the value is not in this range, 1000 is returned by default.

Type: integer

Optional

key-marker

Indicates the multipart upload after which the listing begins.

Type: string

Optional

upload-id-marker

Indicates the multipart upload after which the listing begins. This parameter is used together with key-marker.

Type: string

Optional

Request Headers

This request uses common headers. For details about common request headers, see Common Request Headers.

Request Elements

This request contains no element.

Response Syntax

HTTP/1.1 status_code
Date: date
Content-Length: length

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListMultipartUploadsResult xmlns="http://obs.cn-north-1.myhwclouds.com/doc/2015-06-30/">
    <Bucket>bucketname</Bucket>
    <KeyMarker/>
    <UploadIdMarker/>
    <NextKeyMarker>nextMarker</NextKeyMarker>
    <NextUploadIdMarker>idMarker</NextUploadIdMarker>
    <MaxUploads>maxUploads</MaxUploads>
    <IsTruncated>true</IsTruncated>
    <Upload>
        <Key>key</Key>
        <UploadId>uploadID</UploadId>
        <Initiator>
            <ID>id</ID>
            <DisplayName>name</DisplayName>
        </Initiator>
        <Owner>
            <ID>ownerID</ID>
            <DisplayName>OwnerDisplayName</DisplayName>
        </Owner>
        <StorageClass>storageclass</StorageClass>
        <Initiated>initiatedDate</Initiated> 
    </Upload>
</ListMultipartUploadsResult>

Response Headers

This response uses common headers. For details about common response headers, see Common Response Headers.

Response Elements

This response contains elements to provide details about the listed multipart uploads. Table 2 describes the elements.

Table 2 Response elements

Element

Description

Required or Optional

ListMultipartUploadsResult

Container for the response

Type: container

Children: Bucket, KeyMarker, UploadIdMarker, NextKeyMarker, NextUploadIdMarker, Delimiter, Prefix, MaxUploads, IsTruncated, Upload, and CommonPrefixes

Ancestor: None

Required

Bucket

Name of the bucket to which the multipart upload was initiated

Type: string

Ancestor: ListMultipartUploadsResult

Required

KeyMarker

Object keys at or after which the multipart upload listing begins

Type: string

Ancestor: ListMultipartUploadsResult

Required

UploadIdMarker

Upload ID after which the multipart upload listing begins

Type: string

Ancestor: ListMultipartUploadsResult

Required

NextKeyMarker

Value of KeyMarker in a subsequent request after a multipart upload list is truncated

Type: string

Ancestor: ListMultipartUploadsResult

Required

NextUploadIdMarker

Value of UploadMarker in a subsequent request after a multipart upload list is truncated

Type: string

Ancestor: ListMultipartUploadsResult

Required

MaxUploads

Maximum of multipart uploads to be returned in the response

Type: integer

Ancestor: ListMultipartUploadsResult

Required

IsTruncated

Indicates whether the returned list of multipart uploads is truncated. true indicates that the list was truncated and false indicates that the list was not truncated.

Type: Boolean

Ancestor: ListMultipartUploadsResult

Required

Upload

Container for elements related to a specific multipart upload

Type: container

Children: Key, UploadId, InitiatorOwner, StorageClass, Initiated

Ancestor: ListMultipartUploadsResult

Required

Key

Key of the object for which the multipart upload was initiated

Type: string

Ancestor: Upload

Required

UploadId

ID of the multipart upload

Type: String

Ancestor: Upload

Required

Initiator

Container element that identifies who initiated the multipart upload

Children: ID, DisplayName

Type: container

Ancestor: Upload

Required

ID

Domain ID of the user.

Type: string

Ancestor: Initiator, Owner

Required

DisplayName

Initiator name

Type: string

Ancestor: Initiator, Owner

Required

Owner

Owner of the part.

Type: container

Children: ID, DisplayName

Ancestor: Upload

Required

StorageClass

Type of storage that will be used for storing objects after the multipart upload is complete.

Type: enumeration

Ancestor: Upload

Required

Initiated

Date and time at which the multipart upload was initiated

Type: date

Ancestor: Upload

Required

ListMultipartUploadsResult.Prefix

Contains the prefix specified in the request.

Type: string

Ancestor: ListMultipartUploadsResult

Required

Delimiter

Contains the delimiter specified in the request.

Type: string

Ancestor: ListMultipartUploadsResult

Required

CommonPrefixes

If you specify a delimiter in the request, the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element.

Type: container

Ancestor: ListMultipartUploadsResult

Required

CommonPrefixes. Prefix

Prefix contained in a CommonPrefix element

Type: string

Ancestor: CommonPrefixes

Required

Error Responses

If the value of maxUploads is a non-integer or smaller than 0, OBS returns 400 Bad Request.

For details about other error responses, see Table 1.

Registration