查询设备列表
功能介绍
用户查询设备列表
URI
GET /v1/{user_id}/devices
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
user_id |
是 |
String |
用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
access_protocol |
否 |
String |
接入协议：枚举类型，多个使用英文逗号分隔 枚举值： |
device_name |
否 |
String |
模糊查询字段：支持设备名称模糊匹配，由字符组成，支持数字、中文（一个汉字算两个字符）、英文、-、_、空格，长度范围[0,128] |
device_state |
否 |
String |
设备状态：枚举类型，多个查询使用英文逗号分隔 枚举值： |
device_system_state |
否 |
String |
设备系统状态：枚举类型，多个查询使用英文逗号分隔 枚举值： |
device_type |
否 |
String |
设备类型：枚举类型，多个查询使用英文逗号分隔 枚举值： |
ability |
否 |
Array of strings |
查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]。能力集对应能力参考设备能力集。 |
need_cloud_ability |
否 |
Boolean |
是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false |
need_specification |
否 |
Boolean |
是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false |
direction |
否 |
String |
排序方向：枚举类型，默认降序，不区分大小写 枚举值： |
limit |
否 |
Integer |
限制条数：取值范围[0,1000]，不填写时默认值为10 |
offset |
否 |
Integer |
偏移量页数：0为第一页，取值范围[0,2147483646]，不填写时默认为0，同时offset*limit需小于2147483646 |
sort_by |
否 |
String |
排序字段：枚举类型，默认按创建时间create_time排序 枚举值： |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Access-Token |
是 |
String |
用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
devices |
Array of DeviceInfoMuti objects |
设备列表 |
total |
Integer |
查询条数 |
参数 |
参数类型 |
描述 |
|---|---|---|
device_id |
String |
设备ID，设备唯一标识符 |
device_name |
String |
设备名称 |
device_state |
String |
设备状态 枚举值： |
device_type |
String |
设备类型 枚举值： |
device_system_state |
String |
设备系统冻结 枚举值： |
create_time |
String |
创建时间 |
update_time |
String |
更新时间，在设备重新上线后或者移动设备分组后会修改时间 |
access_protocol |
Integer |
接入协议类型 |
manufacture |
String |
生产厂家 |
device_ability |
String |
设备能力集：枚举类型，参考附录设备能力集，多个能力集用英文逗号分隔 |
device_cloud_ability |
Object |
云端能力集规格 |
channel_total |
Integer |
通道总数 |
channel_online_total |
Integer |
通道在线总数 |
channel_offline_total |
Integer |
通道离线总数 |
org_list |
Array of 表6 DeviceOrgInfo objects |
设备组结果 |
sdk_ability |
String |
sdk能力集 |
请求示例
查询设备列表
GET /v1/2562572829***/devices?need_cloud_ability=true
响应示例
状态码： 200
OK
{
"total" : 2,
"devices" : [ {
"device_id" : "952352DJNR***",
"device_name" : "测试设备",
"device_state" : "ONLINE",
"device_system_state" : "NORMAL",
"device_type" : "IPC",
"manufacture" : "jovision",
"device_ability" : "ptz,talk",
"device_cloud_ability": {
"alarm_voice": {
"support": "true"
}},
"access_protocol" : "HOLO",
"channel_total" : 1,
"channel_online_total" : 1,
"channel_offline_total" : 0,
"sdk_ability" : "***",
"org_list" : {
"device_org_id" : "1234567890***",
"device_org_name" : "测试设备组织**",
"device_org_level" : "1"
},
"create_time" : "2020-06-26 20:42:16",
"update_time" : "2020-06-26 20:42:16"
}, {
"device_id" : "952352LWXT***",
"device_name" : "测试设备1",
"device_state" : "ONLINE",
"device_system_state" : "NORMAL",
"device_type" : "IPC",
"manufacture" : "jovision",
"device_ability" : "ptz,talk",
"device_cloud_ability": {
"alarm_voice": {
"support": "true"
}},
"access_protocol" : "HOLO",
"channel_total" : 1,
"channel_online_total" : 1,
"channel_offline_total" : 0,
"sdk_ability" : "***",
"org_list" : {
"device_org_id" : "1234567890***",
"device_org_name" : "测试设备组织**",
"device_org_level" : "1"
},
"create_time" : "2020-06-26 20:42:16",
"update_time" : "2020-06-26 20:42:16"
} ]
}
状态码
请参见状态码
错误码
请参见错误码
