获取文件上传任务状态

最近更新时间:2025-10-29 14:34:31

我的收藏

功能描述

用于获取文件上传任务状态。
说明:
要求权限:admin、space_admin、upload_file、upload_file_force、begin_upload 或 begin_upload_force。有关权限详情可参考 生成访问令牌接口。(注意:虽然本接口为读接口,但因为读取的是上传任务信息,故仍需上传文件的相关权限。)

请求

请求示例

GET /api/v1/file/{LibraryId}/{SpaceId}/{ConfirmKey}?upload&access_token={AccessToken}&user_id={UserId}

请求参数

请求参数
描述
类型
是否必选
LibraryId
媒体库 ID,在媒体托管控制台创建媒体库后获取,请参见 创建媒体库
String
SpaceId
空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(`-`);如果媒体库为多租户模式,则必须指定该参数,获取请参见 创建租户空间
String
ConfirmKey
确认参数,指定为开始上传文件时响应体中的 confirmKey 字段的值
String
AccessToken
访问令牌,获取请参见 生成访问令牌
String
UserId
用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参见 生成访问令牌接口
String

请求体

该请求无请求体。

响应

响应码

获取成功,返回 HTTP 200 OK。

响应体

application/json
响应体示例:
{
"confirmed": false,
"path": [ "foo", "bar", "DCIM001.mp4" ],
"type": "video",
"creationTime": "2021-02-01T08:15:58.000Z",
"conflictResolutionStrategy": "ask",
"force": false,
"availableDomainNum": 1,
"uploadId": "1754379542fofb157a8cf6765ba250fed28be8471cbcff1fabf32ebcee87ce1b6cf1b2a6e1",
"parts": [
{
"PartNumber": 1,
"LastModified": "2021-02-01T08:16:02.000Z",
"ETag": "\\"39270a968a357d24207e9911162507eb\\"",
"Size": 1048576
},
{
"PartNumber": 2,
"LastModified": "2021-02-01T08:16:05.000Z",
"ETag": "\\"d899fbd1e06109ea2e4550f5751c88d6\\"",
"Size": 1048576
}
],
"uploadPartInfo": {
"domain": "examplebucket-1250000000.cos.ap-beijing.myqcloud.com",
"path": "smhxxx/xxx.mp4"",
"uploadId": "1754379542fofb157a8cf6765ba250fed28be8471cbcff1fabf32ebcee87ce1b6cf1b2a6e1",
"headers": {
"Content-Type": "application/octet-stream",
"Authorization": "q-sign-algorithm=sha1&xxx",
"x-cos-security-token": "bKdMa7A0nAJjqejygamFMyWoXCC0uRLxxxxxx"
},
"expiration": "2021-07-24T10:34:32.000Z"
}
}
响应体字段说明:
响应参数
描述
类型
confirmed
代表当前上传任务是否为已完成,包含 true 和 false 两种
Boolean
path
字符串数组 或 null,如果是字符串数组则表示最终的文件路径,数组中的最后一个元素代表最终的文件名,其他元素代表每一级目录名,因为可能存在同名文件自动重命名,所以这里的最终路径可能不等同于开始上传时指定的路径;如果是 null 则表示该文件所在的目录或其某个父级目录已被删除,该文件已经无法访问
String
type
文件类型,包含 file 和 video 两种类型
String
creationTime
上传任务创建时间
String
conflictResolutionStrategy
文件名冲突时的处理方式,默认为 rename
ask:冲突时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码
rename:冲突时自动重命名文件
overwrite:
如果目标为目录或相簿时,默认为 ask 且不支持 overwrite
如果目标为文件,覆盖已有文件
当目标空间的文件存在历史版本时,不支持移动覆盖
String
force
是否强制覆盖同路径文件
Boolean
availableDomainNum
可用域名数量
Int
uploadId
如果为分块上传则返回该字段,作为实际文件上传时需指定的请求参数;否则不返回该字段
String
parts
如果为分块上传则返回该字段,包含已上传的分块信息;否则不返回该字段
Array
uploadPartInfo
如果为分块上传则返回该字段,包含继续进行分块上传的信息(可参阅**开始分块上传文件**接口);否则不返回该字段
Array

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。