upOSSModule 阿里云资源管理

模块概述

阿里云平台文件初始化、上传、下载


方法列表

  • aliyunOSSInit
  • uploadFilesByAliyunOSS
  • downloadFilesByAliyunOSS

公共数据

  • 所有数据均以 JSON 结构返回,由代码,信息和数据三部分组成
    {
      "retCode": "000000", //接口状态标识码
      "retInfo": "操作成功",//接口信息说明
      "retData": null //业务数据
    }
    

具体定义:返回数据通用


模块变更记录

  • V4.0.0 删除deleteFilesByAliyunOSS接口:模块现在不支持删除操作
  • V3.3.0 阿里云资源管理功能:只支持nebula容器

方法说明

  • aliyunOSSInit

    aliyunOSSInit({params}) 初始化
适用性
容器 Nebula
支持情况
APP版本 6.15.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
endPoint String OSS endpoint
accessKeyId String 访问OSS使用
accessKeySecret String 访问OSS使用
securityToken String 访问OSS使用
错误返回 retCode说明:
retCode编码 retInfo说明
000002 参数错误(入参json)
正确返回 retData说明:
retCode编码 retInfo说明
000000 初始化成功
示例

调用方式

 uplusapi.upOSSModule.aliyunOSSInit({
      endPoint: 'https://oss-cn-beijing.aliyuncs.com',
      accessKeyId: 'STS.NTJH1Xh6238aev4CasQmv7oNe',
      accessKeySecret: '2mMB1pyjmo6kyF9xFVZp2Aj1kQZNMyeHuRfWaScNTJSF',
      securityToken: 'CAIS1AJ1q6Ft5B2yfSjIr5f/A4vshekThPqKZ1CFp2EmXeJa2Krlhzz2IH9FfHlgBe4bv/s2lG5V5vsdlrFrUZgARUXFYNE16Y8S/wqkYo7Qssi/8LlcUyYFp6TVWXDBx8b3T7jTr7q/E67fhjmm+wZ3xbzlD2vAO3WuLZyOj7N+c90TRXPWRDFaBdBQVH0AzcgBLinpKOqKOBzniXayaU1zoVhThH9Y46ayydHmxni4tlDhzfIPrIncO4Wta9IWXK1ySNCoxud7BOqjnidb8EpN77wkzv4Gqy/duZSdClhc+VCBKK/a+9huKB5wYqInHukGjoClyqwn5beIztuvk08QZLgPaUmFGtD8mvmjMfiyK9M0eYz8P3nwyd2VPvH3yVh7MCpLZF8UJot+cy8uVExxFSupI6um6U3MZRy4V6+G3ac53Jx41Vz0+sCQIFyCU1UmRrmFsm9XGoABfGWlfGcRs3lktq+FswaKqKRTiBbqszWS9RmS0UxnlTx2/XT+tDXAOq3bgsGzE076MvOW3KQNNPrZ//fhcwcm0cZvz3cgFy2dytspDt2afPjnm8rRfn8iyPSjMe1oG1D59+7yeuwIMlxKQcgheDLdqPx1IVmTcQTx4x8LjBt/M+k='
    }).then(res => console.log(res)).catch(err => console.log(err));

获取成功返回结果

{
  "retCode": "000000",
  "retInfo": "初始化成功",
  "retData": ""
}
  • uploadFilesByAliyunOSS

    uploadFilesByAliyunOSS({params}) 文件上传。
适用性
容器 Nebula
支持情况
APP版本 6.15.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
uploadId String 上传资源任务ID
bucketName String 存储空间名称
objectKey String 表示上传文件到OSS时需要指定包含文件后缀在内的完整路径,例如abc/efg/123.jpg
filePath String 要上传的文件路径
expiration String 有效期,长整形字符串
progress Function 文件上传进度
错误返回 retCode说明:
retCode编码 retInfo说明
000001 上传失败
000002 参数错误(入参json)
正确返回 retData说明:

{ retCode: '000000', retData: { eTag: 'xxxxx',//阿里云返回tag serverReturnJsonString: 'xxxxx',//阿里云返回的服务器返回信息 url: 'xxxxxxxx'//上传后的签名url }, retInfo: '上传成功' }

示例

调用方式

 uplusapi.upOSSModule.uploadFilesByAliyunOSS({
        uploadId: 'upload',
        bucketName: 'pro-haier-os-familyalbum',
        objectKey: 'test/1.jpg',
        filePath: 'file:///storage/emulated/0/haier/images/pick.jpeg',
        expiration: "1590393160318",
        progress: (res) => {
          console.log(res);
        }
      }).then(res => {
        console.log("uploadFilesByAliyunOSS success:", res)

      }).catch(err => console.log("uploadFilesByAliyunOSS failed:", err));

获取成功返回结果

{
  retCode: '000000',
  retData:  {
    eTag: 'xxxxx',
    serverReturnJsonString: 'xxxxx',
    url: 'xxxxxxxx'
  },
  retInfo: '上传成功'
}
  • downloadFilesByAliyunOSS

    downloadFilesByAliyunOSS({params}) 文件下载。
适用性
容器 Nebula
支持情况
APP版本 6.15.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
uploadId String 下载资源任务ID
bucketName String 存储空间名称
objectKey String 表示文件上传到OSS时指定包含文件后缀在内的完整路径,例如abc/efg/123.jpg
progress Function 文件下载进度
错误返回 retCode说明:
retCode编码 retInfo说明
000001 下载失败
000002 参数错误(入参json)
正确返回 retData说明:

{ retCode: '000000', retData: { filePath: 'xxxxxxx'//下载到本地的文件路径 }, retInfo: '调用成功' }

示例

调用方式

 uplusapi.upOSSModule.downloadFilesByAliyunOSS({
          uploadId: 'download',
          bucketName: 'pro-haier-os-familyalbum',
          objectKey: 'test/1.jpg',
          progress: (res) => {
            console.log(res);
          }
        }).then(res => {
          console.log("downloadFilesByAliyunOSS  success:", res)
        }).catch(err => console.log("downloadFilesByAliyunOSS failed:", err));

获取成功返回结果

{
  retCode: '000000',
  retData: {
    filePath: 'xxxxxxx'
  },
  retInfo: '下载成功'
}

results matching ""

    No results matching ""