List Subscription Groups¶
列出所有订阅组信息。
请求格式¶
GET http://{apigw-address}/edge-service/v1/subscribe-group?action=list&type=realTimeData&orgId={}&pageSize={}&pageToken={}
请求参数（URI）¶
名称 |
位置 (Path/Query) |
是否必须 |
数据类型 |
描述 |
|---|---|---|---|---|
orgId |
Query |
是 |
String |
资产所属的组织ID。 如何获取orgId信息>> |
pageSize |
Query |
否 |
Int |
每一页显示的记录条数，默认值0表示读取所有订阅组。不填该字段，则使用默认值 |
pageToken |
Query |
否 |
Int |
每一记录页的页码，默认值1表示第1页。不填该字段，则使用默认值 |
action |
Query |
是 |
String |
list |
type |
Query |
是 |
String |
realTimeData |
备注
使用 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 |
返回的订阅组信息列表，列表元素为结构体，结构体的结构见下表。 |
名称 |
数据类型 |
描述 |
|---|---|---|
id |
String |
内部定义的数据标识符 |
subscribeGroupId |
String |
订阅组ID |
enable |
Boolean |
是否启用订阅组 |
subscribeAll |
Boolean |
订阅组是否订阅了所有测点 |
subscribeModelList |
Array |
订阅的模型列表，列表元素为模型标识符 |
subscribeProductList |
Array |
订阅的产品列表，列表元素为产品的product Key |
subscribeAssetList |
Array |
订阅的资产列表，列表元素为资产的标识符 |
subscribeDeviceList |
Array |
订阅的设备列表，列表元素是object，结构见下表。 |
data.subscribeModelPointList |
Array |
订阅的模型关联的测点列表，列表元素是object，结构见下表。 |
data.subscribePointList |
Array |
订阅的设备关联的点列表，列表元素是object，结构见下表。 |
名称 |
数据类型 |
描述 |
|---|---|---|
productKey |
String |
订阅的设备的product key |
deviceKey |
String |
订阅的设备的device key |
名称 |
数据类型 |
描述 |
|---|---|---|
modelId |
String |
设备所属模型的标识符 |
pointList |
Array |
测点的标识符列表，列表元素为测点的标识符 |
名称 |
是否必须 |
描述 |
|---|---|---|
assetId |
String |
测点所属设备资产的asset ID，用于指定一个设备资产 |
productKey |
String |
测点所属产品的product key，用于与 |
deviceKey |
String |
测点所属产品的device key，用于与 |
pointList |
Array |
测点的标识符列表 |
备注
在 subscribePointList `` 对象中，优先以 ``assetId 来确定设备。如果 assetId 不存在，则以 deviceKey + productKey 的组合来确定设备。
输入输出示例¶
请求示例¶
GET http://{apigw-address}/edge-service/v1/subscribe-group?action=list&type=realTimeData&orgId={}&pageSize={}&pageToken={}
响应示例¶
{
"status":0,
"msg":"Success",
"submsg":null,
"body":null,
"data":{
"pageToken":1,
"pageSize":10,
"totalSize":22,
"data":[
{
"id":"dfasdfdsfsadf",
"subscribeGroupId":"DATASVC.SUB.group1",
"enable":true,
"persistent":true,
"subscribeAll":false,
"subscribeModelList":[
"model1",
"model2",
"model3"
],
"subscribeProductList":[
"product1",
"product2",
"product3"
],
"subscribeAssetList":[
"asset1",
"asset2",
"asset3"
],
"subscribeDeviceList":[
{
"productKey":"productKey1",
"deviceKey":"deviceKey1"
},
{
"productKey":"productKey2",
"deviceKey":"deviceKey2"
}
],
"subscribeModelPointList":[
{
"modelId":"model1",
"pointList":[
"point1",
"point2",
"point3"
]
},
{
"modelId":"model2",
"pointList":[
"point1",
"point2",
"point3"
]
}
],
"subscribePointList":[
{
"assetId":"asset10",
"productKey":"productKey10",
"deviceKey":"deviceKey10",
"pointList":[
"point1",
"point2",
"point3"
]
},
{
"assetId":"",
"productKey":"productKey11",
"deviceKey":"deviceKey11",
"pointList":[
"point1",
"point2",
"point3"
]
}
]
},
{
"id":"fdafdsafdsfas",
"subscribeGroupId":"DATASVC.SUB.group2",
"enable":true,
"persistent":true,
"subscribeAll":false,
"subscribeModelList":[
"model1",
"model2",
"model3"
],
"subscribeProductList":[
"product1",
"product2",
"product3"
],
"subscribeAssetList":[
"asset1",
"asset2",
"asset3"
],
"subscribeDeviceList":[
{
"productKey":"productKey1",
"deviceKey":"deviceKey1"
},
{
"productKey":"productKey2",
"deviceKey":"deviceKey2"
}
],
"subscribeModelPointList":[
{
"modelId":"model1",
"pointList":[
"point1",
"point2",
"point3"
]
},
{
"modelId":"model2",
"pointList":[
"point1",
"point2",
"point3"
]
}
],
"subscribePointList":[
{
"assetId":"asset10",
"productKey":"productKey10",
"deviceKey":"deviceKey10",
"pointList":[
"point1",
"point2",
"point3"
]
},
{
"assetId":"",
"productKey":"productKey11",
"deviceKey":"deviceKey11",
"pointList":[
"point1",
"point2",
"point3"
]
}
]
}
]
}
}