文档首页/ 视频接入服务 VIS/ API参考/ 设备管理/ 更新GB/T28181设备通道信息
更新时间:2022-07-29 GMT+08:00
分享

更新GB/T28181设备通道信息

功能介绍

该接口用于GB/T28181设备进行“视频邀约”和“取消邀约”,配置优先使用TCP传输的配置。

接口约束

GB/T28181设备通道视频流名称后缀不允许修改。

调试

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

URI

PUT /v1/{project_id}/devices/{device_id}/channels/{channel_id}

表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参数

参数

是否必选

参数类型

描述

state

String

视频流状态。

  • ACTIVE:进行视频邀约。

  • STOPPED:断开视频。

不区分大小写。

tcp_priority

String

是否优先使用TCP传输的配置。

  • TRUE:如果IPC设备支持TCP协议传输,通道进行视频邀约时优先使用TCP协议接入到VIS服务中。

  • FALSE:IPC设备通道进行视频邀约时优先使用UDP协议接入到VIS服务中。NVR设备通道暂时不支持配置相关配置。

默认值FALSE。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

String

处理成功时返回

请求示例

PUT /v1/3266392d188c47d09948b1**********/devices/device123123sadf/channels/chanadfasdf

{
  "state" : "ACTIVE"
}

响应示例

状态码: 200

正常

{
  "result" : "success"
}

状态码: 400

请求错误。具体返回错误码请参考错误码说明

{
  "error_msg" : "The device is not successfully registered or is offline.",
  "error_code" : "VIS.0312"
}

状态码

状态码

描述

200

正常

400

请求错误。具体返回错误码请参考错误码说明

相关文档