更新时间:2021-12-27 GMT+08:00
分享

获取视频包接收率

功能介绍

获取当天有视频接入的GB/T28181设备的平均视频包接受率的列表。

说明:暂时无法提供视频包接受率数据,数据内容无意义

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/operation/todayPacketReceivedRateDeviceList

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询的开始位置,取值范围为1~100000,必须与limit一起使用。与limit同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。如果offset超过数据总条数,则结果返回空列表。

limit

Integer

返回结果的最大条目数,取值范围为1~1000,必须与offset一起使用。与offset同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。

sort

String

返回结果的排序规则。

  • ASC:表示升序。

  • DESC:表示降序。

默认为ASC,需要有offset和limit参数,sort参数才会生效。

order_by

String

排序的字段,取值范围。

  • device_id:设备Id。

  • created_at:视频流创建时间。

  • updated_at:最后更新时间。

默认值为created_at,即按照创建时间排序。需要配置offset和limit参数,order_by参数才会生效。

device_id

String

按照设备ID过滤。支持模糊查询。

type

String

按照设备类型过滤。可选参数为IPC。

state

String

按照设备状态过滤,取值范围。

  • UNREGISTERED:未注册。

  • ONLINE:未邀约。

  • OFFLINE:已下线。

不区分大小写。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

普通租户的token。

Authorization

String

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

X-Sdk-Date

String

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

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TodayPacketReceivedRateDeviceListResponse objects

请求响应成功

表5 TodayPacketReceivedRateDeviceListResponse

参数

参数类型

描述

device_id

String

设备ID。

channel_id

String

通道ID。

created_at

String

创建时间。格式为:YYYY-MM-DDTHH:MM:SSZ(UTC时间)。

updated_at

String

更新时间。格式为:YYYY-MM-DDTHH:MM:SSZ(UTC时间)。

state

String

设备状态。

packet_received_rate

String

接受包个数/期望包个数。说明:暂时无法提供视频包接受率,数据内容无意义

请求示例

GET /v1/3266392d188c47d09948b1**********/operation/todayPacketReceivedRateDeviceList

响应示例

状态码: 200

请求响应成功

{
  "total" : 1,
  "entries" : [ {
    "device_id" : "19754811241**********",
    "updated_at" : "2019-07-15T11:40:33Z",
    "created_at" : "2019-07-15T11:24:52Z",
    "packet_received_rate" : "4511/4511",
    "state" : "ONLINE",
    "channel_id" : "19754811241**********"
  } ]
}

状态码: 400

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

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

状态码

状态码

描述

200

请求响应成功

400

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

分享:

    相关文档

    相关产品

close