bdObjectStorage

来自于：AC模块工作室立即使用

creatBucket getBuckets doesBucketExist deleteBucket setBucketAcl setUserBucketAcl uploadFile uploadStr copyObject getObjsFromBucket getFiletrateObjects getObject getObjectPart downloadObject getObjectMetaData getObjectUrl deleteObject multipartUpload cancleMultipartUpload getUnUploadMultiparts getUploadMultiparts

概述

bdObjectStorage 封装了百度对象存储BOS，网盘云服务是基于百度网盘海量的百度对象存储BOS(Baidu Object Storage)提供稳定、安全、高效以及高扩展存储服务，支持单文件最大5TB的文本、多媒体、二进制等任何类型的数据存储。数据多地域跨集群的存储，以实现资源统一利用，降低使用难度，提高工作效率。”存储+计算框架”让您的数据加上“动力”引擎，让数据在传输、存储、处理和发布4个环节有机融为一体。

使用此模块之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：bdObjectStorage
    • 参数：accessKey、secretKey
    • 配置示例：
  1.  <feature name="bdObjectStorage">
  2.    <param name="accessKey" value="" />
  3.    <param name="secretKey" value="" />
  4.  </feature>
  • 字段描述：

accessKey：（必须配置）百度开放平台Access Key 如何获取。

secretKey：（必须配置）Secret Key 如何获取。

接口中metaData字段中的key不能为中文

creatBucket

新建一个Bucket。Bucket是BOS上的命名空间，相当于数据的容器，可以存储若干数据实体（Object）。在上传数据前，必须先创建一个Bucket。

creatBucket({params}, callback(ret, err))

params

