# 查询通道列表 #### 功能介绍 查询通道列表，支持多条件查询 #### URI GET /v1/{user_id}/channels 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_id | 是 | String | 用户ID：由数字组成，长度范围\[15,25\]，获取方式参考[获取user ID与下载AK/SK](https://support.huaweicloud.com/api-ivm/ivm_03_0005.html#ZH-CN_TOPIC_0000001710465704__section1213543912215)章节 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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** 更新时间 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Access-Token | 是 | String | 用户认证AccessToken：从[获取用户北向接口认证AccessToken](https://support.huaweicloud.com/api-ivm/ivm_03_0002.html)中获取 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总数 | | channels | [Channel] object | 通道列表 | 表5Channel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | device_id | String | 设备ID，设备唯一标识 | | device_name | String | 设备名称 | | channel_id | String | 通道ID | | channel_name | String | 通道名称 | | channel_state | String | 通道状态 枚举值： - **OFFLINE**离线 - **ONLINE**在线 - **UNALLOCATED**未注册 | | model | String | 通道的设备型号 | | access_protocol | String | 接入协议 枚举值： - **HOLO** 好望协议 - **GB28181** 国标协议 | | create_time | String | 通道创建时间 | | update_time | String | 通道更新时间 | | channel_system_state | String | 通道系统状态 枚举值： - **NORMAL** 正常 - **UNAVAILABLE_FROZEN** 冻结 | | channel_resource_state | Array of strings | 通道资源 枚举值： - **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_ability | Array of strings | 通道能力集：枚举类型，[参考附录设备能力集](https://support.huaweicloud.com/api-ivm/ivm_03_0141.html)，多个能力集用逗号分隔 | | channel_firmware | String | 通道的设备固件版本号，如：SDC 10.0.0 | | config_state | String | 批量远程配置状态，枚举类型 枚举值： - **TRUE**可配置 - **FALSE**不可配置 | | device_org_name | String | 设备组织名称 | | channel_type | String | 通道类型 枚举值： - **IPC** 通用相机 - **IPC-BULLET** 枪机 - **IPC-BOX** 筒机 - **IPC-CONCH**半球/海螺 - **IPDOME** 球机 | | resolution | String | 分辨率 | #### 请求示例 ``` GET /v1/2562572829***/channels?device_id=952352DJNR***&offset=0&limit=20 ``` #### 响应示例 **状态码： 200** 通道列表 ``` { "total" : "2", "channels" : [ { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "0", "channel_name" : "龙岗通道1", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null }, { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "1", "channel_name" : "龙岗通道2", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-ivm/ivm_03_0136.html) #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ivm/ivm_03_0137.html)