更新时间:2024-05-21 GMT+08:00
分享

批量删除设备

功能介绍

该接口用于批量删除设备,最大支持批量删除100个设备

URI

POST /v1/{user_id}/devices/batch-delete

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

devices

Array of strings

要移动设备ID集合:数组长度范围[1,100]

单个设备:

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

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

failed_num

Integer

删除设备失败的总数

devices

Array of DeleteDeviceResult objects

删除设备详细结果信息

表5 DeleteDeviceResult

参数

参数类型

描述

device_id

String

设备ID,设备唯一标识符

result

ResultInfo object

结果信息

表6 ResultInfo

参数

参数类型

描述

code

String

单个结果码

msg

String

单个结果信息

请求示例

批量删除设备

POST /v1/2562572829***/devices/batch-delete

{
  "devices" : [ "952352LWXT***" ]
}

响应示例

状态码: 200

OK

{
  "failed_num" : 0,
  "devices" : [ {
    "device_id" : "952352LWXT***",
    "result" : {
      "code" : "IVM.0",
      "msg" : "Success"
    }
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档