OneNET物联网平台 平台介绍 入门手册 设备开发指南 应用开发指南
API
API使用 API列表 SDK MQTT LwM2M EDP Modbus TCP
消息队列MQ(公测) HTTP推送
扩展服务 常见问题 发布公告

API接口文档

生产环境API_ADDRESS地址:api.heclouds.com/ipc/video/

1.通道管理

1.1查询设备下通道信息

HTTP方法 GET
URL http://API_ADDRESS/device/QryChannel
HTTP头部 api-key 必填
URL参数 device_id=//设备ID 必填
HTTP内容
{
"errno":0,
"error":"succ",
"result":
[
{
"channel_id":20,
"title":"test_qwer",
"desc":"1qwqwq/"
},
{
"channel_id":100,
"title":"my_quto_test",
"desc":"123_test"
}
]
}

1.2删除设备下通道

HTTP方法 DELETE
URL http://API_ADDRESS/device/DelChannel
HTTP头部 api-key 必填
URL参数 device_id=//设备ID 必填
channel_id=//通道编号,必填
HTTP内容
成功返回 {
"errno":0,
"error":"succ"
}

1.3增加设备下通道信息

HTTP方法 POST
URL http://API_ADDRESS/device/AddChannel
HTTP头部 api-key 必填
URL参数 device_id=//设备ID 必填
channel_id=//通道ID,必填
title=//标题,必填(长度不超过64且只能是数字、字母或者是数字字母组合)
desc=//通道描述
HTTP内容
成功返回 {
"errno":0,
"error":"succ"
}
说明 如果通道已经存在则报错返回如下信息:
{
"errno": 16,
"error": "The channel already exists,cannot add again!"
}

1.4修改设备下通道信息

HTTP方法 POST
URL http://API_ADDRESS/device/ModifyChannel
HTTP头部 api-key 必填
URL参数 device_id=//设备ID 必填
channel_id=//通道ID,必填
title=//标题,必填(长度不超过64且只能是数字、字母或者是数字字母组合)
desc=//通道描述
HTTP内容
成功返回 {
"errno":0,
"error":"succ"
}
说明 如果修改的通道不存在则报错返回如下信息:
{
"errno": 17,
"error": "This channel is not available under this device!"
}

2.查询设备在线状态

HTTP方法 GET
URL http://API_ADDRESS/device/QryDevStatus
HTTP头部 api-key 必填
URL参数 devIds=123,456,789
//设备ID串,以逗号隔开,最多30个,长度不超过500,必填字段
HTTP内容
成功返回 {
"errno": 0,
"error": "succ",
"result": {
"total_count": 2,
"devices": [
{
"id": "2480461",
"online": false
},
{
"id": "2818370",
"online": false
}
]
}
}
说明

3.命令下发

ODVP(OneNET视频设备接入协议)接入的设备用以下接口完成命令下发、获取命令状态和命令响应

3.1发送命令

