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

批量开通设备通道服务

功能介绍

通道绑定资源(视图接入调阅、连续云存储、动检云存储、行业数据流)能力,支持批量。

每个通道同时只能绑定每类资源中的一个资源,不区分按需和套餐;同类资源间支持变更资源绑定,使用不同资源ID调用该接口即可;同一个资源不允许重复开通,重复开通报错。

URI

POST /v1/{user_id}/devices/channels/resources

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

resource_id

String

资源ID:该资源ID可从查询包周期和按需资源列表接口进行获取

storage_day

Float

存储天数:例如连续收录中录像的存储天数等

当resourceID为连续收录按需服务、行业数据流按需服务、动检云存储按需服务三种按需资源时必传,参数范围为[1,365], 不传报错

当resourceID为包周期资源时不传,默认值为0, 传非0值报错

channels

Array of Channel objects

通道信息

表4 Channel

参数

是否必选

参数类型

描述

device_id

String

设备ID:

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

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

channel_id

String

通道ID:

好望设备:取值范围[0,999]

国标设备:由数字组成,长度为20个字符,由客户自行在设备侧设置,可以在web界面获取

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

failed_num

Integer

开通失败设备数

channels

Array of Device objects

通道列表

表6 Device

参数

参数类型

描述

device_id

String

设备ID

channel_id

String

通道ID

result

Result object

错误或成功信息

表7 Result

参数

参数类型

描述

code

String

错误码

msg

String

错误码描述信息

请求示例

用户【123456781234567812345***】设备开通【MANAGE】类型按需

/v1/123456781234567812345***/devices/channels/resources

{
  "resource_id" : "d84c8cbabb8145b390bced5f2a774af6",
  "storage_day" : 7,
  "channels" : [ {
    "device_id" : "1abcdef8",
    "channel_id" : "1"
  }, {
    "device_id" : "12345678901234******",
    "channel_id" : "2"
  } ]
}

响应示例

状态码: 200

OK

{
  "failed_num" : 0,
  "channels" : [ {
    "device_id" : "34020000001*********",
    "channel_id" : "34020000001*********",
    "result" : {
      "code" : "IVM.0",
      "msg" : "Success"
    }
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档