文档中心>数据保险箱>API 文档>分片上传>查询正在进行中的分块上传任务

查询正在进行中的分块上传任务

最近更新时间:2023-02-03 11:04:03

接口描述

  • 接口名称:ListMultipartUploads
  • 接口功能:该接口用于查询正在进行中的分块上传任务,单次请求操作最多列出1000个正在进行中的分块上传,该请求需要有数据保险箱的读权限。

请求

请求示例

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

说明:

Authorization: Auth String 详情,请参见 请求签名 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求参数

具体内容如下:

名称 必选 类型 描述
encoding-type String 规定返回值的编码格式,合法值:url。
prefix String 限定返回的 Object key 必须以 Prefix 作为前缀。
注意使用 prefix 查询时,返回的 key 中仍会包含 Prefix。
max-uploads String 设置最大返回的 multipart 数量,合法取值从1到1000,默认1000。
upload-id-marker String 起始对象键标记,从该标记之后(不含)按照 UTF-8 字典序返回对象键条目。

请求体

该请求的请求体为空。

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:

{
    "Coffer": "",
    "EncodingType": "",
    "UploadIdMarker": "",
    "IsTruncated": "",
    "NextUploadIdMarker": "",
    "Prefix": "",
    "MaxUploads": 0,
    "Upload": [{
        "Key": "",
        "UploadId": "",
        "Initiator": {
            "ID": "",
            "DisplayName": ""
        },
        "Owner": {
            "ID": "",
            "DisplayName": ""
        },
        "Initiated": ""
    }]
}

请求参数描述如下:

节点名称(关键字) 类型 描述
Coffer String 分块上传的目标 Coffer,由用户自定义字符串和系统生成 APPID 数字串由中划线连接而成,例如examplecoffer-1250000000
Encoding-Type String 规定返回值的编码格式,合法值:url。
UploadIdMarker String 列出条目从该 Marker 开始。
NextUploadIdMarker String 假如返回条目被截断,则返回的 NextMarker 就是下一个条目的起点。
MaxUploads String 设置最大返回的 multipart 数量,合法取值从0 - 1000。
IsTruncated Boolean 返回条目是否被截断,布尔值:TRUE,FALSE。
Prefix String 限定返回的 Objectkey 必须以 Prefix 作为前缀,
注意使用 prefix 查询时,返回的 key 中仍会包含 Prefix。
Upload Object 每个 Upload 的信息。

Upload 对象的描述:

节点名称(关键字) 类型 描述
Key String Object 的名称。
UploadID String 标示本次分块上传的 ID。
Initiator Object 用来表示本次上传发起者的信息。
Owner Object 用来表示这些分块所有者的信息。
Initiated Date 分块上传的起始时间。

Initiator 对象的描述:

节点名称(关键字) 类型 描述
ID String 用户唯一的 CAM 身份 ID。
DisplayName String 用户身份 ID 的简称(UIN)。

Owner 对象的描述:

节点名称(关键字) 描述 类型
ID String 用户唯一的 CAM 身份 ID。
DisplayName String 用户身份 ID 的简称(UIN)。

错误码

以下描述此请求可能会发生的一些特殊的且常见的错误情况:

错误码 HTTP 状态码 描述
InvalidArgument 400 Bad Request max-uploads 必须是整数,且值介于0 - 1000之间,否则返回 InvalidArgument。
encoding-type 只能取值 url,否则会返回 InvalidArgument。

获取更多关于数据保险箱的错误码信息,或者产品所有的错误列表,请参见 错误码 文档。

示例

请求

GET /examplecoffer-1250000000?uploads HTTP/1.1
Host: cdcs.ap-beijing.myqcloud.com
Date: Wed, 18 Jan 2015 21:32:00 GMT
Authorization: [Auth String]

响应

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

{
    "Coffer": "examplecoffer-1250000000",
    "EncodingType": "",
    "UploadIdMarker": "",
    "IsTruncated": "false",
    "NextUploadIdMarker": "",
    "Prefix": "",
    "MaxUploads": 1000,
    "Upload": [{
        "Key": "Object",
        "UploadId": "1484726657932bcb5b17f7a98a8cad9fc36a340ff204c79bd2f51e7dddf0b6d1da6220520c",
        "Initiator": {
            "ID": "qcs::cam::uin/100000000001:uin/100000000001",
            "DisplayName": "100000000001"
        },
        "Owner": {
            "ID": "qcs::cam::uin/100000000001:uin/100000000001",
            "DisplayName": "100000000001"
        },
        "Initiated": "Wed Jan 18 16:12:38 2017"
    }]
}