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

查询通道的录像计划

功能介绍

查询通道的录像计划详细信息

URI

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-plan

表1 路径参数

参数

是否必选

参数类型

描述

channel_id

是

String

通道ID：

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

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

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中获取

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

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

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

枚举值：

  • true 是
  • false 否

is_upload_record

Boolean

是否开启录像缓存补录：枚举类型。可以在web界面远程配置--企业统一配置--断网补录中更改此配置。

枚举值：

  • true 开启
  • false 关闭

time_sections

Array of TimeSection objects

通道录像计划时间段
表4 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]

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码：失败对应具体错误码，成功无

error_msg

String

请求失败时为：错误信息，成功无

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码：失败对应具体错误码，成功无

error_msg

String

请求失败时为：错误信息，成功无

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码：失败对应具体错误码，成功无

error_msg

String

请求失败时为：错误信息，成功无

请求示例

查询通道关联的录像计划请求示例

GET /v1/2562572829***/devices/952352DJNR***/channels/0/record-plan

响应示例

状态码： 200

OK

{
  "device_id" : "952352DJNR***",
  "channel_id" : "0",
  "all_day" : false,
  "is_upload_record": true,
  "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"
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

父主题： 录像配置管理

相关文档