upResourceModule 资源模块

模块概述

资源模块为H5页面提供设备资源的查询、更新、安装、删除操作


方法列表

  • updateCommonResList(获取非网器类最新资源列表,已废弃,请使用requestNormalResList方法替代)
  • updateDeviceResList(获取设备最新资源,已废弃,请使用requestDeviceResList方法替代)
  • getEntireList(查询本地(包含已安装和未安装)的全部资源列表)
  • getLatestList(查询本地(包含已安装和未安装)最新的资源列表)
  • install(安装指定资源)
  • uninstall(卸载指定资源)
  • requestNormalResList (请求普通资源列表)
  • searchNormalResList (查询普通资源列表)
  • getCommonRes (获取普通资源)
  • requestDeviceResList (请求设备资源列表)
  • searchDeviceResList (查询设备资源列表)
  • getDeviceRes (获取设备资源)

公共数据

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

具体定义:返回数据通用

  • 资源包列表数据结构
属性名 数据类型 说明
id Number 资源ID
createTime String 资源创建时间
updateTime String 资源更新时间
active Number 资源激活状态(1:使用中 0:未使用中)
path String 资源安装路径,未安装时为空
name String 资源名称
type String 资源类型
version String 资源版本
link String 资源链接
hashStr String 资源哈希值
model String 设备型号,可为空
typeId String 设备类型Id,可为空
prodNo String 设备成品编码,可为空
deviceTypeIndex String 设备类型序号,可为空

模块变更记录

  • V4.0.0

    • 新增方法:
    • requestNormalResList (请求普通资源列表)
    • searchNormalResList (查询普通资源列表)
    • getCommonRes (获取普通资源)
    • requestDeviceResList (请求设备资源列表)
    • searchDeviceResList (查询设备资源列表)
    • getDeviceRes (获取设备资源)
    • 删除方法:
    • cancelDownload(取消将要进行的下载任务)
    • resumeDownload(开始将要进行的下载任务)
    • cancel(取消正在下载的任务)
  • V3.0.0

    新增资源模块

方法说明

  • updateCommonResList(获取全部资源包列表,已废弃,请使用requestNormalResList方法替代)

    updateCommonResList({params})
适用性
容器 Nebula
支持情况
APP版本 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
type String 支持类型("",mPaaS,configAPP)
name String 资源包名称
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.updateCommonResList({type:'mPaaS',name:'wash'}).then((result) => {
    console.log('result',result),
  }).catch((err) => {
    console.log("updateCommonResList err",err);
  });
  • updateDeviceResList(获取设备最新资源,已废弃,请使用requestDeviceResList方法替代)

    updateDeviceResList({params})
适用性
容器 Nebula
支持情况
APP版本 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
type String 支持类型("",mPaaS,config)
model String 设备型号
typeId String 设备类型Id
prodNo String 设备产品编码
deviceType String 设备类型
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.updateDeviceResList({type:'mPaaS', typeId:'',model:'',prodNo:'',deviceType:''}).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("updateDeviceResList err",err);
  });
  • getEntireList(查询本地安装的资源包列表)

    getEntireList({params})
适用性
容器 Nebula
支持情况
APP版本 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
type String 支持类型("",mPaaS,configAPP,config)
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.getEntireList({type:'mPaaS'}).then((result) => {
  console.log('result',result);
}.catch((err) => {
    console.log("getEntireList err",err);
  });
  • getLatestList(查询本地最新的资源包列表)

    getLatestList({params})
适用性
容器 Nebula
支持情况
APP版本 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
type String 支持类型("",mPaaS,configAPP,config)
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.getLatestList({type:'mPaaS'}).then((result) => {
  console.log('result',result);
}.catch((err) => {
    console.log("getLatestList err",err);
  });
  • install(安装指定资源)

    install({params})
适用性
容器 Nebula
支持情况
APP版本 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
type String 支持类型(mPaaS,configAPP,config)
name String 资源名称
version String 资源版本
callback Function 回调函数
callback回调函数返回参数说明
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData": data //
}
retData说明
retCode编码 retData说明 retInfo说明
000000 dataObject请见资源包列表数据结构 安装成功
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
250003 操作失败
250004 已安装
250005 未安装
250006 资源不存在
250007 资源已更新
250010 progress:当前下载资源百分比 下载进度
250011 action:下载资源包时如果当前网络未连接,在下载资源前会返回:no_connection:无网络;taskId:任务ID 网络提示
250012 taskId:任务ID 操作执行中
示例
function callback(result) {
    console.log('result',result),
  }
uplusapi.upResourceModule.install({type:'mPaaS',name:'alldev_test',version:'1.0.0'},callback).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("install err",err);
  });
  • uninstall(卸载指定资源)

    uninstall({params})