HTTP方法 POST
URL http://API_ADDRESS/cmds
HTTP头部 api-key 必填
URL参数 device_id =//设备ID
qos=//是否需要设备回应,0 不需要,1需要 默认值为0
type=//命令类型,0,平台定义,1用户定义 默认值为0
HTTP内容 用户自定义数据:json、string、二进制数据(小于64K)
成功返回 {
"errno": 0,
"error":”succ”,
"data":{
"cmd_uuid":”2303-312-Fws”, //指令ID
"cmd_status": 4,//设备下发的状态(平台的返回)
"dev_resp": {
“resp_code”:1,//设备返回的错误码,0表示成功
"resp_data": "xxxxxxx" //设备返回的数据的base64
}
说明 resp_code 为命令在设备的执行状态
cmd_status 如下:
0:设备不在线 device not online
1:命令已创建 sending
2:命令已发往设备 send ok
3:命令发往设备失败 Send error
4:设备正常响应 ok
5:命令执行超时 time out
6:设备响应数据错误 resp data error。
当命令为不需要设备回复时,返回2表示下发成功。
当需要设备回复时返回 >=4 时表示设备在http请求的这个过程已经返回。 当等于 4时dev_resp为设备的返回
返回1,2需要调用命令下发状态接口获取命令下发的情况

3.2命令状态查询

HTTP方法 GET
URL http://API_ADDRESS/cmd_status
HTTP头部 api-key 必填
URL参数 device_id =//设备ID
cmd_uuid=//命令下发接口返回的指令ID
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"data":{
"status": 1,//设备下发的状态(平台的返回)
"desc":"sending"
}
说明 命令状态
0:设备不在线 device not online
1:命令已创建 sending
2:命令已发往设备 send ok
3:命令发往设备失败 Send error
4:设备正常响应 ok
5:命令执行超时 time out
6:设备响应数据错误 resp data error

3.3命令回应查询

HTTP方法 GET
URL http://API_ADDRESS/cmd_resp
HTTP头部 api-key 必填
URL参数 device_id =//设备ID
cmd_uuid=//命令下发接口返回的指令ID
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"resp":”XXXXXXXXX” //设备的回应内容,base64编码
}
说明 设备回复平台后的有效时间为60秒,60秒之后平台将删除设备回复内容的缓存数据。

3.4命令具体流程图

以上三个api,在实际下发一条命令时使用的流程图如下:

qos==0时,即不需要设备回复的命令,如:云台操作,分辨率调整等

pic1

qos==1时,即需要设备回复的命令,如:获取设备上的录像文件列表

pic2

3.5设备定义的通用命令

a.设置码流级别

{
    “type”: ”video”,
    ”cmdId”: 6,
    ”cmd”:{
           “channel_id”: 1, //通道ID, 数字
           “level”: 1 //数字1-4(1:流畅 2:标清 3:高清 4:超清)
          }
}

b.云台控制指令

{
  ”type”: ”video”,
  ”cmdId”: 7,
”cmd”:{
”channel_id”: number, //对应通道的ID(映射到数据流名称)
”stop”:number,  // 2 单步控制
”cmdV:number,  // 1: 焦距变大(倍率变大)  2:焦距变小(倍率变小)  3: 焦点前调 4: 焦点后调 5: 光圈扩大 6: 光圈缩小 11: 方向向上 12: 方向向下 13: 方向左转 14: 方向右转 22:自动扫描
”speed”: number //速度1-7
    }
}

c.本地视频列表查询

{
   ”type”: ”video”,             //指令类型(设备SDK识别)
   ”cmdId”: 10,                //查询视频列表指令(设备SDK识别)
   ”cmd”:{
         ”channel_id”:1,
         ”page”:1,
         ”start_time”: ”2017-09-29 12:00:31”, // 可选
         ”end_time”: ”2017-09-29 13:00:30” //可选
         ”per_page”:20
}
}

本地视频列表响应

”all_count”: 25,    //查询的所有视频总数
”cur_count”:20,   //当前页视频数
”rvods”:[
{
   ”channel_id”:1
   ”video_desc”: ”test123”,
   ”size”: 222,   // 字节数
   ”beginTime”: ”2017-09-29 12:00:31”,
   ”endTime”: ”2017-09-29 13:00:30”
  }
]
}

4.查询设备透传消息

HTTP方法 GET
URL http://API_ADDRESS/device/QryDevMsg
HTTP头部 api-key 必填
URL参数 device_id=//设备ID 必填
begin_time=//查询开始时间 必填 2018-01-01 00:00:00
end_time=//查询结束时间,必填 2018-01-02 00:00:00
HTTP内容
成功返回 {
"errno":0,
"error":"succ",
"page_info":
{
"total_num":7,
"page_total":1,
"page_size":50,
"current_page":1
},
"result":
[
{
"create_time":"2018-01-04 16:27:40",
"msg_id":14,
"msg":"bXlfdGVzdF8xMjM0NQ=="
},
{
"create_time":"2018-01-04 16:31:53",
"msg_id":14,
"msg":"bXlfdGVzdF8xMjM0NQ=="
},
{

"create_time":"2018-01-08 09:27:00",
"msg_id":4398046511104,
"msg":"bXlfdGVzdF8xMjM0NQ=="
},
{
"create_time":"2018-01-08 10:06:16",
"msg_id":4398046511104,
"msg":"bXlfdGVzdF8xMjM0NQ=="
},
{
"create_time":"2018-01-08 10:07:19",
"msg_id":4398046511104,
"msg":"bXlfdGVzdF8xMjM0NQ=="
},
{
"create_time":"2018-01-08 10:09:49",
"msg_id":4398046511104,
"msg":"bXlfdGVzdF8xMjM0NQ=="
},
{
"create_time":"2018-01-08 14:10:35",
"msg_id":4398046511104,
"msg":"bXlfdGVzdF8xMjM0NQ=="
}
]
}
说明 说明:设备透传的消息内容(msg字段)经过了base64编码,需要客户端解码。

