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

批量设置通道存储时间策略

功能介绍

批量设置通道存储时间策略。一次最多设置100个通道。

URI

PUT /v1/{user_id}/devices/channels/time-policy

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

channel_time_policies

Array of ChannelTimePolicy objects

设置设备通道留存期:长度范围[1,100]

表4 ChannelTimePolicy

参数

是否必选

参数类型

描述

device_id

String

设备ID:

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

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

channel_id

String

通道ID:

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

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

time_policies

Array of TimePolicy objects

资源储存留存期集合:长度不可为0

表5 TimePolicy

参数

是否必选

参数类型

描述

storage_days

Integer

(单位:天) 留存期,留存期取值范围:[1,365]

storage_type

String

留存期类型:计划录像:PLAN_RECORD 动检录像:MOTION_RECORD

枚举值:

  • PLAN_RECORD 计划录像

  • MOTION_RECORD 动检录像

响应参数

状态码: 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/time-policy

{
  "channel_time_policies" : [ {
    "device_id" : "952352LWXT***",
    "channel_id" : "0",
    "time_policies" : [ {
      "storage_days" : 15,
      "storage_type" : "PLAN_RECORD"
    }, {
      "storage_days" : 15,
      "storage_type" : "MOTION_RECORD"
    } ]
  }, {
    "device_id" : "952352DJNR***",
    "channel_id" : "1",
    "time_policies" : [ {
      "storage_days" : 15,
      "storage_type" : "PLAN_RECORD"
    } ]
  } ]
}

响应示例

状态码: 200

OK

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

状态码

请参见状态码

错误码

请参见错误码

相关文档