视频监控 > API 文档 > 设备管理相关接口 >更新设备

更新设备

最近更新时间: 2022-11-28 16:21:43

描述

本接口用于更新设备。

接口请求域名：qvs.qiniuapi.com
请求方式：PATCH
接口路径：/v1/namespaces/{namespaceId}/devices/{deviceId}

请求参数

路径参数

参数名称	必填	字段类型	说明
namespaceId	是	string	空间ID
deviceId	是	string	设备Id

Body

参数名称	必填	字段类型	说明
operations	是	op数组	op集合，详见：表一

表一： OP集合参数

参数名称	必填	字段类型	说明
operations.key	是	string	要修改的参数
operations.op	是	string	op操作（目前支持replace和delete）
operations.value	是	object	要修改的参数对应的value（当op为delete的时候可以忽略）

表二： 可编辑参数说明

参数名称	字段类型	说明
name	string	设备名称（可包含字母、数字、中划线、下划线，同时支持中文；1 ~ 100 个字符长）
gbId	string	设备国标ID
username	string	用户名
password	string	密码
desc	string	设备描述
pullIfRegister	boolean	注册成功后启动拉流
alarmEnable	boolen	是否开启国标报警
alarmMethods	string	接收报警类型。多个报警类型以`,`分隔。1:电话报警,2:设备报警,3:短信报警,4:GPS报警,5:视频报警,6:设备故障报警,7其他报警。例如同时接收短信报警和视频报警，传递参数为`"3,5"`.`alarmEnable`为`true`时,改字段`不`能为空
localRecordPushEnable	boolean	本地录像上传开关，默认关闭。如果关闭此开关，本地录像上传云端接口无效
localRecordTemplate	string	开启本地录像上传开关后，选择录制模板。`该参数为模板ID`
location	地理位置参数	地理位置参数结构
location.enable	boolean	是否开启地理位置信息
location.type	int	0表示地理位置手动录入，1表示自动订阅位置信息，当`location.enable`为`True`时有效
location.longitude	float	经度，当`location.type`为`0`时有效
location.latitude	float	纬度，当`location.type`为`0`时有效
location.interval	int	订阅周期，数据范围为1~60，单位秒，默认为5秒，当`location.type`为`1`时有效

响应参数

参数名称	类型	说明
name	string	设备名称
desc	string	设备描述
nsId	string	所属的空间ID
nsName	string	所属的空间名称
gbId	string	设备国标ID
state	string	状态（offline：离线，online：在线，pushing：推流中，notReg：未注册，locked：锁定）
username	string	用户名
password	string	密码
pullIfRegister	boolean	注册成功后启动拉流，默认关闭
createdAt	integer	创建时间，Unix时间戳，秒
updatedAt	integer	更新时间，Unix时间戳，秒
lastKeepaliveAt	integer	最近心跳时间，Unix时间戳，秒
lastRegisterAt	integer	最近注册时间，Unix时间戳，秒
deviceId	string	设备id

示例

请求示例

curl --request PATCH \
  --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028 \
  --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
  --header 'content-type: application/json' \
  --data '{
	"operations":[{
		"key":"desc",
		"op":"replace",
		"value":"gb patch test"
	}]
}'

响应示例

{
  "name": "device1",
  "desc": "gb patch test",
  "nsId": "2akrarvzvyijd",
  "nsName": "gbt",
  "gbId": "31011500991320000028",
  "state": "notReg",
  "username": "username",
  "password": "password",
  "pullIfRegister": false,
  "createdAt": 1596166110,
  "updatedAt": 1596176486,
  "channels": 0,
  "lastRegisterAt": 0,
  "lastKeepaliveAt": 0,
  "deviceId":"31011500991320000028"

以上内容是否对您有帮助？