5.拉流地址获取

HTTP方法 GET
URL http://API_ADDRESS/play_address
HTTP头部 api-key 必填
URL参数 device_id=//接收该数据的设备ID,必填
channel_id=//对应数据流名称中的channelnum
protocol_type=播放协议类型 0:rtmp 1:hls 2:https-hls
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
“data”:{
"addr":"ip:port",
"accessToken":“字符串”,
"type":"rtmpe",
}
}
说明 拉流地址需要根据返回接口进行拼接:
Rtmp实时拉流地址格式:type://ip:port/live/${deviceid}-${channel_id}?accessToken
Rtmp 实时拉流地址示例:rtmp://183.230.40.39:1935/live/2162826-2?accessToken

Rtmp历史拉流地址格式:
rtmp://ip:port/rvod/${device_id}-${channel_id}-${begintime}-${endtime}?accessToken
Rtmp历史拉流地址示例:
rtmp://183.230.40.39:1935/rvod/2162826-2-201711131530-201711131540?accessToken

Hls实时拉流地址格式:
http://183.230.40.39:8080/live/live
${deviceid}${channel_id}/index.m3u8?accessToken
Hls实时拉流地址示例:
http://183.230.40.39:8080/live/live_2162826_2/index.m3u8?accessToken

6.HLS流预加载请求

HTTP方法 Get
URL http://HLS_PLAY_ADDRESS/live/live_DEVICE_ID_CHANNEL_ID/preload
HTTP头部 api-key 必填
URL参数 token=xxxxx, //播放token
idle_time=120, //空闲清理时间(s),最大值120
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”
}
说明 HLS_PLAY_ADDRESS 及 token 是由HLS拉流地址接口返回。 DEVICE_ID 设备ID,CHANNEL_ID 通道ID
该接口可以达到HLS 流预加载的目的

7.获取直播缩略图

HTTP方法 GET
URL http://coveraddr/live_preview/${device_id}-${channel_id}
HTTP头部
URL参数 token = “”
HTTP内容
成功返回 图片二进制内容
说明 地址和Token是获取拉流地址时返回的accessToken和播放地址, 直接通过播放地址和token可以拼装url地址
http://coveraddr/live_preview/${device_id}_${channel_id}?token=accessToken

8.平台图片相关接口

8.1图片上传

HTTP方法 GET
URL http://API_ADDRESS/picture/upload
HTTP头部 api-key 必填
URL参数 device_id =1
channel_id=1
format=”jpg”/”png”
name="111"
desc="图片描述"
HTTP内容 图片二进制内容
成功返回 {
"errno": 0,
"error":”succ”}
说明 可用在播放端截图上传等
如果与已经上传的图片名字相同,则返回错误

8.2获取图片列表信息

HTTP方法 GET
URL http://API_ADDRESS/picture/get_list
HTTP头部 api-key 必填
URL参数 device_id ="1111"
channel_id=11
start_time=111, // UNIX时间戳,可选过滤条件
end_time=222, // UNIX时间戳, 可选过滤条件
page_start= 1, //分页起始
page_size=1 //分页大小
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”
data:[
{
"format":”jpg” // jpg或png
"size": 1234,// 单位是字节
"date": 1234, // UNIX 时间戳
"name":"111",// 图片名(唯一ID)
"desc" : "name", // 图片描述
"url" : "url" //图片获取url
}
],
"page_info":{
"total_num":50
"page_total":25,
"page_size":2,
"current_page":1
}
}
说明

