Get Subscription Group¶
获取订阅组详情。
请求格式¶
GET http://{apigw-address}/dataService/subscribeGroups/{subscribeGroupId}?orgId={}
请求参数(URI)¶
名称 |
位置 (Path/Query) |
是否必须 |
数据类型 |
描述 |
---|---|---|---|---|
subscribeGroupId |
Path |
是 |
String |
订阅组的ID |
orgId |
Query |
是 |
String |
资产所属的组织ID。 如何获取orgId信息>> |
备注
直接将{subscribeGroupId}替换为订阅组ID即可。不要采用 subscribeGroupId= 订阅组ID 这种形式。
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
status |
Int |
响应状态码 |
msg |
String |
返回消息,用于描述响应结果 |
submsg |
String |
返回子消息,用于描述响应结果 |
data |
Object |
响应数据Object,结构见下表 |
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
内部定义的数据标识符 |
subscribeGroupId |
String |
订阅组ID |
enable |
Boolean |
是否启用订阅组 |
subscribeAll |
Boolean |
订阅组是否订阅了所有测点 |
subscribeModelList |
Array |
订阅的模型列表,列表元素为模型标识符 |
subscribeProductList |
Array |
订阅的产品列表,列表元素为产品的product Key |
subscribeAssetList |
Array |
订阅的资产列表,列表元素为资产的标识符 |
subscribeDeviceList |
Array |
订阅的设备列表,列表元素是object,object的结构见下表。 |
subscribeModelPointList |
Array |
订阅的模型关联的测点列表,列表元素是object,object的结构见下表。 |
subscribePointList |
Array |
订阅的设备关联的点列表,列表元素是object,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 |
测点的标识符列表 |
输入输出示例¶
请求示例¶
GET http://{apigw-address}/dataService/{subscribeGroups}?orgId=o15434988531231
响应示例¶
{
"status":0,
"msg":"Success",
"submsg":null,
"data":{
"id":"dsafdasfdsafd",
"subscribeGroupId":"DATASVC.SUB.group1",
"enable":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"
]
}
]
}
}