行业视频管理服务 IVM-查询企业下组织的设备列表:URI

时间:2024-05-21 09:38:31

URI

GET /v1/{user_id}/device-orgs/{device_org_id}/devices

表1 路径参数

参数

是否必选

参数类型

描述

device_org_id

String

设备组织ID:由数字组成,长度范围[1,25],根组织节点的值为0,可以从查询子级设备组织获取

user_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

access_protocol

String

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

枚举值:

  • HOLO 好望协议

  • GB28181 国标协议

channel_resource_state

String

通道资源状态:枚举类型,多个查询使用英文逗号分隔

枚举值:

  • MANAGEMENT_GRANT 管理套餐开通

  • MANAGEMENT_ARREAR 管理套餐欠费

  • MANAGEMENT_CLOSED 管理套餐未开通

  • EVENT_RECORD_GRANT 动检套餐开通

  • EVENT_RECORD_ARREAR 动检套餐欠费

  • EVENT_RECORD_CLOSED 动检套餐关闭

  • FULL_RECORD_GRANT 全量套餐开通

  • FULL_RECORD_ARREAR 全量套餐欠费

  • FULL_RECORD_CLOSED 全量套餐关闭

  • INDUSTRY_DATA_GRANT 行业数据流套餐开通

  • INDUSTRY_DATA_ARREAR 行业数据流套餐欠费

  • INDUSTRY_DATA_CLOSED 行业数据流套餐关闭

ability

String

设备能力:枚举类型,仅支持单个能力集查询

枚举值:

  • algorithm 算法能力

  • ptz 云台能力

device_id

String

设备ID:

好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取

国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型

device_name

String

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

device_state

String

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

枚举值:

  • OFFLINE 离线

  • ONLINE 在线
  • UNREGISTERED 未注册

device_system_state

String

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

枚举值:

  • NORMAL 正常

  • UNAVAILABLE_FROZEN 冻结

device_type

String

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

枚举值:

  • IPC 直连摄像机

  • NVR NVR设备

  • MEdge IVS1800设备

direction

String

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

枚举值:

  • ASC 升序

  • DESC 降序

group_ids

String

所属分组ID列表:支持多个设备组织查询,使用英文逗号分隔

单个设备组织ID:由数字组成,长度范围[1,25](根组织节点的值为0)

is_current_org

String

是否属于当前组织:枚举类型,不填就是查询全部组织

枚举值:

  • 0 下级组织
  • 1 当前组织
  • 2 所有组织

limit

Integer

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

manufactures

String

厂商:支持多个厂商查询,使用英文逗号隔开

单个厂商:由中文(一个汉字算两个字符)、英文、数字 、特殊字符(_-空格)组成,长度范围[1,64]

offset

Integer

偏移量页数:0为第一页,取值范围[0,2147483646],不填写时默认为0

sort_by

String

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

枚举值:

  • create_time 创建时间

  • update_time 更新时间

  • operator_total 拥有该设备的普通用户总数

user_order

Integer

排序字段:枚举类型,按用户数排序(当前无效)

枚举值:

  • 0 数量从小到大
  • 1 数量从大到小
support.huaweicloud.com/api-ivm/GetListDeviceInfo.html