8.3获取图片信息

HTTP方法 GET
URL http://API_ADDRESS/picture/get_info
HTTP头部 api-key 必填
URL参数 device_id ="1111"
channel_id=11
name=1, //图片名字
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”
data:
{
"format":”jpg” // jpg或png
"size": 1234,// 单位是字节
"date": 1234, // UNIX 时间戳
"name":"111",// 图片名(唯一ID)
"desc" : "name", // 图片描述
"url" : "url" //图片获取url
}
说明

8.4删除图片

HTTP方法 DELETE
URL http://API_ADDRESS/picture/delete_info
HTTP头部 api-key 必填
URL参数 device_id ="1111"
channel_id=11
name=1, //图片名字
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”}
说明

8.5获取图片

HTTP方法 Get
URL $url
HTTP头部
URL参数
HTTP内容
成功返回 返回图片数据
说明 $url 从9.2或者9.3中的接口返回

9.查询引导机地址

HTTP方法 GET
URL http://API_ADDRESS/boot_address
HTTP头部
URL参数
HTTP内容
成功返回 {
"errno": 0,
"error": "succ",
“data”:
{
"boot_address": "183.230.40.42",
"boot_port": 9101
}
}
说明

10.设置产品的视频加密开关

HTTP方法 PUT
URL http://API_ADDRESS/trans_encrypt
HTTP头部 api-key 必填
URL参数 product_id=7355 //产品id
HTTP内容 {"type":0} 0为不加密,1加密
成功返回 {
"errno": 0,
"error": "succ"
}
说明

11.获取产品加密状态

HTTP方法 Get
URL http://API_ADDRESS/trans_encrypt
HTTP头部 api-key 必填
URL参数 product_id=7355 //产品id
HTTP内容
成功返回 {"errno":0,"trans_enc":1}
说明

12.设备数据透传

HTTP方法 POST
URL http://API_ADDRESS/dev_active
HTTP头部 api-key 必填
URL参数 device_id =//设备ID
HTTP内容 自定义,不超过128 byte
成功返回 {
"errno": 0, // 0 命令发送成功
"error": "succ"
}
说明 该接口适用的场景:设备需要收到固定字符串
协议将不对该串加密,协议头部的序列号将置零
设备收到的头部字符串将固定不变

13.录制接口

HTTP方法 GET
URL http://API_ADDRESS/record/record_video
HTTP头部 api-key 必填
URL参数 product_id=12
device_id=123
channel_id=12345
action=0/1, // 0:停止录制 1:开始录制, 必选
HTTP内容
成功返回 {
"errno": 0,
"error": "succ"
}
说明 product_id : 产品号,必选参数
device_id : 设备号,必选参数
channel_id : 通道号,必选参数
action: 操作类型,0:停止录制 1:开始录制,必选参数

14.点播相关接口

14.1视频信息获取

HTTP方法 GET
URL http://API_ADDRESS/vod/get_video_info
HTTP头部 api-key 必填
URL参数 device_id=12,
channel_id=12,
video_id=”1112341234”
security=1 //选择安全播放链接(https和rtmpe),没有则默认为普通链接
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"data":{
"videoid":dafdafd
"name":“dad”,
"start":"2017-01-12 12:01:12",
"end":"2017-01-12 15:01:12",
"size":"1234",// 单位是Kbytes
"durtion":"12", // 单位是秒
"hls_url":"url",// http播放地址
"rtmp_url":"url" // RTMP播放地址
}
}
说明 播放地址需要携带token。token获取见《视频点播token获取》
组装方式为hls: url?token=”token”, rtmp: url?token。
Hls按照http url参数方式增加一个参数token,参数值为获取的token内容。
Rtmp协议直接将token内容拼接在“?”后面。
Security 默认为0,返回普通播放链接(http和rtmp),1表示返回安全播放链接(https和rtmpe)

