行业视频管理服务 IVM-查询设备列表:URI

时间:2024-09-11 17:17:47

URI

GET /v1/{user_id}/devices

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节

表2 Query参数

参数

是否必选

参数类型

描述

access_protocol

String

接入协议:枚举类型,多个使用英文逗号分隔

枚举值:

  • HOLO 好望协议

  • GB28181 国标协议

device_name

String

模糊查询字段:支持设备名称模糊匹配,由字符组成,支持数字、中文(一个汉字算两个字符)、英文、-、_、空格,长度范围[0,128]

device_state

String

设备状态:枚举类型,多个查询使用英文逗号分隔

枚举值:

  • OFFLINE 离线

  • ONLINE 在线
  • UNREGISTERED 未注册

device_system_state

String

设备系统状态:枚举类型,多个查询使用英文逗号分隔

枚举值:

  • NORMAL 正常

  • UNAVAILABLE_FROZEN 冻结

device_type

String

设备类型:枚举类型,多个查询使用英文逗号分隔

枚举值:

  • IPC 直连摄像机

  • NVR NVR设备

  • MEdge IVS1800设备

ability

Array of strings

查询的能力集列表:不传默认查询所有能力集,数组长度范围[0,10]。能力集对应能力参考设备能力集

need_cloud_ability

Boolean

是否需要返回云上管理的能力集:false,不返回云上能力集信息;true,返回云上能力集信息。不填默认false

need_specification

Boolean

是否需要能力规格:false,不返回能力规格;true,返回能力规格。不填默认false

direction

String

排序方向:枚举类型,默认降序,不区分大小写

枚举值:

  • ASC 升序

  • DESC 降序

limit

Integer

限制条数:取值范围[0,1000],不填写时默认值为10

offset

Integer

偏移量页数:0为第一页,取值范围[0,2147483646],不填写时默认为0,同时offset*limit需小于2147483646

sort_by

String

排序字段:枚举类型,默认按创建时间create_time排序

枚举值:

  • create_time 创建时间

  • update_time 更新时间

support.huaweicloud.com/api-ivm/ivm_03_0039.html