文档首页/行业视频管理服务 IVM/API参考/设备管理/修改设备信息
更新时间：2025-05-09 GMT+08:00
查看PDF
分享

修改设备信息

功能介绍

好望设备修改设备名称，国标设备修改设备名称与OSD（设备若有多条osd，仅支持修改第一条osd），设备处于上线状态才可以修改设备名称

URI

PUT /v1/{user_id}/devices/{device_id}

表1 路径参数

参数

是否必选

参数类型

描述

device_id

是

String

设备ID：

好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型

user_id

是

String

用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

表3 请求Body参数

参数

是否必选

参数类型

描述

device_name

否

String

设备名称：字符组成，支持数字、中文（一个汉字算两个字符）、英文大小写、空格、-、_，长度范围[1,128]

description

否

String

设备描述：字符组成，支持数字、中文（一个汉字算两个字符）、英文大小写、空格、-、_，长度范围[1,128]

modify_type

否

String

修改类型：枚举类型，默认值DEFAULT。

好望设备不检测该参数

枚举值：

  • DEFAULT

    国标协议接入设备按参数device_name修改设备名称和osd，仅设备在线可修改。此时需要device_name字段有值

  • OSD 设备osd修改，仅支持国标协议接入的设备，仅设备在线可修改。此时需要参数osd字段有值
  • DEVICE_NAME 设备名称修改，仅支持国标协议接入的设备，无论设备什么状态均可修改。此时需要参数device_name字段有值
  • ALL 分别按device_name和osd修改，仅支持国标协议接入的设备，仅设备在线可修改。此时参数osd、参数device_name字段均需有值

osd

否

String

osd内容：长度范围[1,63]，一个中文占3个字节

说明：

在modify_type为DEFAULT或者DEVICE_NAME时忽略此参数。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

device_name

String

设备名称

description

String

设备描述

device_id

String

设备ID，设备唯一标识符

osd

String

osd内容

请求示例

修改的设备信息

PUT /v1/2562572829***/devices/952352DJNR***

{
"device_name" :  "测试设备",
"description" : "用于测试",
"modify_type": "ALL",
"osd":"osd测试"
}

响应示例

状态码： 200

OK 
{
  "device_id" : "952352DJNR***",
  "device_name" : "测试设备",
  "description" : "用于测试",
  "osd":"osd测试"
}

状态码

请参见状态码

错误码

请参见错误码

父主题：设备管理

相关文档