14.2视频列表获取

HTTP方法 GET
URL http://API_ADDRESS/ vod/get_video_list
HTTP头部 api-key 必填
URL参数 device_id=12,
channel_id=12,
start_time=“2018-01-01 01:00:00”, // 格式化字符串 可选过滤条件
end_time=“2018-01-01 01:00:00”, // 格式化字符串 可选过滤条件
name=”111”, //可选过滤条件,根据名称过滤
page_start= 1, //分页起始
page_size=1 //分页大小
security=1 //选择安全播放链接(https和rtmpe),没有则默认为普通链接
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"data":{
"videos":[
{
"videoid":"dafdafd",
"name":"dad",
"start":"2017-01-12 12:01:12",
"end":"2017-01-12 15:01:12",
"size":1234,// 单位是KBytes
"hls_url":"url",// http播放地址
"rtmp_url":"url" // RTMP播放地址
},
{….},
…..
]
}
"page_info":
{
"total_num":50,
"page_total":25,
"page_size":2,
"current_page":1
}
}
说明 选择过滤时间可以只填start_time或者end_time,也可以一起填
播放地址需要携带token。token获取见《视频点播token获取》
组装方式为hls: url?token=”token”, rtmp: url?token。
Hls按照http url参数方式增加一个参数token,参数值为获取的token内容。
Rtmp协议直接将token内容拼接在“?”后面。
Security 默认为0,返回普通播放链接(http和rtmp),1表示返回安全播放链接(https和rtmpe)

14.3视频删除

HTTP方法 POST
URL http://API_ADDRESS/vod/delete_video
HTTP头部 api-key 必填
Content-Type:application/json
URL参数 deviceid=1,
channeled= 1
HTTP内容 {
"video": [{
"videoId": 1
},
{
"videoId": 2
}]
}
成功返回 {
"errno": 0,
"error":”succ”,
"data":
[
{"code":0}
{"code":1, "message":"not exist"}
]
}
说明 返回消息会以数组的形式给出每个删除ID的结果,如果删除失败会给出错误信息videoId必须是字符串

14.4视频重命名

HTTP方法 PUT
URL http://API_ADDRESS/ vod/rename_video
HTTP头部 api-key 必填
Content-Type:application/json
URL参数 device_id=12,
channel_id=12,
video_id=”1112341234”
HTTP内容 {“name” : “11111”}
成功返回 {
"errno": 0,
"error":”succ”,
}
说明

14.5视频点播token获取

HTTP方法 GET
URL http://API_ADDRESS/vod/get_play_token
HTTP头部 api-key 必填
URL参数 device_id=12,
channel_id=12,
video_id=”1112341234”
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"data":{
"token": "sdafsa"
}
}
说明 Token用于点播相关的视频获取

15.运营

说明:以下接口都采用Josn格式:

正确返回:

{
"errno":0,
"error":"succ",
"result":[]
}

错误返回:

{
"errno":-1,
"error":"The Requested Parameter Is Invalid",
}

Errno 等于0表示返回正确
不等于0表示错误返回, error 表示具体的错误信息。

15.1播放记录列表查询

HTTP方法 GET
URL http://API_ADDRESS/stat/getonlinelist
HTTP头部 api-key 必填
注:只能用master-key
URL参数 productid=//产品号 必填
deviceid =//设备ID
channelid=//通道号
protocoltype =//协议类型 rtmp hls
page_key=//分页查询使用
page_size=//每页查询的数据
page=分页查询使用
HTTP内容
{
"errno":0,
"error":"succ",
"result":
[
{
"productid":7312,
"deviceid":2479989,
"channelid":1,
"protocoltype":"RTMP",
"clientip":"172.19.3.99",
"videocodec":"H264",
"resolution":"1280 720",
"fps":25,
"audiocodec":"",
"bandwidth":91392,
"onlinetime":"00:04:43"
},
{
"productid":7312,
"deviceid":2479989,
"channelid":2,
"protocoltype":"RTMP",
"clientip":"172.19.3.99",
"videocodec":"H264",
"resolution":"1280
720",
"fps":25,
"audiocodec":"",
"bandwidth":63066,
"onlinetime":"00:07:00"
}
],
"page_info":
{
"total_num":3,
"page_total":2,
"page_size":2,
"current_page":1,
"page_key":"fc94c7c4-0760-4523-876c-5583260520c6"
}
}
说明 1)对于实时查询,第一页之后的数据查询,需要传入page_key
2)分页数据服务器只缓存5分钟,5分钟之后将失效

