本节主要介绍厂商云端调用LinkVisual视频云存储购买服务的流程和API。提供了免费套餐领取及查询接口；还提供了付费套餐相关的查询云存储套餐列表、查询云存储套餐是否可以购买、购买云存储套餐、查询云存储套餐购买订单详情、查询云存储套餐购买订单列表的服务接口。

查询免费的云存储套餐详情

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/freecloudstorage/get 1.0.1 查询免费的云存储套餐详情 可选

请求参数

参数 类型 必有 默认值 描述
iotId String 是 - 设备ID

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型。1：连续型，2：事件型
lifecycle int 是 存储周期。单位：天
months int 是 服务周期。单位：月
consumed int 是 是否已经领取过。0：尚未领取，1：已领取
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
expired int 是 是否到期
remainQuota int 是 赠送云存储剩余配额。单位：月

领取免费的云存储套餐

定义描述

path 版本 描述 是否要cloudToken
/vision/customer/freecloudstorage/consume 1.0.3 领取免费的云存储套餐 可选

请求参数

参数 类型 必有 默认值 描述
iotId String 是 - 设备ID
enableDefaultPlan boolean 否 false 是否设置默认的7x24小时连续录像计划和事件录像计划
immediateUse boolean 否 false 是否立即使用。设置true则为新领取的免费套餐立即生效，设置false则为新领取的免费套餐在之前套餐到期后生效
preRecordDuration int 否 5 事件录像预录时长，取值范围0～5秒
recordDuration int 否 10 事件录像总时长，取值范围0～30秒
quota int 否 1 使用赠送云存储配额。取值范围：1～3个月

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型。1：连续型，2：事件型
lifecycle int 是 存储周期。单位：天
months int 是 服务周期。单位：月
consumed int 是 是否已经领取过。0：尚未领取，1：已领取
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-dd HH:mm:s
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-dd HH:mm:s
expired int 是 是否到期
remainQuota int 是 赠送云存储剩余配额。单位：月

查询视频云存储套餐列表

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/commodity/query 1.0.3 查询视频云存储套餐列表 可选

请求参数

参数 类型 必有 默认值 描述
category String 否 CAMERA 产品品类信息，可填CAMERA、DOORBELL。CAMERA：摄像头品类，DOORBELL：门铃品类

返回参数

参数 类型 是否必填 描述
cloudStorageCommodityList List 是 云存储套餐列表

cloudStorageCommodityList

参数 类型 必有 描述
commodityName String 是 云存储套餐名称
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格
type int 是 云存储套餐类型。1：连续型，2：事件型
price String 是 云存储套餐价格。单位：元
lifecycle int 是 存储周期。单位：天
months int 是 服务周期。单位：月
description String 否 云存储套餐描述
icon String 否 云存储套餐图标URL

查询云存储套餐是否可以购买

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/commodity/check 1.0.2 查询云存储套餐是否可以购买 可选

请求参数

参数 类型 是否必填 描述
iotId String 是 设备ID
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格

返回参数

参数 类型 必有 描述
available boolean 是 是否可以购买

购买云存储套餐

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/commodity/buy 1.0.5 购买云存储套餐 可选

请求参数

参数 类型 是否必填 默认值 描述
iotId String 是 - 设备ID
userName String 是 - 用户名
commodityCode String 是 - 云存储套餐Code
specification String 是 - 云存储套餐规格
copies int 是 - 购买数量
enableDefaultPlan boolean 否 false 是否设置默认的7x24小时连续录像计划和事件录像计划
immediateUse boolean 否 false 是否立即使用。设置true则为新购套餐立即生效，设置false则为新购套餐在之前套餐到期后生效
preRecordDuration int 否 5 事件录像预录时长，取值范围：0～5秒
recordDuration int 否 10 事件录像时长，取值范围：0秒~30秒

返回参数

参数 类型 必有 描述
orderId String 是 订单ID

获取云存储套餐的订单详情

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/order/get 1.0.3 获取云存储套餐的订单详情 可选

请求参数

参数 类型 是否必填 描述
iotId String 是 设备ID
orderId String 是 订单ID

返回参数

