tencent cloud

All product documents
APIs
DocumentationAPIsCloud Object StorageObject APIsMultipart UploadList Multipart Uploads
List Multipart Uploads
Last updated: 2024-06-12 15:10:38
List Multipart Uploads
Last updated: 2024-06-12 15:10:38

Overview

This API is used to query the ongoing multipart uploads. Up to 1,000 multipart uploads can be listed in a single request.
Note: The request requires read access to the bucket. Only the root account or sub-accounts granted the permissions of the List Multipart Upload API can call this API.


Request

Sample request

GET /?uploads HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Note:
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com, where <BucketName-APPID> is the bucket name followed by the APPID, such as examplebucket-1250000000 (see Bucket Overview > Basic Information and Bucket Overview > Bucket Naming Conventions), and <Region> is a COS region (see Regions and Access Endpoints).
Authorization: Auth String (See Request Signature for details.)

Request headers

This API only uses Common Request Headers.

Request parameters

The parameters are as follows:
Parameter
Description
Type
Required
delimiter
A symbol. The identical paths between prefix and the first occurrence of the delimiter are grouped and defined as a common prefix. If prefix is not specified, the common prefix starts with the beginning of the path.
String
No
encoding-type
Encoding type for the returned value. Valid value: url
String
No
prefix
A prefix that the returned object keys must start with.
Note that if you use this parameter, the returned keys will contain this prefix.
String
No
max-uploads
Sets the maximum number of multipart uploads that can be returned at a time. Value range: 1−1000. Defaults to 1000.
Int
No
key-marker
This parameter is used together with upload-id-marker:
If upload-id-marker is not specified, multipart uploads whose ObjectName is lexicographically greater than key-marker will be listed.
If upload-id-marker is specified, multipart uploads whose ObjectName is lexicographically greater than key-marker will be listed, and multipart uploads whose ObjectName is lexicographically equal to key-marker with UploadId greater than upload-id-marker will be listed.
String
No
upload-id-marker
This parameter is used together with key-marker:
If key-marker is not specified, upload-id-marker will be ignored.
If key-marker is specified, multipart uploads whose ObjectName is lexicographically greater than key-marker will be listed, and multipart uploads whose ObjectName is lexicographically equal to key-marker with UploadId greater than upload-id-marker will be listed.
String
No

Request body

The request body of this request is empty.

Response

Response headers

This API only returns Common Response Headers.

Response body

The response body returns application/xml data. The following contains all the nodes:
<ListMultipartUploadsResult>
  <Bucket></Bucket>
  <Encoding-Type></Encoding-Type>
  <KeyMarker></KeyMarker>
  <UploadIdMarker></UploadIdMarker>
  <NextKeyMarker></NextKeyMarker>
  <NextUploadIdMarker></NextUploadIdMarker>
  <MaxUploads></MaxUploads>
  <IsTruncated></IsTruncated>
  <Prefix></Prefix>
  <Delimiter></Delimiter>
  <Upload>
    <Key></Key>
    <UploadId></UploadId>
    <StorageClass></StorageClass>
    <Initiator>
      <ID></ID>
    <DisplayName></DisplayName>
    </Initiator>
    <Owner>
      <ID></ID>
    <DisplayName></DisplayName>
    </Owner>
    <Initiated></Initiated>
  </Upload>
  <CommonPrefixes>
    <Prefix></Prefix>
  </CommonPrefixes>
