功能介绍

获取长期不在线的GB28181设备列表。

• 状态为“已下线”，且三天内没有上线动作的设备。

“三天内”是指从当前时刻减去三天时间内统计的数据。

调试

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

URI

• URI 格式

GET /v1/{project_id}/operation/longTermOfflineDeviceList

• 参数说明

  参数	是否必选	类型	说明
  project_id	是	String	项目编号。

• 查询参数说明

  参数	是否必选	类型	说明
  offset	否	Integer	查询的开始位置。此参数适用于所有查询列表的接口。如果offset超过数据总条数，则结果返回空列表。 此参数为可选参数，必须与limit一起使用。与limit同时缺省时，返回所有结果。 取值范围：[0, 100000]。
  limit	否	Integer	返回结果的最大条目数。此参数适用于所有查询列表的接口。 此参数为可选参数，必须与offset一起使用。与offset同时缺省时，返回所有结果。 取值范围：[1,1000]。
  sort	否	String	返回结果的排序规则。 取值范围：ASC或DESC。 ASC表示升序。 DESC表示降序。 默认为ASC。 需要配置offset和limit参数，sort参数才会生效。
  order_by	否	String	排序的字段。 取值范围：device_id、username 、created_at 和updated_at。 默认值为created_at，即按照创建时间排序。 需要配置offset和limit参数，order_by参数才会生效。
  device_id	否	String	按照设备ID过滤。支持模糊查询。
  type	否	String	按照设备类型过滤。可选参数为IPC。
  state	否	String	按照设备状态过滤。 取值范围：UNREGISTERED、ONLINE和OFFLINE。不区分大小写。

请求消息

• 请求样例

GET /v1/{project_id}/operation/longTermOfflineDeviceList

响应消息

• 响应样例

[{
        "channels_query": "QUERIED",
        "device_id": "23882527801180000011",
        "updated_at": "2019-04-17T14:30:02Z",
        "channels": [
            {
                "device_id": "23882527801180000011",
                "stream_name": "channel_23882527801180000011_34020000001310000002_xc",
                "updated_at": "2019-04-17T12:26:24Z",
                "stream_id": "stream-a54jwZ94",
                "invitation_status": "OFFLINE",
                "tcp_priority": "FALSE",
                "tcp_support": "FALSE",
                "access_strategy": {
                    "start_time": "10:40",
                    "periodicity": "DAY",
                    "end_time": "12:00",
                    "total_length": 10,
                    "state": "STOPPED",
                    "random_strategy": "RANDOM"
                },
                "created_at": "2019-04-16T01:43:11Z",
                "suffix": "xc",
                "channel_id": "34020000001310000002"
            } 
        ],
        "created_at": "2019-04-15T09:37:58Z",
        "description": null,
        "state": "OFFLINE",
        "type": "NVR",
        "suffix": null,
        "username": "23882527801180000011"
    }]

• 参数说明

  参数	类型	说明
  device_id	String	设备ID。
  created_at	String	创建时间。 格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)
  updated_at	String	更新时间。 格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)
  state	String	设备状态。
  channels_query	String	设备通道更新状态。
  type	String	设备类型。
  description	String	描述信息。
  username	String	设备注册所使用的GB28181用户名。
  suffix	String	视频流名称后缀。
  channels	Array of strings	通道列表。

• Channel参数结构说明

  参数	类型	说明
  device_id	String	设备ID。
  channel_id	String	通道ID。
  invitation_status	String	邀约状态，包括： UNREGISTERED：未注册 ONLINE：未邀约 INVITING：正在邀约 INVITE_SUCCESS：邀约成功 CANCELING：正在取消 TEMPORARY_OFFLINE：暂时掉线 OFFLINE：已下线
  tcp_priority	String	是否配置通道优先选择TCP协议传输。 取值范围：TRUE、FALSE。 TRUE：是 FALSE：否 默认值：FALSE。
  tcp_support	String	通道是否支持TCP协议传输。 取值范围：TRUE、FALSE。 TRUE：是 FALSE：否 默认值：FALSE。
  created_at	String	通道注册时间。 格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)
  updated_at	String	通道更新时间。 格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)
  stream_id	String	通道关联视频流ID。
  stream_name	String	通道关联视频流名称。
  suffix	String	视频流名称后缀。
  access_strategy	Object	视频定时接入策略。
  start_time	String	接入策略开始时间。
  end_time	String	接入策略结束时间。
  periodicity	String	接入周期型。 取值范围：ONCE、DAY。 ONCE：执行一次。 DAY：每天执行。
  total_length	Integer	接入总时长。 单位：分钟。
  state	String	当前接入策略启用状态。包括： STOPPED：停用。 STARTED：启用。
  random_strategy	String	接入类型。包括： RANDOM：随机接入。 CONSECUTIVE：连续接入。

返回值

• 正常

  200

• 异常

  返回值	说明
  400 Bad Request	请求错误。具体返回错误码请参考错误码说明。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源或没有开通服务。
  500 Internal Server Error	服务内部错误。
  503 Service Unavailable	服务不可用。