文档首页/ 视频接入服务 VIS/ API参考/ 设备管理/ 更新GB/T28181设备通道接入策略
更新时间：2024-07-03 GMT+08:00
查看PDF
分享

更新GB/T28181设备通道接入策略

功能介绍

该接口用于设置GB/T28181设备的视频接入策略。用户可以通过设置接入策略定时自动进行设备的接入。

定时接入策略分为随机接入和连续接入两种采集类型。

  • 随机接入：在开始时间和结束时间内，随机采集总时长为total_length参数值的视频。
  • 连续接入：从开始时间连续采集时长为total_length参数值的视频。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/devices/{device_id}/channels/{channel_id}/access-strategy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID

device_id

是

String

设备ID

channel_id

是

String

通道ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

普通租户的token。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。
表3 请求Body参数

参数

是否必选

参数类型

描述

random_strategy

否

String

视频采集类型，可选值如下。

  • RANDOM：表示使用随机采集方法。在开始时间和结束时间内，随机采集总时长为total_length参数值的视频。

    随机策略说明：

    一天内从start_time到end_time的时间，会随机分成若干个时间分片（总分片个数不超过6个），每个时间分片最短为10min，最长不超过total_length时间，每两个时间分片之间的间隔至少为20min。时间分片之间的间隔即视频起始时间的间隔，例如中间断开10min，也就是间隔至少20min。

    如果设置为每天执行采集（即“periodicity”为“DAY”），每天的时间分片会重新随机生成，以保证每天接入的时间分片不同。

    如果更新了接入策略（例如修改了start_time、total_length等参数），并且当前接入策略运行状态为ACTIVE，则会重新生成分片，其中分片开始时间早于当前时间的不会在当天执行，分片开始时间晚于当前时间的会在当天执行。

  • CONSECUTIVE：表示从开始时间连续采集时长为total_length参数值的视频。

默认值为RANDOM，不区分大小写。

start_time

否

String

一天中视频接入的开始时间，时间格式为HH:MM，取值范围是00:10～23:40。分钟数值须为10的倍数，例如10:10、10:20、10:30等。第一次设置接入策略时，该参数必填。后续更新接入策略时，该参数可选。

end_time

否

String

一天中视频接入的结束时间，时间格式为HH:MM，取值范围是00:10～23:50。分钟数值须为10的倍数，如23:10、23:20等。end_time必须晚于start_time。第一次设置视频采集类型为RANDOM时，该参数必填。后续更新接入策略时，该参数可选采集类型为CONSECUTIVE时，该参数被忽略。

total_length

否

Integer

视频接入总采集时长，单位：分钟。参数值须为10的倍数，最小值为10分钟，最大值根据用户的配额决定。不同的视频采集类型，total_length有不同的配额设置：采集类型为RANDOM时，start_time加上total_length后的时间不能超过end_time。采集类型为CONSECUTIVE时，start_time加上total_length后的时间不能超过24:00，即采集时长不允许跨天。第一次设置接入策略时，该参数必填。后续更新接入策略时，该参数可选。

periodicity

否

String

采集周期，可选值如下。

  • ONCE：表示采集一次。
  • DAY：表示每天执行。

默认值为DAY，不区分大小写。

state

否

String

视频接入状态，可选值如下。

  • ACTIVE：表示激活当前视频接入策略。
  • STOPPED：表示停止当前视频接入策略。

默认值为STOPPED，不区分大小写。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

result

String

处理成功时返回

请求示例

PUT /v1/3266392d188c47d09948b1**********/devices/9339084235*****000001/channels/ 933908423****0000001/access-strategy

{
  "start_time" : "10:00",
  "end_time" : "18:00",
  "total_length" : 240,
  "random_strategy" : "RANDOM",
  "periodicity" : "DAY",
  "state" : "STOPPED"
}

响应示例

状态码： 200

正常

{
  "result" : "success"
}

状态码： 404

找不到资源或没有开通服务。具体返回错误码请参考错误码说明

{
  "error_msg" : "Failed to find the device.",
  "error_code" : "VIS.0302"
}

状态码

状态码

描述

200

正常

404

找不到资源或没有开通服务。具体返回错误码请参考错误码说明
父主题： 设备管理

相关文档