huaweiObs

init

putData

putFile

downloadObject

deleteObject

deletesObject

copyObject

概述

huaweiObs 插件封装了华为云对象存储服务obs。华为云注册

对象存储服务（Object Storage Service，OBS）提供海量、安全、高可靠、低成本的数据存储能力，可供用户存储任意类型和大小的数据。适合企业备份/归档、视频点播、视频监控等多种数据存储场景。

使用前需了解华为云对象存储相关内容，可查看华为云对象存储文档

1.ios系统版本：ios8.0及以上, 请注意编译时在编译界面的高级设置里面选择支持的系统版本。

2.Android: 编译时需勾选“使用升级环境编译”。

3.必须注册华为云账号，并开通OBS服务。

使用此插件之前必须先配置 config 文件，配置方法如下：

  • 名称：huaweiObs
  • 参数：ak、sk、endPoint
  • 配置示例:
  <feature name="huaweiObs">
        <param name="ak" value="NKCKXQGFIIMPV9*****" />
        <param name="sk" value="ZWKMdDWD0vHyRIDI7C5l71AoX8ruiiy1lh3****" />
        <param name="endPoint" value="https://obs.cn-south-1.myhwclouds.com" />
    </feature>

  • 字段描述:

    ak：华为云账号生成的Access Key ID, 是构建华为云 API 请求的重要凭证 [API密钥管理]

    sk：华为云账号生成的Secret Access Key, 是构建华为云 API 请求的重要凭证 [API密钥管理]

    endPoint：华为云OBS为每个区域提供Endpoint，用于处理各自区域的访问请求[区域管理],记住要加协议类型（https://），如：https://obs.cn-south-1.myhwclouds.com

插件接口

init

服务初始化

init()

示例代码

var obs = api.require('huaweiObs');
obs.init();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

putData

流式上传对象

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

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-wkz

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg，云会自动创建test文件夹，以便存储文件

uploadType：

  • 类型：数字
  • 描述：上传的类型
  • 取值范围：
    • 1：上传字符串
    • 2：上传网络流
    • 3：上传文件流，推荐使用文件上传的形式上传本地文件，而不是文件流形式。

uploadFile：

  • 类型：字符串
  • 描述：上传对象，uploadType为1时传入字符串，uploadType为2时传入网络地址，uploadType为3时需上传本地文件路径，要求本地路径（fs://、widget://）

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    eventType: 'onComplete',    //字符串类型；事件类型
                             //取值范围：
                             //onComplete（成功）
                             //onProgress（进度）
                             //onError（失败）
    currentSize: '',             //字符串类型；已上传文件大小，仅onProgress有值
    totalSize: '',           //字符串类型；文件总大小，仅onProgress有值，android返回-1
    etag: '',           //字符串类型；对象etag值，仅onComplete有值
    requestID: '',           //字符串类型；对象标识，仅onComplete有值
}

示例代码

var obs = api.require('huaweiObs');
obs.putData({
    bucket: "module-wkz",
    objectKey: "test/img1",
    uploadType: 3,
    uploadFile: "widget://image/test.jpg"
}, function(ret, err){      
    if( ret ){
        alert( JSON.stringify( ret ) );
    }else{
        alert( JSON.stringify( err ) );
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

putFile

上传文件

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

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-wkz

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg，云会自动创建test文件夹，以便存储文件

uploadFile：

  • 类型：字符串
  • 描述：上传对象，需上传本地文件路径，要求本地路径（fs://、widget://）

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    eventType: 'onComplete',    //字符串类型；事件类型
                             //取值范围：
                             //onComplete（成功）
                             //onProgress（进度）
                             //onError（失败）
    currentSize: '',             //字符串类型；已上传文件大小，仅onProgress有值
    totalSize: '',           //字符串类型；文件总大小，仅onProgress有值
    etag: '',           //字符串类型；对象etag值，仅onComplete有值
    requestID: '',           //字符串类型；对象标识，仅onComplete有值
}

示例代码

var obs = api.require('huaweiObs');
obs.putFile({
    bucket: "module-wkz",
    objectKey: "test/img2",
    uploadFile: "widget://image/test.jpg"
}, function(ret, err){      
    if( ret ){
        alert( JSON.stringify( ret ) );
    }else{
        alert( JSON.stringify( err ) );
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

downloadObject

下载文件

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

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-wkz

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg

downloadFile：

  • 类型：字符串
  • 描述：文件下载后的路径, 如：test.jpg

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    eventType: 'onComplete',    //字符串类型；事件类型
                             //取值范围：
                             //onComplete（成功）
                             //onProgress（进度）
                             //onError（失败）
    currentSize: '',             //字符串类型；已下载文件大小，仅onProgress有值
    totalSize: '',           //字符串类型；文件总大小，仅onProgress有值
    localPath: ''              //字符串类型；文件下载的本地地址，仅onComplete有值
}

示例代码

var obs = api.require('huaweiObs');
obs.downloadObject({
    bucket: "module-wkz",
    objectKey: "test/img1",
    downloadFile: "test"
}, function(ret, err){      
    if( ret ){
        alert( JSON.stringify( ret ) );
    }else{
        alert( JSON.stringify( err ) );
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteObject

删除文件

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

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-wkz

objectKey：

  • 类型：字符串
  • 描述：文件存储在云上的命名，如：test/test.jpg

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    eventType: 'onComplete',    //字符串类型；事件类型
                             //取值范围：
                             //onComplete（成功）
                                //onError（失败）
}

示例代码

var obs = api.require('huaweiObs');
obs.deleteObject({
    objectKey: "test/img1"
}, function(ret, err){      
    if( ret ){
        alert( JSON.stringify( ret ) );
    }else{
        alert( JSON.stringify( err ) );
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deletesObject

多文件删除

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

params

bucket：

  • 类型：字符串
  • 描述：文件存储桶的名称，如：module-wkz

objectKeys：

  • 类型：数组
  • 描述：数组内部为文件在华为云上的命名

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    eventType: 'onComplete',    //字符串类型；事件类型
                             //取值范围：
                             //onComplete（成功）
                             //onError（失败）
}

示例代码

var obs = api.require('huaweiObs');
obs.deletesObject({
    objectKeys: ["test/img1", "test/img2"]
}, function(ret, err){      
    if( ret ){
        alert( JSON.stringify( ret ) );
    }else{
        alert( JSON.stringify( err ) );
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

copyObject

复制文件

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

params

srcBucket：

  • 类型：字符串
  • 描述：目标文件存储桶的名称，如：module-wkz

srcObjectKey：

  • 类型：字符串
  • 描述：目标文件存储在云上的命名，如：test/test1.jpg

dstBucket：

  • 类型：字符串
  • 描述：复制文件存储桶的名称，如：module-wkz

dstObjectKey：

  • 类型：字符串
  • 描述：复制文件存储在云上的命名，如：test/test2.jpg

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    eventType: 'onComplete',    //字符串类型；事件类型
                             //取值范围：
                             //onComplete（成功）
                             //onError（失败）
}

示例代码

var obs = api.require('huaweiObs');
obs.copyObject({
    srcBucket: "module-wkz",
    srcObjectKey: "test/img1",
    dstBucket: "module-wkz",
    dstObjectKey: "test/img2"
}, function(ret, err){      
if( ret ){
            alert( JSON.stringify( ret ) );
    }else{
        alert( JSON.stringify( err ) );
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24