ParserObject
更新时间：2019-06-14
| 字段 | 类型 | 说明 |
|---|---|---|
| uuid | String | 全局唯一ID |
| name | String | 项目名称 |
| description | String | 项目描述 |
| gatewayUuid | String | 对应网关id |
| gatewayCode | String | 冗余字段。与gatewayUuid对应的gateway的code字段保持一致 |
| storage | String | BOS上的地址，[可以为空] |
| storageTaskId | String | 转储数据到BOS的任务名称 |
| protocol | ENUM | [ MODBUS ]目前只能填这一个，也是默认值 |
| dataTopic | String | 网关上传数据使用的MQTT 主题 |
| state | ENUM | [ERROR, PAUSED, RUNNING] |
| status | ENUM | [ERROR, ACTIVE, DELETED] |
| createTime | DateTime | 创建记录的时间 |
| updateTime | DateTime | 最后修改记录的时间 |
| destTopic | String | 解析后的消息写入那个mqtt topic，[可以为空] |
筛选
接口描述
| 相对URI | HTTP 方式 |
|---|---|
| /v1/parser-object | GET |
输入
| 名称 | 类型 | 是否必选 | 默认值 | 含义 |
|---|---|---|---|---|
| gatewayUuid | String | N | null | 网关id |
| state | ENUM | N | null | 'RUNNING' 或者 'PAUSED' |
输出
200: 成功
输出一个parserObject的List
其他: 失败
请求示例
Plain Text
1GET /v1/parse-object输出示例：
Plain Text
1{
2 "orderBy": "createTime",
3 "order": "desc",
4 "pageNo": 1,
5 "pageSize": 10,
6 "result": [
7 {
8 "uuid": "3568afb6-31a1-4686-80a5-620b7670659b",
9 "state": "RUNNING",
10 "dataTopic": "mb\_dataTopic\_v21476863385409",
11 "name": "ldwde2",
12 "protocol": "MODBUS",
13 "status": "ACTIVE",
14 "gatewayUuid": "f723e888-0f86-4992-a626-2c5c081e93f6",
15 "gatewayCode": "ldwgate",
16 "storage": "",
17 "storageTaskId": "mb\_storage\_v21476863385409",
18 "createTime": "2016-10-19T07:49:46Z",
19 "updateTime": "2016-10-19T07:49:46Z",
20 "destTopic": "ldwde2"
21 },
22 {
23 "uuid": "cc49c9b8-22cc-4ffe-929e-d4da99a37438",
24 "state": "RUNNING",
25 "dataTopic": "mb\_dataTopic\_v21476852302035",
26 "name": "ldwtestv22",
27 "protocol": "MODBUS",
28 "status": "ACTIVE",
29 "gatewayUuid": "f723e888-0f86-4992-a626-2c5c081e93f6",
30 "gatewayCode": "ldwgate",
31 "storage": "[bos://ldwldw-test/](bos://ldwldw-test/)",
32 "storageTaskId": "mb\_storage\_v21476852302035",
33 "createTime": "2016-10-19T04:45:02Z",
34 "updateTime": "2016-10-19T04:45:02Z",
35 "destTopic": "ldwtopic"
36 }
37 ],
38 "totalCount": 2
39}获取
接口描述
| 相对URI | HTTP 方式 |
|---|---|
| /v1/parser-object/:parserObjectUuid | GET |
输入
| 名称 | 类型 | 是否必选 | 默认值 | 含义 |
|---|---|---|---|---|
| parserObjectUuid | String | Y | 解析项目id |
输出
200: 成功
输出一个这个uuid对应的parserObject
其他: 失败 请求示例：
Plain Text
1GET /v1/parser-object/cc49c9b8-22cc-4ffe-929e-d4da99a37438输出示例：
Plain Text
1{
2 "uuid": "cc49c9b8-22cc-4ffe-929e-d4da99a37438",
3 "state": "RUNNING",
4 "dataTopic": "mb\_dataTopic\_v21476852302035",
5 "name": "ldwtestv22",
6 "protocol": "MODBUS",
7 "status": "ACTIVE",
8 "gatewayUuid": "f723e888-0f86-4992-a626-2c5c081e93f6",
9 "gatewayCode": "ldwgate",
10 "storage": "[bos://ldwldw-test/](bos://ldwldw-test/)",
11 "storageTaskId": "mb\_storage\_v21476852302035",
12 "createTime": "2016-10-19T04:45:02Z",
13 "updateTime": "2016-10-19T04:45:02Z",
14 "destTopic": "ldwtopic"
15}创建
接口描述
| 相对URI | HTTP 方式 |
|---|---|
| /v1/parser-object | POST |
输入
| 名称 | 类型 | 是否必选 | 默认值 | 参数位置 | 说明 |
|---|---|---|---|---|---|
| name | String | Y | body json | 名称 | |
| gatewayUuid | String | Y | body json | 网关id | |
| storage | String | N | body json | 存储到bos的地址 | |
| protocol | ENUM | N | MODBUS | body json | 只能是MODBUS |
| destTopic | String | N | NULL | 转发到mqtt目的地的主题 |
输出
201: 成功
输出创建成功的parserObject
其他: 失败
请求示例
Plain Text
1{
2 "name":"ldwtestv22",
3 "gatewayUuid":"f723e888-0f86-4992-a626-2c5c081e93f6",
4 "storage":"[bos://ldwldw-test/](bos://ldwldw-test/)",
5 "protocol":"MODBUS",
6 "destTopic":"ldwtopic"
7}输出示例：
Plain Text
1{
2 "uuid":"cc49c9b8-22cc-4ffe-929e-d4da99a37438",
3 "state":"RUNNING",
4 "dataTopic":"mb\_dataTopic\_v21476852302035",
5 "name":"ldwtestv22",
6 "protocol":"MODBUS",
7 "status":"ACTIVE",
8 "gatewayUuid":"f723e888-0f86-4992-a626-2c5c081e93f6",
9 "gatewayCode":"ldwgate",
10 "storage":"[bos://ldwldw-test/](bos://ldwldw-test/)",
11 "storageTaskId":"mb\_storage\_v21476852302035",
12 "createTime":"2016-10-19T04:45:02Z",
13 "updateTime":"2016-10-19T04:45:02Z",
14 "destTopic":"ldwtopic"
15}更新
接口描述
| 相对URI | HTTP 方式 |
|---|---|
| /v1/parser-object/<parserObjectUuid> | PUT |
输入
| 名称 | 类型 | 是否必选 | 默认值 | 参数位置 | 说明 |
|---|---|---|---|---|---|
| state | ENUM | N | 'RUNNING' 或者 'PAUSED' | ||
| name | String | N | body json | 名称 | |
| gatewayUuid | String | N | body json | 网关id | |
| storage | String | N | body json | 存储到bos的地址 | |
| protocol | ENUM | N | body json | 只能是MODBUS | |
| destTopic | String | N | 转发到mqtt目的地的主题 |
输出
201: 成功
输出更新成功后的parserObject
其他: 失败
请求示例：
Plain Text
1{
2 "state": "RUNNING"
3}输出示例：
Plain Text
1{
2 "destTopic": "destTopicYyj6b",
3 "gatewayUuid": "9d00d091-b37e-4a91-8562-89b14826e687",
4 "state": "RUNNING",
5 "dataTopic": "mb\_dataTopic\_v31480492111054",
6 "name": "yyjPrj6b",
7 "createTime": "2016-11-30T07:48:34Z",
8 "protocol": "MODBUS",
9 "status": "ACTIVE",
10 "updateTime": "2016-11-30T07:48:34Z",
11 "gatewayCode": "yyjgateway",
12 "storageTaskId": "mb\_storage\_v31480492111054",
13 "uuid": "061e26ab-5f8f-421b-9a96-ce584fc59eb0",
14 "storage": "[bos://ldwldw-test/sub/test6b](bos://ldwldw-test/sub/test6b)"
15}删除
接口描述
| 相对URI | HTTP 方式 |
|---|---|
| /v1/parser-object/<parserObjectUuid> | DELETE |
输入
| 名称 | 类型 | 是否必选 | 默认值 | 含义 |
|---|---|---|---|---|
| parserObjectUuid | String | Y | 解析项目id |
输出
204: 成功
其他: 失败
请求示例
Plain Text
1DELETE /v1/parser-object/061e26ab-5f8f-421b-9a96-ce584fc59eb0