</ListMultipartUploadsResult>
The nodes are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
ListMultipartUploadsResult
None
Information about all multipart uploads
Container
Content of ListMultipartUploadsResult:
Node Name (Keyword)
Parent Node
Description
Type
Bucket
ListMultipartUploadsResult
Destination bucket for the multipart upload. It is formed by connecting a user-defined string and the system-generated APPID with a hyphen, for example, examplebucket-1250000000.
String
Encoding-Type
ListMultipartUploadsResult
Encoding type for the returned value. Valid value: url
String
KeyMarker
ListMultipartUploadsResult
The key where the listing should start
String
UploadIdMarker
ListMultipartUploadsResult
The UploadId where the listing should start
String
NextKeyMarker
ListMultipartUploadsResult
If the returned list is truncated, the NextKeyMarker returned will be the starting point of the next list.
String
NextUploadIdMarker
ListMultipartUploadsResult
If the returned list is truncated, the UploadId returned will be the starting point of the next list.
String
MaxUploads
ListMultipartUploadsResult
Maximum number of multipart uploads that can be returned at a time. Value range: 0−1000
int
IsTruncated
ListMultipartUploadsResult
Whether the returned list is truncated. Valid values: TRUE, FALSE
Boolean
Prefix
ListMultipartUploadsResult
A prefix that the returned object keys must start with.
Note that if you use this parameter, the returned keys will contain this prefix.
String
Delimiter
ListMultipartUploadsResult
A symbol. The identical paths between Prefix and the first occurrence of the Delimiter are grouped and defined as a common prefix. If Prefix is not specified, the common prefix starts with the beginning of the path.
String
Upload
ListMultipartUploadsResult
Information about each upload
Container
CommonPrefixes
ListMultipartUploadsResult
The identical paths between prefix and delimiter are grouped and defined as a common prefix.
Container
Content of Upload:
Node Name (Keyword)
Parent Node
Description
Type
Key
ListMultipartUploadsResult.Upload
Name of the object
String
UploadID
ListMultipartUploadsResult.Upload
ID of the multipart upload
String
StorageClass
ListMultipartUploadsResult.Upload
Storage class of the parts. Enumerated values: STANDARD, STANDARD_IA, ARCHIVE
String
Initiator
ListMultipartUploadsResult.Upload
Information about the upload initiator
Container
Owner
ListMultipartUploadsResult.Upload
Information about the part owner
Container
Initiated
ListMultipartUploadsResult.Upload
Time when the multipart upload is started
Date
Content of Initiator:
Node Name (Keyword)
Parent Node
Description
Type
ID
ListMultipartUploadsResult.Upload.Initiator
Unique CAM ID of the upload initiator
String
DisplayName
ListMultipartUploadsResult.Upload.Initiator
User ID (UIN)
String
Content of Owner:
Node Name (Keyword)
Parent Node
Description
Type
ID
ListMultipartUploadsResult.Upload.Owner
Unique CAM ID of the part owner
String
DisplayName
ListMultipartUploadsResult.Upload.Owner
User ID (UIN)
String
Content of CommonPrefixes:
Node Name (Keyword)
Parent Node
Description
Type
Prefix
ListMultipartUploadsResult.CommonPrefixes
A common prefix
String

Error codes

This API returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

GET /?uploads HTTP/1.1
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Date: Wed, 18 Jan 2015 21:32:00 GMT
Authorization: q-sign-algorithm=sha1&q-ak=AKIDWtTCBYjM5OwLB9CAwA1Qb2ThTSUj****&q-sign-time=1484727508;32557623508&q-key-time=1484727508;32557623508&q-header-list=host&q-url-param-list=uploads&q-signature=5bd4759a7309f7da9a0550c224d8c61589c9****

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1203
Date: Wed, 18 Jan 2015 21:32:00 GMT
Server: tencent-cos
x-cos-request-id: NTg3ZjI0ZGRfNDQyMDRlXzNhZmRf****

<ListMultipartUploadsResult>
    <Bucket>examplebucket-1250000000</Bucket>
    <Encoding-Type/>
    <KeyMarker/>
    <UploadIdMarker/>
    <MaxUploads>1000</MaxUploads>
    <Prefix/>
    <Delimiter>/</Delimiter>
    <IsTruncated>false</IsTruncated>
    <Upload>
        <Key>Object</Key>
        <UploadId>1484726657932bcb5b17f7a98a8cad9fc36a340ff204c79bd2f51e7dddf0b6d1da6220520c</UploadId>
        <Initiator>
           <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
        </Initiator>
        <Owner>
           <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
        </Owner>
        <StorageClass>Standard</StorageClass>
        <Initiated>Wed Jan 18 16:04:17 2017</Initiated>
    </Upload>
    <Upload>
        <Key>Object</Key>
        <UploadId>1484727158f2b8034e5407d18cbf28e84f754b791ecab607d25a2e52de9fee641e5f60707c</UploadId>
        <Initiator>
           <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
        </Initiator>
        <Owner>
           <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
        </Owner>
        <StorageClass>Standard</StorageClass>
        <Initiated>Wed Jan 18 16:12:38 2017</Initiated>
    </Upload>
    <Upload>
        <Key>exampleobject</Key>
        <UploadId>1484727270323ddb949d528c629235314a9ead80f0ba5d993a3d76b460e6a9cceb9633b08e</UploadId>
        <Initiator>
           <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
        </Initiator>
        <Owner>
           <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
        </Owner>
        <StorageClass>Standard</StorageClass>
        <Initiated>Wed Jan 18 16:14:30 2017</Initiated>
    </Upload>
</ListMultipartUploadsResult>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon