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

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

URI

GET /v1/{user_id}/channels

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

access_protocol

String

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

枚举值:

  • HOLO 好望协议

  • GB28181 国标协议

channel_name

String

通道名称:支持英文、中文(一个汉字算两个字符)、数字、特殊字符(_-空格),长度范围[1,128]

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 行业数据流套餐关闭

  • CUSTOMER_GROUP_GRANT 客流客群服务开通
  • CUSTOMER_GROUP_ARREAR 客流客群服务欠费
  • CUSTOMER_GROUP_CLOSED 客流客群服务未开通

channel_state

String

通道状态:枚举类型,仅支持单个通道状态查询

枚举值:

  • OFFLINE 离线

  • ONLINE 在线
  • UNALLOCATED 未注册

channel_system_state

String

系统状态:枚举类型,仅支持单个系统状态查询

枚举值:

  • NORMAL 正常

  • UNAVAILABLE_FROZEN 冻结

device_id

String

设备ID:

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

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

direction

String

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

枚举值:

  • ASC 升序

  • DESC 降序

limit

Integer

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

offset

Integer

偏移量:0表示从第1个匹配的数据开始查询,取值范围[0,2147483646],不填写时默认为0

sort_by

String

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

枚举值:

  • create_time 创建时间

  • update_time 更新时间

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