IoT视频云 > API 文档 > 添加设备

添加设备

最近更新时间: 2019-07-29 10:00:18

描述

本接口用于在指定的应用下添加新的设备。

请求

请求语法

POST /v1/apps/<appid>/devices HTTP/1.1
Host: linking.qiniuapi.com
Content-Type: application/json
Authorization: <QiniuToken>

{
  "device": "<deviceName>",
  "segmentExpireDays": "<segmentExpireDays>",
  "uploadMode": "<uploadMode>",
  "type": "<Type> ",
  "maxChannel": "<maxChannel>",
  "channels":[{"channelid":"<Channelid>", "comment":"<comment>"}],
  "meta": {} 
}

请求参数

参数名称	必填	字段类型	说明
appid	是	string	设备所属应用的appid，设备名称只能由 4-200 位英文字母和数字组成

请求头
该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅公共请求头。
请求元素

参数名称	必填	字段类型	说明
device	否	string	为设备命名，设备名称只能由 4-200 位英文字母和数字组成，不指定系统会随机生产
segmentExpireDays	否	int	设备录制文件的生命周期天数，默认为-2 >0:自定义设置文件保存天数 0:不录制 -1:永久 -2:继承app配置
uploadMode	否	int	视频文件上传模式，默认为-1 -1：遵循app配置 0:遵循视频采集端配置 1:强制24小时上传 2:强制关闭上传
type	否	int	0：设备, 1：网关；类型为网关时，此项为必填
maxChannel	否	int	网关设备最大channel数,当type为1时，此项为必填
channels	否	json	频道信息，channelid：频道id，选填，不填时系统自动生成，comment：频道备注信息，选填
meta	否	json	自定义设备属性，可传递设备属性信息到设备端，meta 信息为json格式，用户自定义 json 对象即可

响应

响应头
该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅公共响应头

响应元素

200 {
  "device": "<deviceName>",
  "segmentExpireDays": "<segmentExpireDays>",
  "createdAt": "<createdTimestamp>", 
  "updatedAt": "<updatedTimestamp>",
  "type": "<Type> ",
  "maxChannel": "<maxChannel>",
  "channels":[{"channelid":"<Channelid>", "comment":"<comment>"}],
  "meta": {} 
}

参数名称	说明
device	设备名称
segmentExpireDays	文件的生命周期天数 >0:自定义设置文件保存天数 0:不录制 -1:永久 -2:继承app配置
createdAt	设备创建时间
updatedAt	设备更新时间
type	设备类型，0：设备, 1：网关
maxChannel	网关设备最大channel数,当type为网关时才显示此项
channels	频道信息，当type为网关时才显示此项，channelid：频道id，comment：频道备注信息
meta	用户自定义的设备属性信息，(为空不返回)

示例

请求示例

POST /v1/apps/test/devices HTTP/1.1

Host: linking.qiniuapi.com
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=
Content-Type: application/json

{
  "device": "testdevice1", 
  "segmentExpireDays": 7,
    "uploadMode": -1
}

响应示例

HTTP/1.1 200 OK
Access-Control-Allow-Origi: *
Connection: keep-alive
Content-Length: 184
Content-Type: application/json
Date: Wed, 26 Sep 2018 11:42:10 GMT
Server: nginx/1.8.0
Vary: Accept-Encoding
X-Reqid: 6SAAABDWHM1o8FcV
X-Whom: cs1

200 {
  "device": "testdevice1",
  "segmentExpireDays": 7,
  "createdAt": 1537853912,
  "updatedAt": 1537853912
}

400  {
    "error":  "bad request"
}

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