功能描述
用于获取文件上传任务状态。
接口说明
要求权限:
非 acl 鉴权:admin、space_admin、upload_file、upload_file_force、begin_upload 或 begin_upload_force。
注意
虽然本接口为读接口,但因为读取的是上传任务信息,故仍需上传文件的相关权限。
acl 鉴权:canUpload(当前文件夹可上传)
请求
请求示例
GET /api/v1/file/
{LibraryId}
/{SpaceId}
/{ConfirmKey}
?upload&access_token={AccessToken}
&user_id={UserId}
请求参数:
LibraryId:媒体库 ID,必选参数。
SpaceId:空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(
-
);如果媒体库为多租户模式,则必须指定该参数。ConfirmKey:确认参数,必选参数,指定为开始上传文件时响应体中的 confirmKey 字段的值。
AccessToken:访问令牌,必选参数。
UserId:用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅 生成访问令牌接口,可选参数。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"confirmed": false,"path": [ "foo", "bar", "DCIM001.mp4" ],"type": "video","creationTime": "2021-02-01T08:15:58.000Z","force": false,"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": "/xxx","uploadId": "xxx","headers": {"Content-Type": "application/octet-stream","Authorization": "xxx","x-cos-security-token": "xxx"},"expiration": "2021-07-24T10:34:32.000Z"}}
响应体字段说明:
confirmed:布尔型,代表当前上传任务是否为已完成。
path:字符串数组 或 null,如果是字符串数组则表示最终的文件路径,数组中的最后一个元素代表最终的文件名,其他元素代表每一级目录名,因为可能存在同名文件自动重命名,所以这里的最终路径可能不等同于开始上传时指定的路径;如果是 null 则表示该文件所在的目录或其某个父级目录已被删除,该文件已经无法访问。
type:类型。
creationTime:上传任务创建时间。
force:是否强制覆盖同路径文件。
parts:如果为分块上传则返回该字段,包含已上传的分块信息;否则不返回该字段。
uploadPartInfo:如果为分块上传则返回该字段,包含继续进行分块上传的信息(可参阅 开始分块上传文件 接口);否则不返回该字段。