千眼一平台是云计算PaaS.docx
- 文档编号:27420072
- 上传时间:2023-06-30
- 格式:DOCX
- 页数:20
- 大小:20.37KB
千眼一平台是云计算PaaS.docx
《千眼一平台是云计算PaaS.docx》由会员分享,可在线阅读,更多相关《千眼一平台是云计算PaaS.docx(20页珍藏版)》请在冰豆网上搜索。
千眼一平台是云计算PaaS
监控平台接口文档
作者
版本
修改日期
备注
刘洋
2016-1-18
蔡文勇
2016-03-07
夏祥均
2016-05
刘洋
2016-7-22
修缮
目录
目录2
1.文档说明3
1.1.接口说明3
1.2.接口命名规则3
1.3.术语与缩写解释3
2.监控平台接口4
2.1检测账号是否存在(0721)4
2.2创建账号(0513)4
2.3获取用户列表(0513)4
2.4删除账号5
2.5重置密码5
2.6获取设备列表5
2.7获取设备型号列表6
2.8添加设备(0513)6
2.9删除设备(0513)7
2.10修改设备/通道名称7
2.11新增通道给用户8
2.12删除用户通道8
2.13获取设备平台号8
2.14获取账号授权码9
2.15重置授权码9
2.16申请在线观看9
2.17获取视频截图10
3.错误列表(待定)10
4.设备型号定义11
1.文档说明
1.1.接口说明
1)第三方请求和回应的参数都采用JSON的格式,并且是ssl连接
2)通迅采用httppost协议
3)第三方操作时需要在HTTP的head区指定如下字段
header_name
header_value
description
Accept
application/json
服务器端返回给客户端的数据类型
Content-Type
application/json
客户端发到服务器端的是数据类型
Authorization
$Token
由平台关产生的apitoken,用来标识第三方应用,第三方应用需要保管好,防止泄漏,泄漏后需要在平台重置这个apitoken
调用示例:
添加用户:
http:
//ip:
port/openapi/account/add
1.2.接口命名规则
1)接口名称、参数、返回值均采用字母小写命名规则,多个单词用下划线’_’分隔
2)参数前面符号:
*表示内容必填项;!
表示内容可选项;
1.3.术语与缩写解释
缩写、术语
解释
app
第三方应用
apiSvr
监控平台公用api服务
2.监控平台接口
2.1检测账号是否存在(0721)
调用模式
app->apiSvr
模块路径
/openapi/account/check_account
接口参数
*
account
string
用户账号
返回数据
*
ret
int
0-成功,!
0-失败(错误代码)
*
msg
string
返回说明
补充说明
Account规则:
4-24字符
返回值0:
表示该账号不存在
非0:
表示Error或该账号存在
2.2创建账号(0513)
调用模式
app->apiSvr
模块路径
/openapi/account/add
接口参数
*
account
string
用户账号
*
password
string
密码
*
type
int
0:
企业账号,1:
企业内员工账号,2:
个人账号
!
parent_account
string
如果为企业员工账号,则必须指定父账号,其它类型无效
返回数据
*
ret
int
0-成功,!
0-失败(错误代码)
*
msg
string
返回说明
*
auth
string
账号客户端登录授权码
补充说明
Account规则:
4-24字符
注意:
type类型的企业账号不能创建个人账号,只能创建企业员工账号
2.3获取用户列表(0513)
调用模式
app->apiSvr
模块路径
/openapi/account/list
!
keyword_account
string
查询关键字
*
page_num
int
页码
*
page_size
int
每页条目(默认10)
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
size
int
总条目数
*
page_size
int
当前页条目数
*
page
int
当前页码
!
list
Array(json)
*
account
string
用户账号
*
created_time
datetime
创建时间
*
type
int
账号类型
!
parent_account
string
父账号
补充说明
2.4删除账号
调用模式
app->apiSvr
模块路径
/openapi/account/del
接口参数
*
account
string
用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
2.5重置密码
调用模式
app->apiSvr
模块路径
/openapi/account/ret_pwd
接口参数
*
account
string
用户账号
*
password
string
用户密码
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
2.6获取设备列表
调用模式
app->apiSvr
模块路径
/openapi/device/list
接口参数
*
account
string
用户账号
!
keyword_device_name
string
查询关键字
*
page_num
int
页码
*
page_size
int
每页条目(默认10)
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
size
int
总条目数
*
page_size
int
当前页条目数
*
page
int
当前页码
!
list
Array(Json)
*
device_no
int
平台号
*
device_serial
string
设备序列号。
*
device_type_name
string
设备类型名称
*
nick_name
string
设备名称
*
longitude
double
经度
*
latitude
double
纬度
*
type
int
设备归属状态(0-容器设备,1-通道,2-分享通道,3-授权)
*
list
array(json)
*
chan_no
int
通道序号
*
name
string
通道名称
补充说明
2.7获取设备型号列表
调用模式
app->apiSvr
模块路径
/openapi/device/getdevtype
接口参数
--
返回数据
*
ret
int
0-成功,!
0-失败
!
list
Array(Json)
*
device_type_id
string
设备类型id
*
device_type_name
string
设备类型名称
补充说明
设备型号定义
2.8添加设备(0513)
调用模式
app->apiSvr
模块路径
/openapi/device/add
接口参数
*
device_serial
String
要添加的设备序列号
*
device_type_id
String
设备类型id
*
account
string
用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
device_no
int64
平台号
补充说明
2.9删除设备(0513)
调用模式
app->apiSvr
模块路径
/openapi/device/del
接口参数
*
device_serial
String
设备序列号
*
account
string
用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
2.10修改设备/通道名称
调用模式
app->apiSvr
模块路径
/openapi/device/update
接口参数
*
device_serial
string
设备序列号
*
account
string
用户账号
*
chan_no
int
通道序号(针对设备时,该字段取值为0)
*
name
string
设备名称。
不修改则置空
*
osd
int
0-不同步到设备,1-同步到设备
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
2.11新增通道给用户
调用模式
app->apiSvr
模块路径
/openapi/device/add_bind
接口参数
*
account
string
用户账号
*
device_serial
string
设备序列号
*
chan_no_list
array(int)
通道序号数组
*
bind_account
array(string)
目标用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
2.12删除用户通道
调用模式
app->apiSvr
模块路径
/openapi/device/remove_bind
接口参数
*
account
string
用户账号
*
device_serial
string
设备序列号
*
chan_no_list
array(int)
通道序号数组
*
bind_account
array(string)
目标用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
2.13获取设备平台号
调用模式
app->apiSvr
模块路径
/openapi/device/get_dpid
接口参数
*
device_serial
string
设备序列号
*
chan_no
int
通道序号(针对容器设备时,该字段取值为0)
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
dpid
int64
设备平台号
补充说明
1)若用户需要查询容器设备中通道的平台id,则chan_no为通道在设备中的序号,例如ipc设备只有一个通道,序号固定取值为1
2.14获取账号授权码
调用模式
app->apiSvr
模块路径
/openapi/account/getauth
接口参数
*
account
String
用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
auth_code
string
账号授权码
补充说明
2.15重置授权码
调用模式
app->apiSvr
模块路径
/openapi/account/reset_auth_code
接口参数
*
account
string
用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
auth_code
string
重置后的授权码
补充说明
2.16申请在线观看HLS地址
调用模式
app->apiSvr
模块路径
/openapi/preview/ctrlplay
接口参数
*
account
string
用户账号
*
device_serial
string
设备序列号
*
chan_no
int
通道序号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
address_url
string
播放地址
补充说明
1)根据账号与密码申请通道的播放地址
2.17获取视频截图
调用模式
app->apiSvr
模块路径
/openapi/preview/get_screenshot
接口参数
*
account
string
用户账号
*
device_serial
string
设备序列号
*
chan_no
int
通道序号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
base64_img
string
base64编码格式的截图数据
*
img_type
int
图片格式(0-jpg)
*
*mg_width
int
图片宽度(单位px)
*
*mg_height
int
图片高度(单位px)
补充说明
2.18获取通道的温湿度信息
调用模式
app->apiSvr
模块路径
/openapi/extinfo/sensor
*
device_serial
string
设备序列号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
channels
array(object)
传感器状态
chid
int
通道编号,编号从1开始
temperature
float
温度值
humidity
float
湿度值
补充说明
2.19申请手机观看页面
调用模式
app->apiSvr
模块路径
/openapi/preview/html5
*
device_serial
string
设备序列号
*
chan_no
int
通道序号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
*
html5_url
string
HTML5播放地址
补充说明
2.20删除指定账号下的所有设备
调用模式
app->apiSvr
模块路径
/openapi/device/remove_all_bind
接口参数
*
account
string
用户账号
*
bind_account
array(string)
目标用户账号
返回数据
*
ret
int
0-成功,!
0-失败
*
msg
string
返回说明
补充说明
3.错误列表(待定)
错误编号
错误描述
说明
0
没有错误发生
-1
未知错误(或系统内部错误)
-2
参数缺失
详见返回错误描述
-3
无效的会话ID
表示由netsdk_alloc分配的ip失效了
-4
网络连接失败
-5
拒绝访问
鉴权失败
-6
对方不在线
-7
错误的会话ID
把错误的会话ID用做函数操作
-8
请求超时
-9
获取网关信息失败
无法取得网关信息
-10
数据错误
-2001
超过可添加的最大账号数量限制
-2002
超过可添加的最大通道数量限制
-2003
超过可绑定的最大通道数量限制
-3001
用户已经存在
-3002
用户不存在或该用户不是你的下级用户
-3003
含有下级用户,不能删除
-4001
设备不存在
-4002
设备已存在
-4003
该用户类型不能添加设备
-4004
不能操作不属于该账号的设备
-4005
不能修改分享而来的设备名称
-5001
设备类型不存在
4.设备型号定义
设备型号
设备型号名称
通道数
IPC-AN-SZ-02
AN高速球
1
IPC-AN-SZ-04
AN枪机
1
IPC-LT-SZ-00
LT云台机
1
IPC-LT-SZ-01
LT卡片机
1
IPC-LT-SZ-02
LT高速球
1
IPC-LT-SZ-03
LT中速球
1
IPC-LT-SZ-04
LT枪机
1
IPC-LT-SZ-05
LT3G枪机
1
SJCJ
手机采集
1
SWH-SL-MN-16D1
SWH16路D1(模拟)
16
SWH-SL-MN-21080P
SWH2路1080P(模拟)
2
SWH-SL-MN-2720P
SWH2路720P(模拟)
2
SWH-SL-MN-41080P
SWH4路1080P(模拟)
4
SWH-SL-MN-4720P
SWH4路720P(模拟)
4
SWH-SL-MN-4D1
SWH4路D1(模拟)
4
SWH-SL-MN-8720P
SWH8路720P(模拟)
8
SWH-SL-MN-8D1
SWH8路D1(模拟)
8
SWH-SL-SZ-16D1
SWH16路D1(数字)
16
SWH-SL-SZ-21080P
SWH2路1080P(数字)
2
SWH-SL-SZ-2720P
SWH2路720P(数字)
2
SWH-SL-SZ-41080P
SWH4路1080P(数字)
4
SWH-SL-SZ-4720P
SWH4路720P(数字)
4
SWH-SL-SZ-4D1
SWH4路D1(数字)
4
SWH-SL-SZ-8720P
SWH8路720P(数字)
8
SWH-SL-SZ-8D1
SWH8路D1(数字)
8
IPC-LT-SZ-06
LT半球
1
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 千眼一 平台 计算 PaaS