目录

Files:resume

功能介绍

断点续传上传文件。

场景描述

Files.resume接口实现了使用断点续传Files.create.resume或Files.update.resume接口返回的location信息查询当前文件的断点信息;根据返回的断点信息,续传新的分片内容,最终实现断点上传大文件的功能。

使用约束

接口原型

承载协议

HTTP PUT

接口方向

开发者服务器->华为云空间服务器

接口URL

https://driveapis.cloud.huawei.com.cn/upload/drive/v1/{serverId}/files?uploadType=resume

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

路径参数

参数

是否必选

参数类型

描述

serverId

是

string

服务器ID;可从Files.create.resume、Files.update.resume接口的响应参数Location中获取。

查询参数

参数

是否必选

参数类型

描述

uploadType

是

string

上传方式。

uploadId

是

string

续传Id。

fields

否

string

采用[Partial-response格式],具体使用见公共说明。

form

否

string

媒体格式。

prettyPrint

否

boolean

是否以美观格式输出。

quotaId

否

string

用户标识,小于40个字符。用于限制单个用户的API访问数量。

callback

否

string

JSONP的callback函数。

请求参数

Request Header

参数

是否必选

参数类型

描述

Authorization

是

string

用户鉴权信息 AccessToken(即AT)

x-hw-trace-id

否

string

业务跟踪id。

x-hw-app-id

否

string

应用的appid。

version

否

string

SDK版本。

x-hw-terminal

否

string

终端型号。

x-hw-os

否

string

终端操作系统类型。

unionID

否

string

用户的unionID。

User-Agent

否

string

应用版本号/appid。

x-hw-deviceUUID

否

string

设备UUID。

x-hw-deviceUDID

否

string

设备UDID。

x-hw-appPackageName

否

string

应用包名。

x-hw-network

否

string

网络类型,[WiFi, 2G, 3G, 4G, 5G, wire]。

Cookie

否

string

cookie中的loginId为会话ID,用于鉴权。

Request Body

文件实体。

请求示例

PUT https://driveapis.cloud.huawei.com.cn/upload/drive/v1/b9ZlaRcoLELMLELENoMg/files?uploadType=resume&uploadId=238430073756776448 HTTP/1.1 
Content-Type: image/jpeg 
Authorization: Bearer CV3PnPLZXyr9K2GV7RYZkF962JZvoEkMQhTho3QHQAPQUyma/lEyZskP/IMWrc7FvaeHivO7y0lyibI/fQvulBnTgtXArSVPsjaLKvYNkDsJSaIR2/sx+K40bYDWWpKFvJNKg2U47jRwz2mfiF3ortNk 
Content-Length: 115085 
Content-Range: bytes 0-115084/115085 
[imagedata]

响应参数

状态码为200时:

参数

参数类型

描述

category

string

类型,固定为drive#file。

id

string

文件id。

fileName

string

文件名。

mimeType

string

文件类型,具体取值参照公共说明。

description

string

文件描述。

favorite

boolean

文件是否被收藏。

recycled

boolean

文件是否被放入回收站。

directlyRecycled

boolean

文件是否被直接被放入回收站。

recyclingUser.category

string

类型,固定为drive#user。

recyclingUser.displayName

string

用户显示名。

recyclingUser.profilePhotoLink

string

用户头像链接(默认不返回)。

recyclingUser.me

boolean

是否是我。

recyclingUser.permissionId

string

权限id。

recyclingUser.userAccount

string

帐号名称(默认不返回)。

recycledTime

string

放入回收站的时间。

parentFolder[]

string

父目录。

properties

string

文件公共自定义属性。

appSettings

string

应用自定义属性。

containers[]

string

空间: drive,applicationData。

version

integer

版本号。

contentDownloadLink

string

文档下载链接。

iconDownloadLink

string

图标链接。

existThumbnail

boolean

是否有缩略图。

thumbnailDownloadLink

string

大缩略图链接。

smallThumbnailDownloadLink

string

小缩略图链接。

thumbnailVersion

integer

缩略图版本号。

onLineViewLink

string

在线浏览链接。

createdTime

string

文件创建时间。

editedTime

string

文件修改时间。

editedByMeTime

string

我修改文件的时间。

editedByMe

boolean

是否是我修改文件。

sharedWithMeTime

string

共享给我的时间。

sharer.category

string

类型,固定为drive#user。

sharer.displayName

string

用户显示名。

sharer.profilePhotoLink

string

用户头像链接(默认不返回)。

sharer.me

boolean

是否是我。

sharer.permissionId

string

权限id。

sharer.userAccount

string

帐号名称(默认不返回)。

owners.category

string

类型,固定为drive#user。

owners.displayName

string

用户显示名。

owners.profilePhotoLink

string

用户头像链接(默认不返回)。

owners.me

boolean

是否是我。

owners.permissionId

string

权限id。

owners.userAccount

string

帐号名称(默认不返回)。

lastEditor.category

string

类型,固定为drive#user。

lastEditor.displayName

string

用户显示名。

lastEditor.profilePhotoLink

string

用户头像链接(默认不返回)。

lastEditor.me

boolean

是否是我。

lastEditor.permissionId

string

权限id。

lastEditor.userAccount

string

帐号名称(默认不返回)。

hasShared

boolean

是否共享。

ownedByMe

boolean

是否是我用。

capabilities.addChildNodePermission

boolean

是否可以增加子目录/文件。

capabilities.writerHasChangeCopyPermission

boolean

change copy是否需要write权限。

capabilities.commentPermission

boolean

是否可以评论。

capabilities.copyPermission

boolean

是否可以拷贝。

capabilities.deletePermission

boolean

是否可以删除。

capabilities.downloadPermission

boolean

是否可以下载内容。

capabilities.editPermission

boolean

是否可以编辑。

capabilities.listChildNodePermission

boolean

是否可以list子目录/文件。

capabilities.editContentPermission

boolean

是否可以修改内容。

capabilities.readHistoryVersionPermission

boolean

是否可以读取副本。

capabilities.removeChildNodePermission

boolean

是否可以移动子目录。

capabilities.renameFilePermission

boolean

是否可以重命名。

capabilities.shareFilePermission

boolean

是否可以共享。

capabilities.recyclePermission

boolean

是否可以移动到回收站。

capabilities.unrecyclePermission

boolean

是否可以撤回移动子文件到回收站。

viewersHasCopyContentPermission

boolean

浏览者是否可以拷贝内容。

writerHasCopyPermission

boolean

拷贝是否需要writer权限。

writersHasSharePermission

boolean

writer能否share。

permissions[]

list

permission列表。

permissions.category

string

类型,固定为drive#permission。

permissions.id

string

权限ID。

permissions.type

string

类型,[user,anyone]。

permissions.role

string

角色,[owner,writer,commenter,reader]。

permissions.userAccount

string

帐号名称。

permissions.displayName

string

名称。

permissions.expirationTime

string

失效时间。

permissions.deleted

boolean

权限是否已删除。

permissions.canDiscoverFile

boolean

是否允许被搜索(仅适用于anyone类型)。

permissionIds

list

permissionId列表。

originalFilename

string

原始文件名。

fullFileSuffix

string

完整的文件后缀,取name第一个.后的字符串。

fileSuffix

string

文件后缀,fullFileSuffix最后一个字符串。

size

integer

文件大小。

occupiedSpace

integer

实际占用空间大小。

pictureMetadata.width

integer

照片宽度。

pictureMetadata.height

integer

照片高度。

pictureMetadata.location.latitude

number

纬度。

pictureMetadata.location.longitude

number

经度。

pictureMetadata.location.altitude

number

高度。

pictureMetadata.exifTime

string

照片的时间,EXIF DateTime。

pictureMetadata.cameraMaker

string

照相机制造商。

pictureMetadata.cameraModel

string

照相机型号。

pictureMetadata.exposureTime

number

曝光长度,单位秒。

pictureMetadata.aperture

number

光圈,f-number。

pictureMetadata.flashUsed

boolean

是否使用闪光灯。

pictureMetadata.focalLength

number

焦距,毫米。

pictureMetadata.isoSpeed

integer

ISO速度。

pictureMetadata.meteringMode

string

测距模式。

pictureMetadata.sensor

string

感光类型。

pictureMetadata.exposureMode