适用性
容器 Nebula
支持情况
APP版本 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
type String 支持类型(mPaaS,configAPP,config)
name String 资源名称
version String 资源版本
callback Function 回调函数
callback回调函数返回参数说明
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData": data //
}
retData说明
retCode编码 retData说明 retInfo说明
000000 dataObject请见资源包列表数据结构 卸载成功
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
250003 操作失败
250004 资源不存在
250005 未安装
250010 action:下载资源包时如果当前网络未连接,在下载资源前会返回:no_connection:无网络;taskId:任务ID 网络提示
250011 taskId:任务ID 操作执行中
示例
function callback(result) {
    console.log('result',result),
  }
uplusapi.upResourceModule.uninstall({type:'mPaaS',name:'alldev_test',version:'1.0.0'},callback).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("uninstall err",err);
  });
  • requestNormalResList(请求普通资源列表)

    requestNormalResList({params})
适用性
容器 Nebula
支持情况
APP版本 7.1.3 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
name String 资源名称
type String 资源类型("",mPaaS,configAPP)
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.requestNormalResList({name:'wash', type:'mPaaS'}).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("requestNormalResList err",err);
  });
  • searchNormalResList(查询普通资源列表)

    searchNormalResList({params})
适用性
容器 Nebula
支持情况
APP版本 7.1.3 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
name String 资源名称
type String 资源类型("",mPaaS,configAPP)
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.searchNormalResList({name:'wash', type:'mPaaS'}).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("searchNormalResList err",err);
  });
  • getCommonRes(获取普通资源)

    getCommonRes({params})
适用性
容器 Nebula
支持情况
APP版本 7.1.3 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
name String 资源名称
type String 资源类型(mPaaS,configAPP)
callback funtion 结果回调
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
function callback(result) {
    console.log('result',result),
  }
uplusapi.upResourceModule.getCommonRes({name:'wash', type:'mPaaS'},callback).catch((err) => {
    console.log("getCommonRes err",err);
  });
  • requestDeviceResList(请求设备资源列表)

    requestDeviceResList({params})
适用性
容器 Nebula
支持情况
APP版本 7.1.3 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
typeId String typeId
type String 资源类型("",mPaaS,config)
model String 设备型号
prodNo String 产品编码
deviceNetType String 网器非网器标识
deviceType String 设备类型
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.requestDeviceResList({
  typeId:'', 
  type:'mPaaS',
  model:'',
  prodNo:'',
  deviceNetType:'',
  deviceType:'',
  }).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("requestDeviceResList err",err);
  });
  • searchDeviceResList(查询设备资源列表)

    searchDeviceResList({params})
适用性
容器 Nebula
支持情况
APP版本 7.1.3 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
typeId String typeId
type String 资源类型("",mPaaS,config)
model String 设备型号
prodNo String 产品编码
deviceNetType String 网器非网器标识
deviceType String 设备类型
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
uplusapi.upResourceModule.searchDeviceResList({
  typeId:'', 
  type:'mPaaS',
  model:'',
  prodNo:'',
  deviceNetType:'',
  deviceType:'',
  }).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("searchDeviceResList err",err);
  });
  • getDeviceRes(获取设备资源)

    getDeviceRes({params})
适用性
容器 Nebula
支持情况
APP版本 7.1.3 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
typeId String typeId
type String 资源类型(mPaaS,config)
model String 设备型号
prodNo String 产品编码
deviceNetType String 网器非网器标识
deviceType String 设备类型
callback funtion 进度监听回调
错误返回 retCode说明:
retCode编码 retInfo说明
250000 未知错误
250001 资源模块未定义
250002 非法参数错误
正确返回 retData说明:
{
    "retCode":"000000",
    "retInfo":"操作成功",
    "retData":[dataObject] //dataObject请见资源包列表数据结构
}
示例
function callback(result) {
    console.log('result',result),
  }
uplusapi.upResourceModule.getDeviceRes({
  typeId:'', 
  type:'mPaaS',
  model:'',
  prodNo:'',
  deviceNetType:'',
  deviceType:''},
  callback
  ).then((result) => {
  console.log('result',result);
}).catch((err) => {
    console.log("getDeviceRes err",err);
  });

results matching ""

    No results matching ""