物解析IOT Parser

    ParserObject

    字段 类型 说明
    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

    其他: 失败

    请求示例

    GET /v1/parse-object

    输出示例

    {  
        "orderBy": "createTime",  
        "order": "desc",  
        "pageNo": 1,  
        "pageSize": 10,  
        "result": [  
            {  
                "uuid": "3568afb6-31a1-4686-80a5-620b7670659b",  
                "state": "RUNNING",  
                "dataTopic": "mb\_dataTopic\_v21476863385409",  
                "name": "ldwde2",  
                "protocol": "MODBUS",  
                "status": "ACTIVE",  
                "gatewayUuid": "f723e888-0f86-4992-a626-2c5c081e93f6",  
                "gatewayCode": "ldwgate",  
                "storage": "",  
                "storageTaskId": "mb\_storage\_v21476863385409",  
                "createTime": "2016-10-19T07:49:46Z",  
                "updateTime": "2016-10-19T07:49:46Z",  
                "destTopic": "ldwde2"  
            },  
            {  
                "uuid": "cc49c9b8-22cc-4ffe-929e-d4da99a37438",  
                "state": "RUNNING",  
                "dataTopic": "mb\_dataTopic\_v21476852302035",  
                "name": "ldwtestv22",  
                "protocol": "MODBUS",  
                "status": "ACTIVE",  
                "gatewayUuid": "f723e888-0f86-4992-a626-2c5c081e93f6",  
                "gatewayCode": "ldwgate",  
                "storage": "[bos://ldwldw-test/](bos://ldwldw-test/)",  
                "storageTaskId": "mb\_storage\_v21476852302035",  
                "createTime": "2016-10-19T04:45:02Z",  
                "updateTime": "2016-10-19T04:45:02Z",  
                "destTopic": "ldwtopic"  
            }  
        ],  
        "totalCount": 2  
    }

    获取

    接口描述

    相对URI HTTP 方式
    /v1/parser-object/:parserObjectUuid GET

    输入

    名称 类型 是否必选 默认值 含义
    parserObjectUuid String Y 解析项目id

    输出

    200: 成功

    输出一个这个uuid对应的parserObject

    其他: 失败 请求示例

    GET /v1/parser-object/cc49c9b8-22cc-4ffe-929e-d4da99a37438

    输出示例

    {  
        "uuid": "cc49c9b8-22cc-4ffe-929e-d4da99a37438",  
        "state": "RUNNING",  
        "dataTopic": "mb\_dataTopic\_v21476852302035",  
        "name": "ldwtestv22",  
        "protocol": "MODBUS",  
        "status": "ACTIVE",  
        "gatewayUuid": "f723e888-0f86-4992-a626-2c5c081e93f6",  
        "gatewayCode": "ldwgate",  
        "storage": "[bos://ldwldw-test/](bos://ldwldw-test/)",  
        "storageTaskId": "mb\_storage\_v21476852302035",  
        "createTime": "2016-10-19T04:45:02Z",  
        "updateTime": "2016-10-19T04:45:02Z",  
        "destTopic": "ldwtopic"  
    }

    创建

    接口描述

    相对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

    其他: 失败

    请求示例

    {
        "name":"ldwtestv22",
        "gatewayUuid":"f723e888-0f86-4992-a626-2c5c081e93f6",
        "storage":"[bos://ldwldw-test/](bos://ldwldw-test/)",
        "protocol":"MODBUS",
        "destTopic":"ldwtopic"
    }

    输出示例

    {
        "uuid":"cc49c9b8-22cc-4ffe-929e-d4da99a37438",
        "state":"RUNNING",
        "dataTopic":"mb\_dataTopic\_v21476852302035",
        "name":"ldwtestv22",
        "protocol":"MODBUS",
        "status":"ACTIVE",
        "gatewayUuid":"f723e888-0f86-4992-a626-2c5c081e93f6",
        "gatewayCode":"ldwgate",
        "storage":"[bos://ldwldw-test/](bos://ldwldw-test/)",
        "storageTaskId":"mb\_storage\_v21476852302035",
        "createTime":"2016-10-19T04:45:02Z",
        "updateTime":"2016-10-19T04:45:02Z",
        "destTopic":"ldwtopic"
    }

    更新

    接口描述

    相对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

    其他: 失败

    请求示例

    {
        "state": "RUNNING"
    }

    输出示例

    {  
        "destTopic": "destTopicYyj6b",  
        "gatewayUuid": "9d00d091-b37e-4a91-8562-89b14826e687",  
        "state": "RUNNING",  
        "dataTopic": "mb\_dataTopic\_v31480492111054",  
        "name": "yyjPrj6b",  
        "createTime": "2016-11-30T07:48:34Z",  
        "protocol": "MODBUS",  
        "status": "ACTIVE",  
        "updateTime": "2016-11-30T07:48:34Z",  
        "gatewayCode": "yyjgateway",  
        "storageTaskId": "mb\_storage\_v31480492111054",  
        "uuid": "061e26ab-5f8f-421b-9a96-ce584fc59eb0",  
        "storage": "[bos://ldwldw-test/sub/test6b](bos://ldwldw-test/sub/test6b)"  
    }

    删除

    接口描述

    相对URI HTTP 方式
    /v1/parser-object/<parserObjectUuid> DELETE

    输入

    名称 类型 是否必选 默认值 含义
    parserObjectUuid String Y 解析项目id

    输出

    204: 成功

    其他: 失败

    请求示例

    DELETE /v1/parser-object/061e26ab-5f8f-421b-9a96-ce584fc59eb0
    上一篇
    Device
    下一篇
    PullRule