string

曝光模式。

pictureMetadata.colorSpace

string

色彩空间。

pictureMetadata.whiteBalance

string

白平衡模式。

pictureMetadata.exposureBias

number

曝光偏差,APEX值。

pictureMetadata.maxApertureValue

number

最大光圈值,APEX value。

pictureMetadata.lens

string

镜头。

videoMetadata.width

integer

视频宽度。

videoMetadata.height

integer

视频高度。

videoMetadata.durationTime

integer

时长,毫秒。

sha256

string

文件的sha256。

lastHistoryVersionId

string

最新的历史记录版本ID。

contentVersion

string

内容版本号。

响应示例

{
    "fileName":"hwe003",
    "sha256":"59f29d7b3a84482f3ae641d1d490210c589440c6e5104e9ab9574c4aeb40550e",
    "owners":[
        {
            "permissionId":"239046878371512704",
            "displayName":"*******3121@**3.com",
            "me":true,
            "category":"drive#user"
        }
    ],
    "hasShared":false,
    "mimeType":"application/octet-stream",
    "permissionIds":[
        "239046878371512704"
    ],
    "lastHistoryVersionId":"ABgL5WYKCuoCLU7sHD9P43gVTuocMgrsA",
    "parentFolder":[
        "AgFovWXIAIYANC20H_1Fj3oMLbIf8ACAA"
    ],
    "recycled":false,
    "directlyRecycled":false,
    "permissions":[
        {
            "role":"owner",
            "deleted":false,
            "displayName":"*******3121@**3.com",
            "id":"239046878371512704",
            "category":"drive#permission",
            "type":"user",
            "allowFileDiscovery":true
        }
    ],
    "occupiedSpace":11198,
    "createdTime":"2020-06-13T06:52:19.000Z",
    "id":"ABgL5WYKCuoCLU7sHD9P43gVTuocMgrsA",
    "contentDownloadLink":"https://driveapis.cloud.huawei.com.cn/drive/v1/files/ABgL5WYKCuoCLU7sHD9P43gVTuocMgrsA?form=content",
    "capabilities":{
        "downloadPermission":true,
        "renameFilePermission":true,
        "commentPermission":true,
        "deletePermission":true,
        "readHistoryVersionPermission":true,
        "recyclePermission":true,
        "addChildNodePermission":false,
        "unrecyclePermission":true,
        "writerHasChangeCopyPermission":false,
        "copyPermission":true,
        "editContentPermission":true,
        "removeChildNodePermission":false,
        "editPermission":true,
        "listChildNodePermission":false,
        "shareFilePermission":true
    },
    "ownedByMe":true,
    "version":1592031003000,
    "writersHasSharePermission":true,
    "iconDownloadLink":"https://event-dre.dbankcdn.com/filemanagerpic/201911140913476Sc7.png",
    "editedTime":"2020-06-13T06:52:19.000Z",
    "size":11198,
    "thumbnailVersion":0,
    "lastEditor":{
        "permissionId":"239046878371512704",
        "displayName":"*******3121@**3.com",
        "me":true,
        "category":"drive#user"
    },
    "existThumbnail":true,
    "containers":[
        "drive"
    ],
    "category":"drive#file",
    "contentVersion":"4ed95d13-d9e4-334f-aab7-ef49c21d78b6"
}

常见错误码

错误码后4位为业务错误码,用于区分错误场景,其他业务错误码见状态码章节。

状态码

错误码

响应代码

描述

200

NA

-

成功。

308

NA

INCOMPLETE_UPLOAD

断点续传场景下,文件未上传完成。

400

22044001

LACK_OF_PARAM

缺少入参,请检查参数列表。

400

22044002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22054002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22084002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22104002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22234002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22044002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22044002

PARAM_INVALID

参数校验失败,请检查参数列表。

400

22004003

PARAM_VALUE_NOT_SUPPORT

参数不支持,请检查参数列表。

400

22054003

PARAM_VALUE_NOT_SUPPORT

参数不支持,请检查参数列表。

400

22054005

SITE_NOT_FOUND

站点信息未知。

401

22044011

USER_NOT_AUTHORIZED

用户鉴权失败。

401

22054011