参数 类型 必有 说明
orderId String 是 订单ID
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格
copies int 是 购买数量
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
expired int 是 是否到期
paymentStatus int 是 支付状态。1：已支付，0：未支付
price String 是 云存储套餐价格。单位：元
commodityType int 是 云存储套餐类型。1：连续型，2：事件型
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ

查询云存储套餐的订单列表

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/order/query 1.0.3 查询云存储套餐的订单列表 可选

请求参数

参数 类型 是否必填 默认值 描述
iotId String 是 无 设备ID
pageStart int 否 0 起始页数，默认为0
pageSize int 否 20 分页大小，最大值为50

返回参数

参数名 类型 必有 说明
pageNo int 是 当前页号
pageSize int 是 页大小
pageCount int 是 总页数
total int 是 总记录数
orderList JSON 是 订单列表

orderList

参数 类型 必有 描述
orderId String 是 订单ID
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格
copies int 是 购买数量
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
expired int 是 是否到期
paymentStatus int 是 支付状态。1：已支付，0：未支付
price String 是 云存储套餐价格。单位：元
commodityType int 是 云存储套餐类型。1：连续型，2：事件型
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ

设置免费云存储套餐立即生效

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/freecloudstorage/enable 1.0.0 设置免费云存储套餐立即生效 可选

请求参数

参数 类型 是否必填 默认值 描述
iotId String 是 - 设备ID

返回参数

参数 类型 必有 描述
type int 是 云存储套餐类型。1：连续型，2：事件型
lifecycle int 是 存储周期。单位：天
months int 是 服务周期。单位：月
consumed int 是 是否已经领取过。0：尚未领取，1：已领取
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
expired int 是 是否到期
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ

设置云存储套餐立即生效

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/commodity/enable 1.0.0 设置云存储套餐立即生效 可选

请求参数

参数 类型 是否必填 默认值 描述
iotId String 是 - 设备ID
orderId String 是 - 订单ID

返回参数

参数 类型 必有 描述
orderId String 是 订单ID
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格
copies int 是 购买数量
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
expired int 是 订单状态。0：未到期，1：已到期，2：冻结
paymentStatus int 是 支付状态。0：未支付，1：已支付
price String 是 云存储套餐价格。单位：元
commodityType int 是 云存储套餐类型。1：连续型，2：事件型
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ

云存储套餐转移

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/transfer 1.0.0 用户云存储套餐转移。只支持将云存储套餐从同一个管理员账号下的一个设备转移到另一个设备的情形。 可选

请求参数

参数 类型 是否必填 默认值 描述
srcIotId String 是 设备ID
srcOrderId String 是 订单ID
dstIotId String 是 转移目标设备ID
enableDefaultPlan boolean 否 false 是否设置默认的7x24小时连续录像计划和事件录像计划
immediateUse boolean 否 false 是否立即使用。设置true则为新购套餐立即生效，设置false则为新购套餐在之前套餐到期后生效

返回参数

参数 类型 必有 描述
orderId String 是 订单ID
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格
copies int 是 购买数量
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
expired int 是 订单状态。0：未到期，1：已到期，2：冻结
paymentStatus int 是 支付状态。0：未支付，1：已支付
price String 是 云存储套餐价格。单位：元
commodityType String 是 云存储套餐类型。1：连续型，2：事件型
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ

云存储套餐停用

定义描述

path 版本 描述 是否需要cloudToken
/vision/customer/cloudstorage/status/set 1.0.0 设置用户设备的云存储套餐状态 可选

请求参数

参数 类型 是否必填 默认值 描述
iotId String 是 设备ID
orderId String 是 订单ID
status int 是 云存储订单状态。2：冻结停用

返回参数

参数 类型 必有 描述
orderId String 是 订单ID
commodityCode String 是 云存储套餐Code
specification String 是 云存储套餐规格
copies int 是 购买数量
startTime String 是 开始时间。格式yyyy-MM-dd HH:mm:ss
endTime String 是 结束时间。格式yyyy-MM-dd HH:mm:ss
expired int 是 订单状态。0未到期，1已到期，2冻结
paymentStatus int 是 支付状态。0未支付，1已支付
price String 是 云存储套餐价格。单位：元
commodityType int 是 云存储套餐类型。1：连续型，2：事件型
startTimeUTC String 是 开始时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ
endTimeUTC String 是 结束时间（UTC）。格式yyyy-MM-ddTHH:mm:ssZ