List Multipart Uploads

2023-02-19 21:16:10

List Multipart Uploads

用户可以通过本接口查询一个桶中所有的初始化后还未合并以及未取消的多段上传任务。

请求语法

GET /?uploads&delimiter=Delimiter&key-marker=KeyMarker&max-uploads=MaxUploads&prefix=Prefix&upload-id-marker=UploadIdMarker HTTP/1.1
Host: Bucket.s3-us-east-1.ossfiles.com

URI 请求参数

名称 描述 类型
Bucket 存储桶名称 字符串
delimiter 对于名字中包含delimiter的对象的任务,其对象名(如果请求中指定了prefix,则此处的对象名需要去掉prefix)中从首字符至第一个delimiter之间的字符串将作为CommonPrefix在响应中返回。对象名包含CommonPrefix的任务被视为一个分组,作为一条记录在响应中返回,该记录不包含任务的信息,仅用于提示用户该分组下存在多段上传任务。 字符串
prefix 如果请求中指定了prefix,则响应中仅包含对象名以prefix开始的任务信息。 字符串
max-uploads 列举的多段任务的最大条目,取值范围为[1,1000],当超出范围时,按照默认的1000进行处理。 整数
key-marker 列举时返回指定的key-marker之后的多段任务。 字符串
upload-id-marker 只有和key-marker一起使用才有意义, 列举时返回指定的key-marker的upload-id-marker之后的多段任务。 字符串

请求消息头

该请求没有请求消息头。


请求正文

该请求没有请求正文。


请求元素

该请求没有请求元素。


响应语法

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult>
   <Bucket>string</Bucket>
   <KeyMarker>string</KeyMarker>
   <UploadIdMarker>string</UploadIdMarker>
   <NextKeyMarker>string</NextKeyMarker>
   <Prefix>string</Prefix>
   <Delimiter>string</Delimiter>
   <NextUploadIdMarker>string</NextUploadIdMarker>
   <MaxUploads>integer</MaxUploads>
   <IsTruncated>boolean</IsTruncated>
   <Upload>
      <Initiated>timestamp</Initiated>
      <Initiator>
         <DisplayName>string</DisplayName>
         <ID>string</ID>
      </Initiator>
      <Key>string</Key>
      <Owner>
         <DisplayName>string</DisplayName>
         <ID>string</ID>
      </Owner>
      <StorageClass>string</StorageClass>
      <UploadId>string</UploadId>
   </Upload>
   <CommonPrefixes>
      <Prefix>string</Prefix>
   </CommonPrefixes>
   <EncodingType>string</EncodingType>
</ListMultipartUploadsResult>

响应元素

名称 描述 类型
Bucket 初始化任务所在的桶名。 字符串
KeyMarker 列举时的起始对象位置。 字符串
UploadIdMarker 列举时的起始UploadId位置。 字符串
NextKeyMarker 如果本次没有返回全部结果,响应请求中将包含NextKeyMarker字段,用于标明接下来请求的KeyMarker值。 字符串
Prefix 如果请求中指定了prefix,则响应中仅包含对象名以prefix开始的任务信息。 字符串
Delimiter 请求中带的Delimiter。 字符串
NextUploadIdMarker 如果本次没有返回全部结果,响应请求中将包含NextUploadMarker字段,用于标明接下来请求的UploadMarker值。 字符串
MaxUploads 返回的最大多段上传任务数目。 整数
IsTruncated 表明是否本次返回的Multipart Upload结果列表被截断。“true”表示本次没有返回全部结果;“false”表示本次已经返回了全部结果。 字符串
Upload 保存Multipart Upload任务信息的容器。 容器
Upload.Initiated Multipart Upload任务的初始化时间。 字符串
Upload.Initiator Multipart Upload任务的创建者。 字符串
Upload.Initiator.DisplayName Multipart Upload任务的创建者ID。 字符串
Upload.Initiator.ID Multipart Upload任务的创建者ID。 字符串
Upload.Key 初始化Multipart Upload任务的Object名字。 字符串
Upload.Owner 段的所有者。 容器
Upload.Owner.DisplayName 所有者ID。 字符串
Upload.Owner.ID 所有者ID。 字符串
Upload.StorageClass 表明待多段上传的对象存储类型。 字符串
Upload.UploadId Multipart Upload任务的ID。 字符串
CommonPrefixes 请求中带Delimiter参数时,返回消息带CommonPrefixes分组信息。 字符串
CommonPrefixes.Prefix CommonPrefixes分组信息中,表明不同的Prefix。
EncodingType 对响应中的部分元素进行指定类型的编码。如果请求中设置了encoding-type,那响应中的Delimiter、KeyMarker、Prefix(包括CommonPrefixes中的Prefix)、NextKeyMarker和Key会被编码。 字符串

响应消息头

该请求没有响应消息头。


示例

请求示例

GET /?uploads HTTP/1.1
Authorization: AWS4-HMAC-SHA256 Credential=2421a691b4ed625de19f6f92677b6459/20230117/us-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=5ef1d2f10e2be7ea48bb8475c7ac0772100dc0ae2926938a468ce861b0b0b33c
Content-length: 0
Host: bucket.s3-us-east-1.ossfiles.com
X-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
X-amz-date: 20230117T090346Z

返回示例

HTTP/1.1 200 OK
Content-length: 42283
Content-type: application/xml
Date: Tue, 17 Jan 2023 09:03:48 GMT
x-amz-id-2: bb743d44183e457685c88d6ce76e3e5f
x-amz-request-id: 352f8d7deb6447a9ac684f52d25f7b6f

<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Bucket>bucket</Bucket>
    <KeyMarker></KeyMarker>
    <UploadIdMarker></UploadIdMarker>
    <MaxUploads>100</MaxUploads>
    <IsTruncated>true</IsTruncated>
    <NextKeyMarker>MultipartUpload</NextKeyMarker>
    <NextUploadIdMarker>efcfd4a8fbb9c3ea3366797afcdbd00c</NextUploadIdMarker>
    <Upload>
        <Key>CentOS7.vmdk</Key>
        <UploadId>f4c68cf09b1cf26a3366a5d9a86ef132</UploadId>
        <Initiator>
            <ID>c2287ffd54231d96dfdfe69e798965ca</ID>
            <DisplayName>c2287ffd54231d96dfdfe69e798965ca</DisplayName>
        </Initiator>
        <Owner>
            <ID>c2287ffd54231d96dfdfe69e798965ca</ID>
            <DisplayName>c2287ffd54231d96dfdfe69e798965ca</DisplayName>
        </Owner>
        <StorageClass>STANDARD</StorageClass>
        <Initiated>2023-01-13T05:07:05.000Z</Initiated>
    </Upload>
</ListMultipartUploadsResult>