Update Subscription Group¶
更新订阅组信息。
请求格式¶
PUT http://{apigw-address}/edge-service/v1/subscribe-group?action=update&type=realTimeData&orgId={}&subscribeGroupId={}
请求参数(URI)¶
名称 | 位置 (Path/Query) | 是否必须 | 数据类型 | 描述 |
---|---|---|---|---|
subscribeGroupId | Path | 是 | String | 订阅组的ID |
orgId | Query | 是 | String | 资产所属的组织ID。 如何获取orgId信息>> |
action | Query | 是 | String | update |
type | Query | 是 | String | realTimeData |
注解
直接将{subscribeGroupId}替换为订阅组ID即可。不要采用 subscribeGroupId= 订阅组ID 这种形式。
请求参数(Body)¶
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
subscribeGroupId | True | String | 订阅组ID。必须以 DATASVC.SUBALL. 或 DATASVC.SUB. 开头。只支持大小写英文字母、数字、下划线(_)、英文句号(.)、短横线(-),长度最大为60字节 |
enable | False | boolean | 是否启用订阅组。 |
persistent | False | Boolean | 订阅组是否持续 |
subscribeAll | False | boolean | 是否订阅全部测点信息。如果为True, subscribeGroupId 的值必须加上DATASVC.SUBALL.前缀。如果为False,subscribeGroupId 的值必须加上DATASVC.SUB.前缀。 |
subscribeModelList | False | Array | 订阅的模型列表,数据元素为模型标识符。 |
subscribeProductList | False | Array | 订阅的产品列表,数据元素为product key |
subscribeAssetList | False | Array | 订阅的asset列表,数据元素为asset ID |
subscribeDeviceList | False | Array | 订阅的device列表,列表的元素为object,其结构参见下表。 |
subscribeModelPointList | False | Array | 订阅的模型的测点,列表的元素为object,其结构参见下表。 |
subscribePointList | False | Array | 订阅的设备关联的测点相关信息列表,列表的元素为object,其结构参见下表。 |
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
productKey | False | String | 设备的product key |
deviceKey | False | String | 设备的device key |
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
modelId | False | String | 设备所属模型的标识符 |
pointList | False | Array | 测点的标识符列表 |
名称 | 是否必须 | 数据类型 | 描述 |
---|---|---|---|
assetId | False | String | 测点所属设备资产的asset ID,用于指定一个设备资产 |
productKey | False | String | 测点所属产品的product key,用于与 deviceKey 一起使用以指定一个设备资产 |
deviceKey | False | String | 测点所属产品的device key,用于与 productKey 一起使用以指定一个设备资产 |
pointList | False | Array | 测点的标识符列表,列表元素为测点的标识符 |
注解
在 subscribePointList `` 对象中,你可以只使用 ``assetId
, 或者使用 productKey
+ deviceKey
的组合的方法来确定一个设备资产。如果在 subscribePointList `` 中三个参数都存在。则以 ``assetId
来确定设备。
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
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,其结构见下表。 |
subscribeModelPointList | Array | 订阅的模型关联的测点列表,列表元素是object,其结构见下表。 |
subscribePointList | Array | 订阅的设备关联的点列表,列表元素是object,其结构见下表。 |
名称 | 数据类型 | 描述 |
---|---|---|
productKey | String | 订阅的设备的product key |
deviceKey | String | 订阅的设备的device key |
名称 | 数据类型 | 描述 |
---|---|---|
modelId | String | 设备所属模型的标识符 |
pointList | Array | 测点的标识符列表,列表元素为测点的标识符 |
名称 | 是否必须 | 描述 |
---|---|---|
assetId | String | 测点所属设备资产的assetId,用于指定一个设备资产 |
productKey | String | 测点所属产品的product key,用于与 deviceKey 一起使用以指定一个设备资产 |
deviceKey | String | 测点所属产品的device key,用于与 productKey 一起使用以指定一个设备资产 |
pointList | Array | 测点的标识符列表 |
注解
在 subscribePointList `` 对象中,优先以 ``assetId
来确定设备。如果 assetId
不存在,则以 deviceKey
+ productKey
的组合来确定设备。
输入输出示例¶
请求示例¶
PUT http://{apigw-address}/edge-service/v1/subscribe-group?action=update&type=realTimeData&orgId={}&subscribeGroupId={}
{
"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"]
}]
}
响应示例¶
{
"status": 0,
"msg": "Success",
"submsg": null,
"data": {
"id":"dafdsfdsafsdaf",
"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"]
}]
}
}