文档首页/ 视频接入服务 VIS/ API参考/ 设备管理/ 获取NVR设备通道列表
更新时间：2022-07-29 GMT+08:00
查看PDF
分享

获取NVR设备通道列表

功能介绍

此接口用于获取已经注册成功的NVR设备通道列表。

调试

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

URI

GET /v1/{project_id}/devices/{device_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

device_id

是

String

设备ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

channels_query

String

设备通道更新状态。

  • IDEL：表示设备通道列表未进行更新，或者更新失败。

  • QUERYING：表示设备通道列表更新中。

  • QUERIED：表示设备通道列表更新成功。

device_id

String

设备ID。

state

String

设备状态。

type

String

设备类型。

username

String

设备注册时所使用的GB/T28181用户名。

suffix

String

视频流名称后缀。

channels

Array of NVRChannels objects

通道列表详情。

description

String

描述信息。

created_at

String

设备注册时间。

updated_at

String

更新时间。
表4 NVRChannels

参数

参数类型

描述

channel_id

String

通道ID。

stream_id

String

通道关联的视频流ID。

stream_name

String

通道关联的视频流名称。

suffix

String

视频流名称后缀。

invitation_status

String

邀约状态。

  • UNREGISTERED：未注册。

  • ONLINE：未邀约。

  • INVITING：正在邀约。

  • INVITE_SUCCESS：邀约成功。

  • CANCELING：正在取消。

  • TEMPORARY_OFFLINE：暂时掉线。

  • OFFLINE：已下线。

tcp_priority

String

是否配置通道优先选择TCP协议传输。

  • TRUE：是。

  • FALSE：否。

默认值FALSE。

tcp_support

String

通道是否支持TCP协议传输。取值范围如下。

  • TRUE：是。

  • FALSE：否。

默认值FALSE。

created_at

String

通道注册时间，格式为：YYYY-MM-DDTHH:MM:SSZ（UTC时间）。

updated_at

String

通道更新时间，格式为：YYYY-MM-DDTHH:MM:SSZ（UTC时间）。

请求示例

GET /v1/3266392d188c47d09948b1**********/devices/91267042471***00026

响应示例

状态码： 200

正常

{
  "device_id" : "912670424711***00026",
  "channels_query" : "IDEL",
  "state" : "ONLINE",
  "type" : "NVR",
  "username" : "0000",
  "suffix" : "aaa",
  "channels" : [ {
    "created_at" : "2018-09-30T03:59:08Z",
    "stream_id" : "stream-0P5g9fQ2",
    "stream_name" : "channel_9217403129***************4031291324069792",
    "invitation_status" : "INVITE_SUCCESS",
    "suffix" : "aaa",
    "channel_id" : "9217403129**********",
    "updated_at" : "2018-09-30T03:59:08Z"
  } ],
  "description" : "description for device",
  "created_at" : "2018-09-30T03:59:08Z",
  "updated_at" : "2018-09-30T03:59:08Z"
}

状态码： 400

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

{
  "error_msg" : "Invalid request parameter, offset should be in range [0, 100000].",
  "error_code" : "VIS.0005"
}

状态码

状态码

描述

200

正常

400

请求错误。具体返回错误码请参考错误码说明
父主题： 设备管理

相关文档