功能描述
用于新增单个设备。添加设备之后,可根据返回结果到设备上进行配置,配置后等待设备注册/推流。
请求
请求 url
POST /ivc/cms/device/add
请求参数
此接口无请求参数。
请求头
请求体
该请求操作的实现需要有如下请求体。
{"Name": "hik1","AccessProtocol": 1,"Type": 1,"TransportProtocol": 1,"Password": "123456","Description": "description","OrganizationId": "1001","ClusterId": "0022c12a-e220-42e0-975f-800f872fc89e"}
具体数据描述如下:
参数名称  | 类型  | 描述  | 必须  | 备注  | 
Name  | string  | 设备名称  | 是  | 仅支持中文、英文、数字、_、-,长度不超过32个字符;(设备名称无需全局唯一,可以重复)  | 
AccessProtocol  | int  | 设备接入协议  | 是  | 1:RTMP,2:GB  | 
Type  | int  | 设备类型  | 是  | 1:IPC,2:NVR;(若设备接入协议选择 RTMP,则设备类型只能选择 IPC)  | 
TransportProtocol  | int  | 设备流传输协议  | 否  | 1:UDP,2:TCP;(国标设备有效,不填写则默认 UDP 协议)  | 
Password  | string  | 设备密码  | 否  | 仅国标设备有效,仅支持数字组合,长度为6-16个字符  | 
Description  | string  | 设备描述  | 否  | 仅支持中文、英文、数字、_、-,长度不超过128个字符  | 
OrganizationId  | string  | 设备所属组织 ID  | 是  | 从查询组织接口中获取  | 
ClusterId  | string  | 设备接入服务节点 ID  | 是  | 从查询设备可用服务节点接口中获取  | 
响应
响应头
响应体
该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:
{"RequestId": "","Code": 0,"StatusCode": 200,"Message": "ok","Data": {"Id": "0022c12a-e220-42e0-975f-800f872fc89e","Code": "61010000001320000001","Name": "hik1","AccessProtocol": 1,"Type": 1,"ClusterId": "0022c12a-e220-42e0-975f-800f872fc89e","ClusterName": "上海一区","TransportProtocol": 1,"Password": "123456","Description": "description","Status": 0,"OrganizationId": "1001"}}
字段名  | 类型  | 描述  | 备注  | 
RequestId  | string  | 请求 ID  | -  | 
Code  | int  | 状态码,0 成功,500 操作失败  | -  | 
StatusCode  | int  | 错误码,200 OK,其他详见错误中心  | -  | 
Message  | string  | 返回消息  | -  | 
Data  | object  | 返回结果  | -  | 
Data
字段名  | 类型  | 描述  | 备注  | 
ID  | string  | 设备 ID  | -  | 
Code  | string  | 设备编码(即我们为设备生成的20位国标编码)  | -  | 
Name  | string  | 设备名称  | -  | 
AccessProtocol  | int  | 设备接入协议  | 1:RTMP,2:GB  | 
Type  | int  | 设备类型  | 1:IPC,2:NVR  | 
ClusterId  | string  | 设备接入服务节点 ID  | -  | 
ClusterName  | string  | 设备接入服务节点名称  | -  | 
TransportProtocol  | int  | 设备流传输协议  | 1:UDP,2:TCP  | 
Password  | string  | 设备密码  | -  | 
Description  | string  | 设备描述  | -  | 
Status  | int  | 设备状态  | 0:未注册,1:在线,2:离线,3:禁用  | 
OrganizationId  | string  | 设备所属组织 ID  | -  |