ListMultipartUploads--对象存储-火山引擎

文档中心

导航

对象存储

ListMultipartUploads

最近更新时间：2024.09.19 10:21:15首次发布时间：2021.10.13 16:14:08

功能描述

该接口用于列举正在进行的分片上传任务，即使用 CreateMultiPartUpload 接口初始化的，但还未合并或终止的分片上传任务。
此操作在响应列表中最多返回 1000 个分片上传任务。1000 个分片上传任务是响应可以包含的最大数量，也是默认值。可以通过在请求中加max-uploads参数来进一步限制响应中的数量。如果响应消息中的IsTruncated为true，说明还有未列举完的分片上传任务，要列出额外的分片上传任务，请使用key-marker和upload-id-marker请求参数。

请求消息样式

GET /?uploads HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: GMT Date
Authorization: authorization string

请求参数和消息头

该请求使用的公共请求消息头，请参见公共参数。

名称	位置	参数类型	是否必选	示例值	说明
uploads	Query	String	是	-	代表 ListMultipartUploads 请求的特殊标识。
delimiter	Query	String	否	-	对对象名进行分组的字符。通常使用 / 作为分组字符。
encoding-type	Query	String	否	url	指定对返回的内容进行编码的编码类型，取值说明如下： `url`：进行 URLEncode，遵循 application/x-www-form-urlencoded 标准。
max-uploads	Query	Integer	否	100	返回分片上传任务的最大数量，最大值为 1000，即一次请求最多返回 1000 个分片上传任务。
prefix	Query	String	否	aaa	用于指定列举返回对象的前缀名称。可以使用此参数对桶中对象进行分组管理（类似文件夹功能）。
key-marker	Query	String	否	test.txt	与 upload-id-marker 配套使用。如果未指定 upload-id-marker，则返回对象名按字典顺序大于 key-marker 的分片上传任务列表。如果指定了 upload-id-marker，返回对象名按字典顺序大于 key-marker 的分片上传任务列表的同时，还返回对象名等于 key-marker，分片上传任务 ID 大于 upload-id-marker 的分片上传任务。
upload-id-marker	Query	String	否	f93f6fc9da94371f321e1008	与参数 key-marker 配套使用。如果未指定 key-marker，忽略此参数。如果指定了 key-marker，返回对象名按字典顺序大于 key-marker 的分片上传任务列表的同时，还返回对象名等于 key-marker，分片上传任务 ID 大于 upload-id-marker 的分片上传任务。

请求元素

该请求无请求消息元素。

响应消息头

该请求返回公共响应消息头，请参见公共参数。

响应元素

名称	参数类型	示例值	说明
Bucket	String	test-bucket	桶名。
KeyMarker	String	abc	请求中带入的 key-marker 参数。
UploadIdMarker	String	1e91667bcb63535bdcd9016163e2da5f	请求中带入的 upload-id-marker 参数。
MaxUploads	Integer	100	请求中带入的 max-uploads 参数。
Prefix	String	abc	请求中带入的 prefix 参数。
Delimiter	String	d	请求中带入的 delimiter 参数。
EncodingType	String	url	请求中带入的 encoding-type 参数。
IsTruncated	Bool	false	返回的结果是否被截断，取值说明如下： `false`：已返回全部结果。 `true`：还有结果未返回。
NextKeyMarker	String	abcdefg	如果结果未完全返回，标识下次请求的 key-marker 值。
NextUploadIdMarker	String	1e91667bcb63535bdcd9016163e2da5f	如果结果未完全返回，标识下次请求的 upload-id-marker 值。
CommonPrefixes	Array	[{"Prefix": "abcd"}]	请求中带 delimiter 参数时，返回的响应中包含 CommonPrefixes 分组信息。该元素标识以 delimiter 结尾，并且有共同前缀的对象名称的集合。
Uploads	Array	-	分片上传任务的根节点。说明 `Uploads` 是 `Key`、`UploadId`、`StorageClass`、`Initiated`、`Owner` 参数的根节点。
Key	String	abcd	对象名。父节点为 Uploads。
UploadId	String	1e91667b98a8fed39f96016152ba6c66	分片任务 ID。父节点为 Uploads。
StorageClass	String	STANDARD	分片上传任务的存储类型，取值说明如下： `STANDARD`：标准存储。 `IA`：低频访问存储。 `INTELLIGENT_TIERING`：智能分层存储。 `ARCHIVE_FR`：归档闪回存储。 `ARCHIVE`：归档存储。 `COLD_ARCHIVE`：冷归档存储。 `DEEP_COLD_ARCHIVE`：深度冷归档存储。父节点为 Uploads。
Initiated	String	2024-06-06T06:10:02.000Z	分片上传任务初始化时间。父节点为 Uploads。
Owner	Object	-	分片上传任务的所有者。父节点为 Uploads。说明 `Owner` 是 `ID` 和 `DisplayName` 参数的根节点。
ID	String	1234567890	账号 ID。父节点为 Owner。
DisplayName	String	test-owner-name	账号名。父节点为 Owner。

请求示例

GET /?uploads HTTP/1.1
Host: bucketname.tos-cn-beijing.volces.com
Date: Fri, 30 Jul 2021 00:13:04 GMT
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
x-tos-id-2: 582a920a02840016-a444ed0
x-tos-request-id: 582a920a02840016-a444ed0
Date: Fri, 30 Jul 2021 00:13:04 GMT
server: TosServer
Content-Length: 636

{
    "Bucket": "bucketName",
    "KeyMarker": "",
    "UploadIdMarker": "",
    "NextKeyMarker": "",
    "NextUploadIdMarker": "",
    "Delimiter": "",
    "Prefix": "",
    "MaxUploads": 1000,
    "IsTruncated": false,
    "Uploads": [
        {
            "Key": "multiobj1",
            "UploadId": "f93f6fc90d5f371f4f18c0b1",
            "Owner": {
                "ID": "AccountID",
                "DisplayName": "DisplayName"
            },
            "StorageClass": "Standard",
            "Initiated": "2021-08-20T06:43:36.000Z"
        }
    ]
}