tencentOSS

来自于:开发者立即使用

概述

COS 简介

对象存储(Cloud Object Storage,简称:COS)是腾讯云提供的一种存储海量文件的分布式存储服务,用户可通过网络随时存储和查看数据。腾讯云 COS 使所有用户都能使用具备高扩展性、低成本、可靠和安全的数据存储服务。

COS 通过控制台、 API、SDK 等多样化方式简单、快速地接入,实现了海量数据存储和管理。通过 COS 可以进行多格式文件的上传、下载和管理。腾讯云提供了直观的 Web 管理界面,同时遍布全国范围的 CDN 节点可以对文件下载进行加速。

tencentOSS 模块概述

本模块封装了腾讯对象存储COS的原生SDK。

模块使用攻略

使用之前须从腾讯云查阅文档,请主要关注“控制台指南”部分。

模块接口

initUploadService

初始化

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

params

appid:

  • 类型:字符串
  • 描述:(必填项)在腾讯云创建“创建存储桶”名称后面跟随的固定id串,如:tyousan-1252112920,其中"1252112920"就是appid值。

secretId:

  • 类型:字符串
  • 描述:(必填项)在腾讯云申请的secretId。[见:API密钥管理]

secretKey:

  • 类型:字符串
  • 描述:(必填项)在腾讯云申请的secretKey。[见:API密钥管理]

region:

  • 类型:字符串
  • 描述:(必填项)腾讯云存储桶节点地址[ap-beijing-1,ap-beijing,ap-shanghai,ap-guangzhou,ap-guangzhou-2,ap-chengdu,ap-singapore,ap-hongkong,na-toronto,eu-frankfurt,cn-north,cn-south,cn-east,cn-southwest,sg]

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: '',
}

示例代码

var demo = api.require('tencentOSS');
demo.initUploadService({
    appid : '1252112925',
    secretId : 'AKIDRgiX7Q5MvNbdQylLBm7F9oEPPAgwljJd',
    secretKey : 'DCvObYKq54mFSR9fz4tWt2vYx73jDSTD',
    region : 'ap-beijing'
},function(ret, err){
    api.toast({ msg:JSON.stringify(ret) +" "+ JSON.stringify(err) });
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

uploadFile

上传文件

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

params

bucketName:

  • 类型:字符串
  • 描述:(必填项)存储桶名称。如:tyousan-1252112920,其中"tyousan"就是bucketName值。

cosPath:

  • 类型:字符串
  • 描述:(必填项)存储在腾讯云远端路径,即存储到 COS 上的绝对路径

srcPath:

  • 类型:字符串
  • 描述:(必填项)本地文件的绝对路径.(支持fs:// widget://)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : 'onStart' //onStart|onProgress|onSuccess|onFail,
    progress : 10.0, //仅onProgress有值
    Message : '',  //仅onFail有值
    AccessUrl : '',//仅onSuccess有值
    ETag : ''//仅onSuccess有值
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
    code:''
}

示例代码

var demo = api.require('tencentOSS');
demo.uploadFile({
    bucketName : 'tyousan',   //"存储桶名称";
    cosPath : '/demo/test_upload1.mp4',   //"远端路径,即存储到 COS 上的绝对路径";
    srcPath : 'widget://image/test1.mp4',  //"本地文件的绝对路径"; 
},function(ret, err){
    api.toast({ msg:JSON.stringify(ret) +" "+ JSON.stringify(err) });
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

downloadFile

下载文件

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

params

bucketName:

  • 类型:字符串
  • 描述:(必填项)存储桶名称。如:tyousan-1252112920,其中"tyousan"就是bucketName值。

cosPath:

  • 类型:字符串
  • 描述:(必填项)存储在腾讯云远端路径,即存储到 COS 上的绝对路径

srcPath:

  • 类型:字符串
  • 描述:(必填项)下载到本地的路径.(支持fs://)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType : 'onStart' //onStart|onProgress|onSuccess|onFail,
    progress : 10.0, //仅onProgress有值
    Message : '',  //仅onFail有值
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: '',
    code:''
}

示例代码

var demo = api.require('tencentOSS');
demo.downloadFile({
    bucketName : 'tyousan',   //"存储桶名称"; 
    cosPath : '/demo/test_upload1.mp4',   //"远端路径,即存储到 COS 上的绝对路径";
    savePath : 'fs://test_dowload.mp4', //"下载到本地的路径"; fs://
},function(ret, err){
    api.toast({ msg:JSON.stringify(ret) +" "+ JSON.stringify(err) });
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本