查询实时上云计划下的设备通道列表

最近更新时间:2023-04-27 17:06:50

我的收藏

功能描述

用于查询实时上云计划下的设备通道列表。


请求

请求url

GET /ivc/record/devicelist/query?PlanId=xxx&DeviceName=xxx&ChannelName=xxx&OrganizationName=xxx&PageSize=10&PageNumber=1

请求参数

该请求操作的实现需要有如下请求参数。

字段名
类型
描述
必须
备注
PlanId
string
上云计划id

DeviceName
string
按照设备名称查询
为空时,不参考该参数
ChannelName
string
按照通道名称查询
为空时,不参考该参数
OrganizationName
string
按照组织名称查询
为空时,不参考该参数
PageSize
int
每页最大数量

PageNumber
int
第几页

备注:通道名称、设备名称、组织名称同时只有一个有效,如果同时多个字段有值,按照通道名称、设备名称、组织名称的优先级顺序查询,如果都为空,则全量查询


请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。


请求体

该请求操作的无请求体。


响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。


响应体

该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:

{
"RequestId": "",
"Code": 0,
"StatusCode": 200,
"Message": "ok",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"List": [
{
"DeviceId": "",
"DeviceName": "",
"ChannelId": "",
"ChannelName": "",
"OrganizationName" : ""
},
{
"DeviceId": "",
"DeviceName": "",
"ChannelId": "1",
"ChannelName": "",
"OrganizationName" : ""
}
]
}
}

字段名
类型
描述
备注
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
设备通道名称

OrganizationName
string
所属组织名称