List Control Channels¶
List all the control channels.
Request Format¶
GET http://{apigw-address}/dataService/subscribeGroups?orgId={}&pageSize={}&pageToken={}
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Required or not |
Data type |
Description |
---|---|---|---|---|
orgId |
Query |
Yes |
String |
Organization ID which the asset belongs to. How to get Organization ID>> |
pageSize |
Query |
No |
Int |
Number of the records displayed in each page, where the default value “0” means all the subscription groups are read. The default value is used if this field is left blank. |
pageToken |
Query |
No |
Int |
Page number of each record page, where the default value “1” means the first page. The default value is used if this field is left blank. |
Note
pageSize
and pageToken
are used to specify the display of returned results. For example, if you want to display the records from No.201 to No.300, you should set pageSize=100
pageToken=3
. pageSize=100
is used to paginate the records into 100 records per page, while pageToken=3
means to search the third page, i.e. the records from No. 201 to No. 300.
Response Parameters¶
Name |
Data type |
Description |
---|---|---|
status |
Int |
Status code |
msg |
String |
Response message |
submsg |
String |
Response sub-message |
body |
Null |
Response message body |
data |
Object |
Response data object, the structure of which is in the table below |
pageToken |
String |
Page number of each record page, where the default value |
---|---|---|
pageSize |
Int |
Number of the records displayed in each page, where the default value |
totalSize |
String |
Total number of returned records |
data |
Array |
List of returned subscription group information. The list element is a JSON object. The structure of the object is in the table below. |
Name |
Data type |
Description |
---|---|---|
id |
String |
Internal data ID |
controlChannelId |
String |
Control channel ID |
desc |
String |
Control channel description |
Samples¶
Request Sample¶
GET http://{apigw-address}/dataService/controlChannels?orgId=o15434988531231&pageSize=1&pageToken=1
Response Sample¶
{
"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"
}
]
}
}