List Multipart Uploads

Last updated: 2020-12-08 18:52:04

    Description

    This API is used to query the ongoing multipart uploads. A single request operation can list up to 1,000 multipart uploads.

    To make the request, you need to have the permission to read the bucket.

    Request

    Sample Request

    GET /?uploads HTTP/1.1
    Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
    Date: GMT Date
    Authorization: Auth String

    Authorization: Auth String (see Request Signature for more information)

    Request Headers

    The implementation of this operation uses common request headers. For more information on common request headers, see Common Request Headers.

    Request Parameters

    The content is described in details below:

    Name Description Type Required
    delimiter The delimiter is a symbol. The delimiter is a symbol. The identical paths between prefix or, if no prefix is specified, the beginning and the first delimiter are grouped and defined as a common prefix String No
    encoding-type Specifies the encoding type of the returned value; valid value: url String No
    prefix Sets that the response will only contain object keys with the specified prefix.
    When you make a query with prefix specified, the returned keys will still contain Prefix
    String No
    max-uploads Sets the maximum number of multipart uploads returned. Value range: [1, 1,000]. Default value: 1,000 String No
    key-marker Used together with upload-id-marker.
    If upload-id-marker is not specified, only the multipart uploads whose ObjectName is lexicographically greater than key-marker will be listed;
    If upload-id-marker is specified, the multipart uploads whose ObjectName is lexicographically greater than the specified key-marker will be listed, and any multipart upload whose ObjectName lexicographically equals key-marker and whose UploadId is greater than upload-id-marker will also be listed
    String No
    upload-id-marker Used together with key-marker.
    If key-marker is not specified, upload-id-marker will be ignored;
    If key-marker is specified, the multipart uploads whose ObjectName is lexicographically greater than the specified key-marker will be listed, and any multipart upload whose ObjectName lexicographically equals key-marker and whose UploadId is greater than upload-id-marker will also be listed
    String No

    Request Body

    The request body of this request is empty.

    Response

    Response Headers

    This API only returns common response headers. For more information on common response headers, see Common Response Headers.

    Response Body

    This response body returns application/xml data. The following contains all the node data:

    <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 in details below:

    Node Name (Keyword) Parent Node Description Type
    ListMultipartUploadsResult None Information on all multipart uploads Container

    Content of the Container node ListMultipartUploadsResult:

    Node Name (Keyword) Parent Node Description Type
    Bucket InitiateMultipartUploadResult Destination bucket for a multipart upload, which is formed by connecting a user-defined string and the system-generated APPID with a hyphen, such as examplebucket-1250000000 String
    Encoding-Type ListMultipartUploadsResult Specifies the encoding type of the returned value; valid value: url String
    KeyMarker ListMultipartUploadsResult The key value where the entry list starts String
    UploadIdMarker ListMultipartUploadsResult The uploadId value where the entry list starts String
    NextKeyMarker ListMultipartUploadsResult If the returned list is truncated, the NextKeyMarker returned will be the starting point of the subsequent list String
    NextUploadIdMarker ListMultipartUploadsResult If the returned list is truncated, the UploadId returned will be the starting point of the subsequent list String
    MaxUploads ListMultipartUploadsResult Sets the maximum number of multipart uploads returned. Value range: [0, 1,000] String
    IsTruncated ListMultipartUploadsResult Whether the returned list is truncated, which is a boolean value. Valid values: TRUE, FALSE Boolean
    Prefix ListMultipartUploadsResult Sets that the response will only contain object keys with the specified Prefix.
    When you make a query with prefix specified, the returned keys will still contain Prefix
    String
    Delimiter ListMultipartUploadsResult The delimiter is a symbol. The identical paths between prefix or, if no prefix is specified, the beginning and the first delimiter are grouped and defined as a common prefix String
    Upload ListMultipartUploadsResult Information on each upload Container
    CommonPrefixes ListMultipartUploadsResult The identical paths between prefix and delimiter are grouped and defined as a common prefix