文档首页/ 行业视频管理服务 IVM/ API参考/ 录像配置管理/ 批量设置通道录像计划
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

批量设置通道录像计划

功能介绍

批量为通道设置录像计划。通道与录像计划是一一对应的关系。一次最多设置100个通道。

URI

PUT /v1/{user_id}/devices/channels/record-plan

表1 路径参数

参数

是否必选

参数类型

描述

user_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取
表3 请求Body参数

参数

是否必选

参数类型

描述

plans

是

Array of ChannelBindRecordPlan objects

通道设置录像计划

record_type

否

String

录像类型：枚举类型，默认为NORMAL_RECORD。

枚举值：

  • NORMAL_RECORD 标准连续云存
表4 ChannelBindRecordPlan

参数

是否必选

参数类型

描述

device_id

是

String

设备ID：

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

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

channel_id

是

String

通道ID：

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

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

all_day

否

Boolean

是否全程录像：枚举类型，默认为false。如果为true，time_sections省略

枚举值：

  • true 是
  • false 否

time_sections

否

Array of TimeSection objects

通道录像计划时间段：取值范围[1,+∞)。如果all_day字段为空或为false，则字段必填
表5 TimeSection

参数

是否必选

参数类型

描述

day_of_week

是

Integer

日期：取值范围[1,7]（对应周一~周日）

start_time

是

String

录像开始时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59]

end_time

是

String

录像结束时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59]

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

failed_num

Integer

失败数量

channels

Array of ChannelResult objects

通道结果
表7 ChannelResult

参数

参数类型

描述

device_id

String

设备ID：

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

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

channel_id

String

通道ID：

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

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

result

Result object

结果信息
表8 Result

参数

参数类型

描述

code

String

错误编码

msg

String

错误信息

请求示例

批量设置通道录像计划

PUT /v1/2562572829***/devices/channels/record-plan

{
  "plans" : [ {
    "device_id" : "952352LWXT***",
    "channel_id" : "0",
    "all_day" : false,
    "time_sections" : [ {
      "day_of_week" : 1,
      "start_time" : "00:02:00",
      "end_time" : "00:05:00"
    }, {
      "day_of_week" : 1,
      "start_time" : "00:06:00",
      "end_time" : "00:08:00"
    }, {
      "day_of_week" : 2,
      "start_time" : "00:02:00",
      "end_time" : "00:05:00"
    } ]
  }, {
    "device_id" : "952352DJNR***",
    "channel_id" : "0",
    "all_day" : false,
    "time_sections" : [ {
      "day_of_week" : 1,
      "start_time" : "00:02:00",
      "end_time" : "00:05:00"
    } ]
  } ]
}

响应示例

状态码： 200

OK

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

状态码

请参见状态码

错误码

请参见错误码

父主题： 录像配置管理

相关文档