point:

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否创建成功
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    msg:''                       //错误信息
  3.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.creatBucket({
  3. point:'',
  4. bucketName:''
  5. },function(ret, err) {
  6. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getBuckets

获取Bucket列表。

getBuckets({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否获取成功
  3.    buckets:[]              //Json数组；buckets
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                //数字类型；错误码 
  3.    msg:''                       //字符串类型；错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getBuckets({
  3. point:''
  4. },function(ret, err) {
  5. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

doesBucketExist

判断Bucket是否存在

doesBucketExist({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；true/false,存在/不存在
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                //数字类型；错误码 
  3.    msg:''                       //字符串类型；错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.doesBucketExist({
  3. point:''，
  4. bucketName:''
  5. },function(ret, err) {
  6. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

deleteBucket

删除已存在Bucket

deleteBucket({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；true/false,删除成功/删除失败
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                //数字类型；错误码 
  3.    msg:''                       //字符串类型；错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.deleteBucket({
  3. point:''，
  4. bucketName:''
  5. },function(ret, err) {
  6. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

setBucketAcl

设置Bucket的访问权限

setBucketAcl({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

permission:

  • 类型：字符串类型
  • 描述：权限类别
  • 取值范围：‘Private‘/Bucket Owner获得FULL_CONTROL，其他人没有任何权限 、 ’PublicRead‘ /Bucket Owner获得FULL_CONTROL，其他人获得READ权限、 ’ PublicReadWrite‘/Bucket Owner获得FULL_CONTROL，其他人获得READ和WRITE权限
    • 默认值：’Private‘

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；true/false,设置成功/设置失败
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                //数字类型；错误码 
  3.    msg:''                       //字符串类型；错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.setBucketAcl({
  3. point:''，
  4. bucketName:''，
  5. permission：’‘
  6. },function(ret, err) {
  7. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

setUserBucketAcl

设置指定用户对Bucket的访问权限

setUserBucketAcl({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型

  • 描述：Bucket名称

    userId:

  • 类型：字符串类型

  • 描述：用户Id

permission:

  • 类型：字符串类型
  • 描述：权限
  • 取值范围：‘READ‘/读权限、’WRITE‘ /写权限、 ’ FULL_CONTROL‘/读写权限
    • 默认值：’READ‘

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；true/false,设置成功/设置失败
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                //数字类型；错误码 
  3.    msg:''                       //字符串类型；错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.setUserBucketAcl({
  3. point:''，
  4. bucketName:''
  5. userId:'',
  6. permission:''
  7. },function(ret, err) {
  8. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

uploadFile

以文件形式上传Object

uploadFile({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：上传的Objectkey

filePath:

  • 类型：字符串类型
  • 描述：文件路径；支持widget、fs格式

metaData:

  • 类型：JSON数组
  • 描述：(可选)自定义元数据 ，BOS支持用户自定义元数据来对Object进行描述
  • 内部字段：[{ key:’’, //字符串类型；自定义元数据key value:’’ //字符串类型；自定义元数据value }]

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否判断成功
  3.    eTag:''        //字符串类型；上传成功后的eTag
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3. objectKey：‘’,
  4.    msg:''                       //错误信息
  5.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.uploadFile({
  4.     point:'',
  5.     bucket:'',
  6.     filePath:'',
  7.     metaData:[]
  8. }function(ret, err) {
  9. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

uploadStr

以字符串形式上传Object

uploadStr({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：上传的Objectkey

strData:

  • 类型：字符串类型
  • 描述：需要上传的字符串

metaData:

  • 类型：JSON数组
  • 描述：(可选)自定义元数据 ，BOS支持用户自定义元数据来对Object进行描述
  • 内部字段：[{ key:’’, //字符串类型；自定义元数据key value:’’ //字符串类型；自定义元数据value }]

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否判断成功
  3.    objectKey：‘’,
  4.    eTag:''        //字符串类型；上传成功后的eTag
  5.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.uploadStr({
  4.     point:'',
  5.     bucketName:'',
  6.     filePath:'',
  7.     metaData:[]
  8. }function(ret, err) {
  9. });

可用性

Android系统

可提供的1.0.0及更高版本

copyObject

CopyObject接口用于将一个已经存在的Object拷贝到另外一个Object，拷贝过程中会对源Object的Etag或修改状态进行判断，根据判断结果决定是否执行拷贝。

copyObject({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

srcBucket:

  • 类型：字符串类型
  • 描述：源Object 的Bucket名称

srcKey:

  • 类型：字符串类型
  • 描述：源Object 的 Key

destBucket:

  • 类型：字符串类型
  • 描述：新Object 的Bucket名称

destKey:

  • 类型：字符串类型
  • 描述：新Object Key

checkETag:

  • 类型：JSON对象
  • 描述：(可选)与源Object的ETag对比决定是否拷贝，与checkChange二选一
  • 内部字段：
  1. {
  3.     srcETag:'',              //字符串类型；用此ETag与源Object的ETag对比
  4.     checkType:''        //字符串类型； 可选字段：’match‘/'noMatch',与源Object的ETag相等的时候拷贝/与源Object的ETag不相等的时候拷贝； 默认：’match‘
  5. }

checkChange:

  • 类型：JSON对象
  • 描述：(可选)判断源Object是否有修改决定是否拷贝，与checkETag二选一
  • 内部字段：
  1. {
  3.     time:'',              //字符串类型；时间字符串，GMT格式（"E, dd MMM yyyy HH:mm:ss z"），例如：Wed, 06 Apr 2016 06:34:40 GMT
  4.     checkType:''        //字符串类型； 可选字段：’modified‘/'unModified',在time时间后被修改过，则进行拷贝/在time时间后没有被修改过，则进行拷贝； 默认：’modified‘
  5. }

metaData:

  • 类型：JSON数组
  • 描述：(可选)自定义元数据 ，新Object的自定义数据
  • 内部字段：[{ key:’’, //字符串类型；自定义元数据key value:’’ //字符串类型；自定义元数据value }]

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否拷贝成功
  3.     eTag:''        //字符串类型；上传成功后的eTag
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.copyObject({
  4.     point:'',
  5.     srcBucket:'',
  6.     srcKey:'',
  7.     destBucket:'',
  8.     destKey:'',
  9.     checkETag:{
  10.     srcETag:'', 
  11.     checkType:'match' 
  12.     }
  13. }function(ret, err) {
  14. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getObjsFromBucket

查看Bucket中Object列表。

getObjsFromBucket({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：源Object 的Bucket名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否拷贝成功
  3.    keys:[]                     //JSON数组；bucket中object的key数组
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getObjsFromBucket({
  4.     point:'',
  5.     bucketName:'',
  6.     }
  7. }function(ret, err) {
  8. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getFiletrateObjects

扩展查询,通过设置参数来筛选Object

getFiletrateObjects({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：源Object 的Bucket名称

MaxKeys:

  • 类型：数字类型
  • 描述：设定此次返回Object的最大个数，不可超过1000。（可选）
  • 默认：1000

Prefix:

  • 类型：字符串类型
  • 描述：设定objectKey的前缀，前缀是指objectKey包含并以Prefix的值作为开始。通常与Delimiter配合在查询模拟文件夹中使用。（可选）

Delimiter:

  • 类型：字符串类型
  • 描述：是一个分隔符，用来对objectKey进行分层。通常与Prefix配合在查询模拟文件夹中使用。从Prefix开始到第一次出现Delimiter字符之间的objectKey称为：CommonPrefixes。（可选）

Marker:

  • 类型：字符串类型
  • 描述：是一个字符串，用来设定返回结果的起始位置。设定Marker值之后，返回的Object会从Marker值之后按字母排序开始返回。（可选）

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,           //布尔型；是否拷贝成功
  3.    keys:[]                     //JSON数组；bucket中object的key数组
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getFiletrateObjects({
  4.     point:'',
  5.     bucketName:'',
  6.     }
  7. }function(ret, err) {
  8. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getObject

获取Object

getObject({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型

  • 描述：Bucket名称

    objectKey:

  • 类型：字符串类型

  • 描述：查询Object的key

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；获取成功
  3.    metaData:[{
  5.          key:'',              //自定义元数组key
  6.       value:''            //自定义元数组value
  7.    }] ,                    //JSON数组；Object的自定义元数据
  8.   content:''                          //内容的base64字符串
  9.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getObject({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’
  7.     }
  8. }function(ret, err) {
  9. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getObjectPart

获取Object中的一部分

getObjectPart({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：查询Object的key

startPosition:

  • 类型：数字类型
  • 描述：从第几个字节开始截取

endPosition:

  • 类型：数字类型
  • 描述：截取到第几个字节

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；获取成功
  3.    metaData:[] ,                    //JSON数组；Object的自定义元数据
  4.     content:''                          //内容的base64字符串
  5.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getObjectPart({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’，
  7.     startPosition：‘’，
  8.     endPosition：‘’
  9.     }
  10. }function(ret, err) {
  11. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

downloadObject

下载Object到指定路径

downloadObject({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：查询Object的key

savePath:

  • 类型：字符串类型
  • 描述：保存地址 支持fs路径 不支持widget路径

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；操作成功
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.downloadObject({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’，
  7.     savePath：‘’
  8.     }
  9. }function(ret, err) {
  10. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getObjectMetaData

只获取ObjectMetadata

getObjectMetaData({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：查询Object的key

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；获取成功
  3.   metaData:[{
  5.          key:'',              //自定义元数组key
  6.       value:''            //自定义元数组value
  7.    }] ,                    //JSON数组；Object的自定义元数据
  8.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getObjectMetaData({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’，
  7.     }
  8. }function(ret, err) {
  9. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getObjectUrl

获取Object的URL

getObjectUrl({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：查询Object的key

keepTime:

  • 类型：数字类型
  • 描述：指定的URL有效时长（s）如果要设置为永久不失效的时间，可以设置为 -1，不可设置为其他负数。
  • 默认：1800

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；获取成功
  3.    objUrl ,                    //获取到的Object的url
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getObjectUrl({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’，
  7.     keepTime：
  8.     }
  9. }function(ret, err) {
  10. });

可用性

Android系统

可提供的1.0.0及更高版本

deleteObject

删除Object

deleteObject({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：查询Object的key

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；删除成功/失败
  3.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.deleteObject({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’
  7.     }
  8. }function(ret, err) {
  9. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

multipartUpload

分块上传

multipartUpload({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：上传的Objectkey

filePath:

  • 类型：字符串类型
  • 描述：文件路径；支持widget\fs路径；

partSize:

  • 类型：数字类型
  • 描述：每块大小；不得小于5Mb
  • 单位：MB；

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；删除成功/失败
  3.    uploadId:'' ，                    //字符串类型；分块上传的uploadId
  4.    eTag:''        //字符串类型；上传成功后的eTag
  5.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.multipartUpload({
  4.     point:'',
  5.     bucketName:'',
  6.     objectKey：‘’,
  7.     filePath:'',
  8.     partSize:
  9.     }
  10. }function(ret, err) {
  11. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

cancleMultipartUpload

取消分块上传

cancleMultipartUpload({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：上传的Objectkey

uploadId:

  • 类型：字符串类型
  • 描述：分块上传uploadId

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；取消成功/失败
  4.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.cancleMultipartUpload({
  4.     point:'',
  5.     bucketName:'',
  6.     uploadId：‘’
  7.     }
  8. }function(ret, err) {
  9. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getUnUploadMultiparts

获取未完成的分块上传

getUnUploadMultiparts({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；取消成功/失败
  3.  multiparts:[{                      //JSON数组；未完成块儿
  4.  multipartKey:                   //字符串类型；未完成 key
  5.  uploadId:                          //字符串类型； 未完成 uploadId
  6.  }]
  7.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getUnUploadMultiparts({
  4.     point:'',
  5.     bucketName:'',
  6.     }
  7. }function(ret, err) {
  8. });

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

getUploadMultiparts

获取所有已上传的分块信息

getUnUploadMultiparts({params}, callback(ret, err))

params

point:

  • 类型：字符串类型
  • 描述：Bucket所在区域域名

bucketName:

  • 类型：字符串类型
  • 描述：Bucket名称

objectKey:

  • 类型：字符串类型
  • 描述：上传的Objectkey

uploadId:

  • 类型：字符串类型
  • 描述：分块上传uploadId

maxPart:

  • 类型：数字类型
  • 描述：最大返回条数（可选）
  • 默认：1000

partNumber:

  • 类型：数字类型
  • 描述：从第几条开始读取，用来分次读取（可选）
  • 默认：1

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    status: true,                       //布尔型；取消成功/失败
  3.  multiparts:[{                      //JSON数组；完成块儿
  4.  partNumber:1,                   //数字类型；已完成块 位置
  5.  partETag:                          //字符串类型； 完成partETag
  6.  }]
  7.   }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. errorCode:                   //数字类型 ；错误码
  3.    msg:''                       //错误信息
  4.   }

示例代码

  1. var bdObjectStorage= api.require('bdObjectStorage');
  2. bdObjectStorage.getUploadMultiparts({
  4.     point:'',
  5.     bucketName:'',
  6.     uploadId:''
  7.     }
  8. }function(ret, err) {
  9. });

可用性

Android系统

可提供的1.0.0及更高版本