Skip to content

云存储模块

普通锁云存

获取云存列表

  1. 请求链接: /lockCloudStorage/list

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
lockIdintY500锁ID
  1. 返回参数及示例:
参数类型描述
dateString日期
recordListArray记录列表
recordIdInt记录ID
operateDateLong操作时间
imagesUrlString图片URL
videoUrlString视频URL
json
[
  {
    "date": "2024-03-12",
    "recordList": [
      {
        "recordId": 42542,
        "operateDate": 1710208636599,
        "imagesUrl": "http://pre.oss-lock.star-lock.cn/starchart/T9A_d7d74b2f66b8-1710208617/964f08ca-1ff3-41f5-ad28-d15fdaf47508.jpg",
        "videoUrl": "http://pre.oss-lock.star-lock.cn/starchart/T9A_d7d74b2f66b8-1710208617/9097e148-e9f2-478d-bcf0-b99fd4e910a5.mp4"
      }
    ]
  },
  {
    "date": "2024-03-11",
    "recordList": [
      {
        "recordId": 42543,
        "operateDate": 1710208636599,
        "imagesUrl": "http://pre.oss-lock.star-lock.cn/starchart/T9A_d7d74b2f66b8-1710208617/964f08ca-1ff3-41f5-ad28-d15fdaf47508.jpg",
        "videoUrl": "http://pre.oss-lock.star-lock.cn/starchart/T9A_d7d74b2f66b8-1710208617/9097e148-e9f2-478d-bcf0-b99fd4e910a5.mp4"
      }
    ]
  }
]

删除云存数据

  1. 请求链接: /lockCloudStorage/delete

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
recordIdsarrayY[42543]云存数据ID
  1. 返回参数及示例:
参数类型描述
errorCodeInt错误码
descriptionString描述
errorMsgString错误信息
dataObject返回数据
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": null
}

腾讯锁云存

获取云存储服务信息

  1. 请求链接: /api/v1/starlock/passthrough

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
request_methodstringYPOST请求方法 GET/POST
request_uristringY/api/v1/cloudStorage/getStorageServiceInfo请求星云地址
post_argsobjectY-请求参数
    lockIdintY205锁ID
  1. 返回参数及示例:
参数类型描述
lockIdint锁ID
statusint状态 0:未开通 1:已开通 2:已过期
validityPeriodStartstring有效期开始时间
validityPeriodEndstring有效期结束时间
rollingStorageDaysint滚动存储天数
remainingDaysint剩余天数
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "lockId": 205,
    "status": 0,
    "validityPeriodStart": "",
    "validityPeriodEnd": "",
    "rollingStorageDays": 0,
    "remainingDays": 0
  }
}

获取云存储事件记录列表

  1. 请求链接: /api/v1/starlock/passthrough

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
request_methodstringYPOST请求方法 GET/POST
request_uristringY/api/v1/cloudStorage/getStorageEventList请求星云地址
post_argsobjectY-请求参数
    lockIdintY205锁ID
    pageNointN1页码
    pageSizeintN10每页条数
  1. 返回参数及示例:
参数类型描述
pageNoint页码
pageSizeint每页条数
totalint总数
listArray事件列表
    event_idstring事件ID
    device_idint设备ID
    event_typeint事件类型
    event_type_namestring事件类型名称
    event_timeint事件时间
    preview_imagestring预览图片
    videostring视频URL
    textstring文本描述
    video_expire_atint视频过期时间
    payloadstring负载数据
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "total": 1,
    "list": [
      {
        "event_id": "tIkDSKXA",
        "device_id": 3237237942,
        "event_type": 7,
        "event_type_name": "徘徊告警",
        "event_time": 1748404291,
        "preview_image": "https://example.com/preview.jpg",
        "video": "https://example.com/video.mp4",
        "text": "检测到运动",
        "video_expire_at": 1748663491,
        "payload": "{\"key\":\"value\"}"
      }
    ]
  }
}

事件类型说明: 以apiserver文档为准,APP显示event_type_nametext即可

删除事件

  1. 请求链接: /api/v1/starlock/passthrough

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
request_methodstringYPOST请求方法 GET/POST
request_uristringY/api/v1/cloudStorage/delStorageEvent请求星云地址
post_argsobjectY-请求参数
    eventIdstringYtIkDSKXA事件ID
  1. 返回参数及示例:
参数类型描述
errcodeint错误码
errmsgstring错误信息
descriptionstring描述
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "errcode": 0,
    "errmsg": "none error message",
    "description": "表示成功或是。"
  }
}

清空事件

  1. 请求链接: /api/v1/starlock/passthrough

  2. 请求方式: POST

  3. 参数说明:

名称类型是否必需示例描述
request_methodstringYPOST请求方法 GET/POST
request_uristringY/api/v1/cloudStorage/clearStorageEvent请求星云地址
post_argsobjectY-请求参数
    lockIdintY205锁ID
  1. 返回参数及示例:
参数类型描述
errcodeint错误码
errmsgstring错误信息
descriptionstring描述
json
{
  "errorCode": 0,
  "description": "success",
  "errorMsg": "success",
  "data": {
    "errcode": 0,
    "errmsg": "none error message",
    "description": "表示成功或是。"
  }
}

鑫泓佳智能硬件通信协议文档