Help & Documentation>Cloud Object Storage>API Documentation>Object APIs>Multipart upload>List Parts

List Parts

Last updated: 2024-11-22 11:47:08

On this page:

Feature Overview

This API is used to query the uploaded parts of a specified multipart upload, i.e., listing all successfully uploaded parts of a multipart upload whose uploadId is specified.
Note Only the root account or sub-accounts with authorized List Part API permissions can call this API.


Requests

Sample Request

GET /<ObjectKey>?uploadId=UploadId 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 with the APPID suffix, such as examplebucket-1250000000. You can refer to the Bucket Overview > Basic Information and Bucket Overview > Bucket Naming Rules documentation. <Region> represents the available regions for COS, which can be found in the Regions and Access Domain Names documentation.
Authorization: Auth String (For more information, see Request Signature.)

Request Header

This API only uses Common Request Headers.

Request Parameters

Name
Description
Local Disk Types
Required
UploadId
Multipart upload ID obtained from the Initiate Multipart Upload API
string
Required
encoding-type
Encoding type of the returned value
string
Not required
max-parts
Maximum number of entries to be returned at a time. Maximum value: 1000. Default value: 1000.
int
Not required
part-number-marker
By default, entries are listed in UTF-8 binary order, starting from the part number after the marker.
string
Not required

Request Body

The request body of this request is empty.

Response

Response Header

This API only returns Common Response Headers.

Response Body

A successful query returns application/xml data, which includes information about the successfully uploaded parts.
<?xml version="1.0" encoding="UTF-8" ?>
<ListPartsResult>
            <Bucket>examplebucket-1250000000</Bucket>
    <Encoding-type/>
            <Key>exampleobject</Key>
    <UploadId>14846420620b1f381e5d7b057692e131dd8d72dfa28f2633cfbbe4d0a9e8bd0719933545b0</UploadId>
            <Initiator>
                <ID>1250000000</ID>
                <DisplayName>1250000000</DisplayName>
            </Initiator>
            <Owner>
        <ID>qcs::cam::uin/100000000001:uin/100000000001</ID>
        <DisplayName>100000000001</DisplayName>
            </Owner>
            <PartNumberMarker>0</PartNumberMarker>
            <Part>
                <PartNumber>1</PartNumber>
        <LastModified>Tue Jan 17 16:43:37 2017</LastModified>
        <ETag>"a1f8e5e4d63ac6970a0062a6277e191fe09a1382"</ETag>
        <Size>5242880</Size>
            </Part>
    <NextPartNumberMarker>1</NextPartNumberMarker>
    <StorageClass>STANDARD</StorageClass>
    <MaxParts>1</MaxParts>
    <IsTruncated>true</IsTruncated>
</ListPartsResult>
The nodes are described as follows:
Node Name (Keyword)
Parent Node
Description
Local Disk Types
ListPartsResult
-
Stores the response of List Parts.
Container
Content of ListPartsResult:
Node Name (Keyword)
Parent Node
Description
Local Disk Types
Bucket
ListPartsResult
Name of the 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
ListPartsResult
Encoding format
string
Key
ListPartsResult
Object name
string
UploadId
ListPartsResult
ID of the multipart upload
string
Initiator
ListPartsResult
Information about the request initiator
Container
Owner
ListPartsResult
Information about the request initiator
Container
StorageClass
ListPartsResult
The storage class of these parts, with enumerated values: STANDARD, STANDARD_IA, ARCHIVE, DEEP_ARCHIVE, etc. For more information on storage classes, see Storage Class Overview.
string
PartNumberMarker
ListPartsResult
By default, entries are listed in UTF-8 binary order, starting from the part number after the marker.
string
NextPartNumberMarker
ListPartsResult
If the returned list is truncated, the NextMarker returned will be the starting point of the subsequent list.
string
MaxParts
ListPartsResult
Maximum number of entries returned at a time
int
IsTruncated
ListPartsResult
Indicates whether the returned list is truncated. Valid values: true, false
boolean
Part
ListPartsResult
Metadata Information
Container
Content of Initiator:
Node Name (Keyword)
Parent Node
Description
Local Disk Types
ID
ListPartsResult.Initiator
Unique ID of the owner
string
DisplayName
ListPartsResult.Initiator
Username of the owner
string
Content of Owner:
Node Name (Keyword)
Parent Node
Description
Local Disk Types
ID
ListPartsResult.Owner
Unique ID of the owner
string
DisplayName
ListPartsResult.Owner
Username of the owner
string
Content of Part:
Node Name (Keyword)
Parent Node
Description
Local Disk Types
PartNumber
ListPartsResult.Part
Part number
string
LastModified
ListPartsResult.Part
Last modified time of the part
string
ETag
ListPartsResult.Part
MD5 checksum of the part
string
Size
ListPartsResult.Part
Part size in bytes
string

Error Codes

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

Examples

Requests

GET /exampleobject?uploadId=1585130821cbb7df1d11846c073ad648e8f33b087cec2381df437acdc833cf654b9ecc6361 HTTP/1.1
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Date: Wed, 25 Mar 2020 10:07:25 GMT
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1585130845;1585138045&q-key-time=1585130845;1585138045&q-header-list=date;host&q-url-param-list=uploadid&q-signature=***********************************************
Connection: close

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1119
Connection: close
Date: Wed, 25 Mar 2020 10:07:25 GMT
Server: tencent-cos
x-cos-request-id: NWU3YjJkNWRfMjNhZjJhMDlfNWY5Ml8zMmUy****



<ListPartsResult>
            <Bucket>examplebucket-1250000000</Bucket>
            <EncodingType/>
            <Key>exampleobject</Key>
            <UploadId>1585130821cbb7df1d11846c073ad648e8f33b087cec2381df437acdc833cf654b9ecc6361</UploadId>
            <Owner>
                <ID>1250000000</ID>
                <DisplayName>1250000000</DisplayName>
            </Owner>
            <PartNumberMarker>0</PartNumberMarker>
            <Initiator>
                <ID>qcs::cam::uin/100000000001:uin/100000000011</ID>
                <DisplayName>100000000011</DisplayName>
            </Initiator>
            <Part>
                <PartNumber>1</PartNumber>
                <LastModified>2020-03-25T10:07:14.000Z</LastModified>
                <ETag>&quot;39270a968a357d24207e9911162507eb&quot;</ETag>
                <Size>1048576</Size>
            </Part>
            <Part>
                <PartNumber>2</PartNumber>
                <LastModified>2020-03-25T10:07:13.000Z</LastModified>
                <ETag>&quot;d899fbd1e06109ea2e4550f5751c88d6&quot;</ETag>
                <Size>1048576</Size>
            </Part>
            <Part>
                <PartNumber>3</PartNumber>
                <LastModified>2020-03-25T10:07:13.000Z</LastModified>
                <ETag>&quot;762890d6c9a871b7bd136037cb2260cd&quot;</ETag>
                <Size>1048576</Size>
            </Part>
            <StorageClass>Standard</StorageClass>
            <MaxParts>1000</MaxParts>
            <IsTruncated>false</IsTruncated>
</ListPartsResult>

中国站 - English