15.2推流记录列表查询

HTTP方法 GET
URL http://API_ADDRESS/stat/getpushlist
HTTP头部 api-key 必填
注:只能用master-key
URL参数 productid=//产品号 必填
deviceid =//设备ID
channelid=//通道号
page_key=//分页查询使用
page_size=//每页查询的数据
page=分页查询使用
HTTP内容
成功返回 {
"errno":0,
"error":"succ",
"result":
[
{
"productid":7312,
"deviceid":2479989,
"channelid":3,
"protocoltype":"RTMP",
"puship":"172.19.3.98",
"videocodec":"H264",
"resolution":"640 480",
"fps":25,
"audiocodec":"AAC",
"bandwidth":95230,
"pushtime":"00:06:37"
},
{
"productid":7312,
"deviceid":2479989,
"channelid":1,
"protocoltype":"RTMP",
"puship":"172.19.3.98",
"videocodec":"H264",
"resolution":"1280
720",
"fps":25,
"audiocodec":"",
"bandwidth":91020,
"pushtime":"00:04:43"
}
],
"page_info":
{
"total_num":3,
"page_total":2,
"page_size":2,
"current_page":1,
"page_key":"5931b760-864a-44fb-9dd0-558e7caaace0"
}
}
说明 分页查询的处理方式与播放记录列表的处理方式一致

15.3摄像头禁用/启用接口

HTTP方法 PUT
URL http://API_ADDRESS/access_control/closecamera
HTTP头部 api-key 必填
URL参数 product_id=12, //产品id
device_id=123, //设备id
id="1", //摄像头ID
HTTP内容 {
"type":1, //1为关,0为开
}
成功返回 {
"errno": 0,
"error":”succ”
}

15.4设备历史统计查询

HTTP方法 GET
URL http:// /stat/getdevicestat
HTTP头部 api-key 必填
注:只能用master-key
URL参数 productid=//产品号 必填
deviceid =//设备ID
start_time=//开始统计时间 必填 格式:”2017-11-08 00:00:00”
end_time=//结束统计时间 必填 格式:”2017-11-08 23:59:59”
page=// 必填,查询第几页
pagesize=//必填,不能超过500,每页查询的数量
HTTP内容
成功返回 {
"errno":0,
"error":"succ",
"result":
[
{
"stat_time":"2017-11-08 10:23:50",
"productid":1990,
"deviceid":2165845,
"totalpush":2,
"rtmpplay":2,
"hlsplay":0,
"rtmpupbw":154612,
"hlsupbw":0,
"rtmpdownbw":153706,
"hlsdownbw":0
},
{
"stat_time":"2017-11-08 10:24:50",
"productid":1990,
"deviceid":2165845,
"totalpush":2,
"rtmpplay":2,
"hlsplay":0,
"rtmpupbw":155907,
"hlsupbw":0,
"rtmpdownbw":155625,
"hlsdownbw":0
}
],
"page_info":
{
"total_num":50,
"page_total":25,
"page_size":2,
"current_page":1
}
}
说明

15.5产品历史统计查询