USER_NOT_AUTHORIZED

用户鉴权失败。

403

22044033

AGREEMENT_NOT_SIGNED

协议未签署,请签署协议后再进行重试。

403

22124031

DATA_MIGRATING

正处于安全策略更新, 请等待安全策略更新完成。

403

22234036

INSUFFICIENT_PERMISSION

无此操作权限。

403

22004035

INSUFFICIENT_SCOPE

Scope校验失败。

403

22044035

INSUFFICIENT_SCOPE

Scope校验失败。

403

22234035

INSUFFICIENT_SCOPE

Scope校验失败。

403

22044035

INSUFFICIENT_SCOPE

Scope校验失败。

403

22004037

OPERATION_NOT_COMPLETE

由于错误无法完成操作。

403

22044037

OPERATION_NOT_COMPLETE

由于错误无法完成操作。

403

22234038

OUTER_SERVICE_ERROR

外部服务错误。

403

22124032

SERVICE_NOT_SUPPORT

服务未开放。

403

22114039

SPACE_FULL

用户空间不足,请扩容或删除文件再进行重试。

404

22234041

CONTENT_NOT_FOUND

内容未发现。

404

22044041

CONTENT_NOT_FOUND

内容未发现。

429

22074292

APP_REQUEST_TOO_MANY

应用请求太频繁。

429

22074291

USER_REQUEST_TOO_MANY

用户请求太频繁。

500

22045004

DATABASE_UNAVAILABLE

数据库操作失败。

500

22035002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22045002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22055002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22075002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22115002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22125002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22235002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22045002

OUTER_SERVICE_UNAVAILABLE

外部服务不可用。

500

22085001

SERVER_IS_BUSY

服务器资源不够。

500

22005006

SERVER_TEMP_ERROR

服务器临时错误。

500

22085006

SERVER_TEMP_ERROR

服务器临时错误。

500

22115006

SERVER_TEMP_ERROR

服务器临时错误。

500

22045006

SERVER_TEMP_ERROR

服务器临时错误。

调用示例

    public static void main(String[] args) throws IOException {
        // 设置请求地址,服务器ID,续传ID和用户认证令牌
        String url = "https://driveapis.cloud.huawei.com.cn/upload/drive/v1";
        String serverId = "fc7300dbe0280d39";
        String upload_id = "246009705515379712";
        String access_token = "CF3pvqiyaVUXfclpdiztAQIRcW/gGlZzV0HAiJBRe4ClGDYseeS6/PA2FMdMvfSc1vMKwzKJn0ZNPQZglHbpjQvscQA8yj0wmlMz2lhESZoa+pruIHCYQw==";
        // 断点续传上传文件
        JSONObject fileInfo = filesResume(url, access_token, serverId, upload_id);
        System.out.println(fileInfo.toJSONString());
    }


    private static JSONObject filesResume(String url, String access_token, String serverId, String upload_id) throws IOException {
        StringBuilder stringBuilder = new StringBuilder("");
        stringBuilder.append("/").append(serverId).append("/").append("files");
        stringBuilder.append("?").append("fields=*");
        stringBuilder.append("&").append("uploadType=resume");
        stringBuilder.append("&").append("uploadId=").append(upload_id);
        HttpPut httpPut = new HttpPut(url + stringBuilder);
        httpPut.setHeader("Authorization","Bearer " + access_token);
        httpPut.setHeader("Content-Type", "application/json;charset=UTF-8");
        httpPut.setHeader("Content-Range", "bytes 0-115084/115085");

        File file = new File("C:\\Users\\name\\Pictures\\Saved Pictures\\2.jpg");
        if(!file.exists()){
            System.out.print("File not exist");
            return null;
        }

        HttpEntity entity = new FileEntity(file);

        httpPut.setEntity(entity);

        CloseableHttpResponse response = HttpClientUtil.getClient().execute(httpPut);

        try {
                HttpEntity responseEntity = response.getEntity();
                String ret = responseEntity != null ? EntityUtils.toString(responseEntity) : null;
                JSONObject jsonObject = (JSONObject) JSON.parse(ret);
                EntityUtils.consume(responseEntity);
                return jsonObject;

        }finally {
            response.close();
        }
    }