"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
请求错误。具体返回错误码请参考错误码说明
{ "error_msg" : "Invalid request parameter, offset should be in range [0, 100000].", "error_code" : "VIS.0005"
}
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/operation/longTermOfflineDeviceList
表8-15 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
表8-16 Query 参数
参数 是否必选 参数类型 描述
offset 否 Integer 查询的开始位置，取值范围为1
～100000，必须与limit一起使 用。与limit同时缺省时，返回所 有结果。该参数适用于所有查询 列表的接口。如果offset超过数 据总条数，则结果返回空列表。
limit 否 Integer 返回结果的最大条目数，取值范
围为1～1000，必须与offset一
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：已下线。
不区分大小写。
请求参数
表8-17 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 普通租户的token。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
X-Project-Id 否 String 使用AK/SK方式认证时必选，携 带项目ID信息。
响应参数
状态码： 200
表8-18 响应 Body 参数
参数 参数类型 描述
[数组元素] Array of GetEquipmen tIndexRespon se objects
请求响应成功
表8-19 GetEquipmentIndexResponse
参数 参数类型 描述
channels_quer
y String 设备通道更新状态。
device_id String 设备ID。
state String 设备状态。
type String 设备类型。
username String 设备注册时所使用的GB/T28181用户名。
suffix String 视频流名称后缀。
channels Array of EquipmentIn dexChannels objects
通道列表详情。
参数 参数类型 描述 description String 描述信息。
created_at String 创建时间。格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)。
updated_at String 更新时间。格式为：YYYY-MM-DDTHH:MM:SSZ(UTC时间)。
表8-20 EquipmentIndexChannels
参数 参数类型 描述
channel_id String 通道ID。
device_id String 设备ID。
access_strateg
y EquipmentIn
dexAccessStr ategy object
视频定时接入策略。
stream_id String 通道关联的视频流ID。
stream_name String 通道关联的视频流名称。
suffix String 视频流名称后缀。
invitation_stat
us 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时间）。
表8-21 EquipmentIndexAccessStrategy
参数 参数类型 描述
random_strat
egy String 接入类型。包括如下。
● RANDOM：随机接入。
● CONSECUTIVE：连续接入。
start_time String 接入策略开始时间。
end_time String 接入策略结束时间。
total_length Integer 接入总时长。单位：分钟。
periodicity String 接入周期型。取值范围如下。
● ONCE：执行一次。
● DAY：每天执行。
state String 前接入策略启用状态。可选值如下。
● STOPPED：停用。
● STARTED：启用。
请求示例
GET /v1/3266392d188c47d09948b1**********/operation/longTermOfflineDeviceList
响应示例
状态码： 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
请求错误。具体返回错误码请参考错误码说明
{ "error_msg" : "Invalid request parameter, offset should be in range [0, 100000].", "error_code" : "VIS.0005"
}
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/operation/shortTermOfflineDeviceList
表8-22 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID