# 获取曾经上线的设备列表 #### 功能介绍 获取当前project下，获取曾经上线的GB/T28181设备列表，即只要上线过的设备信息都会显示。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=VIS&api=ListPastOnlineDevices)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET /v1/{project_id}/operation/pastOnlineDeviceList 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-vis/vis_03_0005.html) | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 查询的开始位置，取值范围为1～100000，必须与limit一起使用。与limit同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。如果offset超过数据总条数，则结果返回空列表。 | | limit | 否 | Integer | 返回结果的最大条目数，取值范围为1～1000，必须与offset一起使用。与offset同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。 | | sort | 否 | String | 返回结果的排序规则。 - ASC：表示升序。 - DESC：表示降序。 默认为ASC，需要有offset和limit参数，sort参数才会生效。 | | order_by | 否 | String | 排序的字段，取值范围。 - username：用户名。 - 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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | channels_query | String | 设备通道更新状态。 | | device_id | String | 设备ID。 | | state | String | 设备状态。 | | type | String | 设备类型。 | | username | String | 设备注册时所使用的GB/T28181用户名。 | | suffix | String | 视频流名称后缀。 | | channels | Array of [EquipmentIndexChannels] objects | 通道列表详情。 | | description | String | 描述信息。 | | created_at | String | 创建时间。格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)。 | | updated_at | String | 更新时间。格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)。 | 表5EquipmentIndexChannels | 参数 | 参数类型 | 描述 | |:---|:---|:---| | channel_id | String | 通道ID。 | | device_id | String | 设备ID。 | | access_strategy | [EquipmentIndexAccessStrategy] object | 视频定时接入策略。 | | 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时间）。 | 表6EquipmentIndexAccessStrategy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | random_strategy | String | 接入类型。包括如下。 - RANDOM：随机接入。 - CONSECUTIVE：连续接入。 | | start_time | String | 接入策略开始时间。 | | end_time | String | 接入策略结束时间。 | | total_length | String | 接入总时长。单位：分钟。 | | periodicity | String | 接入周期型。取值范围如下。 - ONCE：执行一次。 - DAY：每天执行。 | | state | String | 接入策略启用状态。可选值如下。 - STOPPED：停用。 - STARTED：启用。 | #### 请求示例 ``` GET /v1/3266392d188c47d09948b1**********/operation/pastOnlineDeviceList ``` #### 响应示例 **状态码： 200** 正常 ``` [ { "channels_query" : "QUERIED", "device_id" : "2388252780**********", "updated_at" : "2019-04-17T14:30:02Z", "channels" : [ { "device_id" : "2388252780**********", "stream_name" : "channel_2388252780**********_3402000000**********_xc", "updated_at" : "2019-04-17T12:26:24Z", "stream_id" : "stream-0P5g9fQ2", "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" : "3402000000**********" } ], "created_at" : "2019-04-15T09:37:58Z", "description" : null, "state" : "OFFLINE", "type" : "NVR", "suffix" : null, "username" : "2388252780**********" } ] ``` **状态码： 400** 请求错误。具体返回错误码请参考[错误码说明](https://support.huaweicloud.com/api-vis/vis_03_0047.html) ``` { "error_msg" : "Invalid request parameter, offset should be in range [0, 100000].", "error_code" : "VIS.0005" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 正常 | | 400 | 请求错误。具体返回错误码请参考[错误码说明](https://support.huaweicloud.com/api-vis/vis_03_0047.html) |