List Control Channels¶
列出所有控制通道信息。
请求格式¶
GET http://{apigw-address}/dataService/subscribeGroups?orgId={}&pageSize={}&pageToken={}
请求参数(URI)¶
名称 |
位置 (Path/Query) |
是否必须 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
是 |
String |
资产所属的组织ID。 如何获取orgId信息>> |
pageSize |
Query |
否 |
Int |
每一页显示的记录条数,默认值0表示读取所有订阅组。不填该字段,则使用默认值 |
pageToken |
Query |
否 |
Int |
每一记录页的页码,默认值1表示第1页。不填该字段,则使用默认值 |
备注
使用 pageSize
和 pageToken
来约束返回结果的显示。例如,要显示第201-第300条记录,则应设置 pageSize=100
pageToken=3
。 pageSize=100
会将记录按照每100条记录为一页划分好, pageToken=3
表示想要查询第3页,即第201至第300条记录。
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
status |
Int |
响应状态码 |
msg |
String |
返回消息,用于描述响应结果 |
submsg |
String |
返回子消息,用于描述响应结果 |
body |
Null |
响应消息的Body |
data |
Object |
响应数据object,结构见下表 |
pageToken |
String |
每一记录页的页码,默认值1表示第1页 |
---|---|---|
pageSize |
Int |
每一页显示的记录条数,默认值0表示读取所有订阅组 |
totalSize |
String |
返回记录的总条数 |
data |
Array |
返回的订阅组信息列表,列表元素为object,object的结构见下表。 |
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
内部定义的数据标识符 |
controlChannelId |
String |
控制通道ID |
desc |
String |
控制通道描述 |
输入输出示例¶
请求示例¶
GET http://{apigw-address}/dataService/controlChannels?orgId=o15434988531231&pageSize=1&pageToken=1
响应示例¶
{
"status":0,
"msg":"Success",
"submsg":null,
"body":null,
"data":{
"pageToken":1,
"pageSize":10,
"totalSize":22,
"data":[
{
"id":"dfasdfdsfsadf",
"controlChannelId":"DATASVC.CONTROL.controlChannelId1",
"desc":"desc"
},
{
"id":"fdafdsafdsfas",
"controlChannelId":"DATASVC.CONTROL.controlChannelId2",
"desc":"desc"
}
]
}
}