HTTP方法 GET
URL http://API_ADDRESS/stat/getproductstat
HTTP头部 api-key 必填
注:只能用master-key
URL参数 productid=//产品号 必填
start_time=//开始统计时间 必填 格式:”2017-11-08 00:00:00”
end_time=//结束统计时间 必填 格式:”2017-11-08 23:59:59”
page=// 必填,查询第几页
pagesize=//必填,不能超过500,每页查询的数量
HTTP内容
成功返回 {
"errno":0,
"error":"succ",
"result":
[
{
"stat_time":"2017-11-08 10:23:50",
"productid":1990,
"totalpush":2,
"rtmpplay":2,
"hlsplay":0,
"rtmpupbw":123456789123456800,
"hlsupbw":0,
"rtmpdownbw":153706,
"hlsdownbw":0
},
{
"stat_time":"2017-11-08 10:24:50",
"productid":1990,
"totalpush":2,
"rtmpplay":2,
"hlsplay":0,
"rtmpupbw":155907,
"hlsupbw":0,
"rtmpdownbw":155625,
"hlsdownbw":0
}
],
"page_info":
{
"total_num":50,
"page_total":25,
"page_size":2,
"current_page":1
}
}
说明

15.6产品实时汇总查询

HTTP方法 GET
URL http://API_ADDRESS/stat/getproductsummary
HTTP头部 api-key 必填
注:只能用master-key
URL参数 productid=//产品号 必填
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"result":[
{
“productid”:123456 //产品ID
“pushnum”:10 //当前总推流摄像头数目
“clientnum”:500//当前总客户端在线数目
}
]
}
说明

15.7存储管理配置接口

15.7.1视频存储套餐查询

HTTP方法 GET
URL http://API_ADDRESS/storage/product_scheme_info
HTTP头部 api-key 必填
URL参数 product_id = 1,
device_id=12, //可选参数
channel_id=1, //可选参数,没有返回设备下所有通道
status=1, //可选参数,
page_start=1,
page_size=10
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”
,"total": 0,
"scheme":[
{
"scheme_id": 1,
"type": 1, //1.循环录制,2.定时录制
"device_id": 1 ,
"channel_id": 1,
"status": 1, //1:使用中,2:已冻结,3:已过期
"start_time": "格式化时间字符串", 开始时间
"expire_time": "格式化时间字符串",过期时间
"param": {} // 套餐参数,详见说明
}
],
"page_info":
{
"total_num":50,
"page_total":25,
"page_size":2,
"current_page":1
}

}
说明 param格式
循环录制:
{
"cycle": 7, //循环录制天数, 7天循环录制
"expire": 30, // 有效期天数,
30天月卡,90天季卡,365年卡
}

定时录制:
{
" schedule ":
{
"moday": [{
"start_time": "01:00",
"end_time": "02:00"
}]
},
{
"sunday": [{
"start_time": "01:00",
"end_time": "02:00"
}]
}
}

15.7.2定时录制计划更新

HTTP方法 PUT
URL http://API_ADDRESS/storage/update_record_schedule
HTTP头部 api-key 必填
Content-Type:application/json
URL参数 device_id=12,
channel_id=1
HTTP内容 {
"schedule": [
{
"monday":[{
"start_time":"01:00",
"end_time":"02:00"
}]
},
{"sunday":[{
"start_time":"01:00",
"end_time":"02:00"
}]
}
}
}
成功返回 {
"errno": 0,
"error":”succ”
}
说明 只有类型为定时录制的才能修改,否则返回失败

15.7.3最新套餐查询

HTTP方法 GET
URL http://API_ADDRESS/storage/current_scheme
HTTP头部 api-key 必填
URL参数 device_id=12,
channel_id=1
HTTP内容
成功返回 {
"errno": 0,
"error":”succ”,
"total": 0,
"scheme": {
"scheme_id": 1,
"type": 1, //1.循环录制,2.定时录制
"device_id": 1 ,
"channel_id": 1,
"status": 1, //1:使用中,2:已冻结,3:已过期
"start_time": "格式化时间字符串", 开始时间
"expire_time": "格式化时间字符串",过期时间
"param": {} // 套餐参数,详见说明
}
说明 param格式
循环录制:
{
"cycle": 7, //循环录制天数, 7天循环录制
"expire": 30, // 有效期天数,
30天月卡,90天季卡,365年卡
}

定时录制:
{
"schedule":
{
"moday": [{
"start_time": "01:00",
"end_time": "02:00"
}]
},
{
"sunday": [{
"start_time": "01:00",
"end_time": "02:00"
}]
}
}

results matching ""

    No results matching ""