功能描述
用于查询组织目录下的通道列表。
请求
请求url
GET /ivc/record/channellist/query?OrganizationId=xxx&DeviceName=xxx&ChannelName=xxx&PageSize=10&PageNumber=1
请求参数
该请求操作的实现需要有如下请求参数。
字段名 | 类型 | 描述 | 必须 | 备注 |
OrganizationId | string | 组织id | 是 | - |
DeviceName | string | 查询条件，则按照设备名称查询 | 否 | 查询条件同时只有一个生效 |
ChannelName | string | 查询条件，则按照通道名称查询 | 否 | 查询条件同时只有一个生效 |
PageSize. | int | 每页最大数量 | 是 | - |
PageNumber | int | 第几页 | 是 | - |
请求头
请求体
该请求操作无请求体。
响应
响应头
响应体
该响应体返回为 application/json 数据，包含完整节点数据的内容展示如下：
{"RequestId": "","Code": 0,"StatusCode": 200,"Message": "ok","Data": {"PageNumber": 1,"PageSize": 10,"TotalCount": 100,"List" : [ {"DeviceId" : "1c43487d-cd8d-4892-989a-2f31f88d6bcd","DeviceName" : "","ChannelId" : "90953ced-04ea-4baa-bf37-053e2e86e313","ChannelName" : "","InPlan" : true}, {"DeviceId" : "","DeviceName" : "","ChannelId" : "","ChannelName" : "","InPlan" : false} ]}}
字段名 | 类型 | 描述 | 备注 |
RequestId | string | 请求 ID | - |
Code | int | 状态码，0 成功，500 操作失败 | - |
StatusCode | int | 错误码，200 OK，其他详见错误中心 | - |
Message | string | 返回信息 | - |
Data | object | 返回结果 | - |
Data
字段名 | 类型 | 描述 | 备注 |
PageNumber | int | 第几页 | - |
PageSize | int | 当前页的设备数量 | - |
TotalCount | int | 本次查询的设备通道总数 | - |
List | object | 设备通道信息列表 | - |
List
字段名 | 类型 | 描述 | 备注 |
DeviceId | string | 设备通道所属的设备 ID | - |
DeviceName | string | 设备通道所属的设备名称 | - |
ChannelId | string | 设备通道 ID | - |
ChannelName | string | 设备通道名称 | - |
InPlan | bool | 该通道是否在实时上云计划中，如果是，则不能在添加到其他实时上云计划 | true：在计划中，false：不在计划中 |
