行业视频管理服务 IVM-查询设备列表:URI
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排序 枚举值: |