设备日志API

设备相关的日志API

注：请先查看：API接口调用说明


上报的服务属性日志

  • Request Url
{api_url}/dataLog/uploadServiceLog/findPage

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 否
deviceSn 设备sn 是
deviceSns 设备sn list 否
startDate 起始时间 否
endDate 结束时间 否
sids sid属性定义id 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "sids": ""
}


  • Response Body
字段 值描述
documentId 日志id
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，这里为"upload"
createDate 创建时间
sids sid
paramMap 参数内容，key：pid，value：pvalue
--- ---
content 服务属性内容
content中的did 设备sn
content中的sid 服务定义id
content中的prid 属性定义id
content中的value 属性值

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 17,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "upload",
                "content": "{\"devices\":[{\"services\":[{\"properties\":[{\"prid\":\"0\",\"value\":\"1.1.1\"}],\"sid\":\"13\"},{\"properties\":[{\"prid\":\"0\",\"value\":123},{\"prid\":\"1\",\"value\":\"1.1.1\"}],\"sid\":\"1\"},{\"properties\":[{\"prid\":\"0\",\"value\":523.456},{\"prid\":\"1\",\"value\":false}],\"sid\":\"2\"}],\"did\":\"xxx\"}]}",
                "createDate": "2020-12-12 16:01:28"
            },
            {
                "iid": "xxx2",
                "deviceSn": "xxx",
                "pdid": "",
                "act": "upload",
                "content": "{\"devices\":[{\"services\":[{\"properties\":[{\"prid\":\"0\",\"value\":\"1.1.1\"}],\"sid\":\"13\"},{\"properties\":[{\"prid\":\"0\",\"value\":123},{\"prid\":\"1\",\"value\":\"1.1.1\"}],\"sid\":\"1\"},{\"properties\":[{\"prid\":\"0\",\"value\":523.456},{\"prid\":\"1\",\"value\":false}],\"sid\":\"2\"}],\"did\":\"xxx\"}]}",
                "createDate": "2020-12-12 15:57:43"
            }
        ]
    }
}


上报的服务属性日志统计

  • Request Url
{api_url}/dataLog/uploadServiceLog/count

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 否
deviceSn 设备sn 是
deviceSns 设备sn list 否
startDate 起始时间 否
endDate 结束时间 否
sids sid属性定义id 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "sids": ""
}


  • Response Body
字段 值描述
payload 统计总数

示例：

{
    "status": 0,
    "description": "成功",
    "payload": 35
}


设备事件日志

  • Request Url
{api_url}/dataLog/eventLog/findPage

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 否
deviceSn 设备sn 是
deviceSns 设备sn list 否
startDate 起始时间 否
endDate 结束时间 否
sids sid属性定义id 否
content 事件内容 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "content": ""
}


  • Response Body
字段 值描述
documentId 日志id
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，这里为"event"
createDate 创建时间
sids sid
names 事件的名称
paramMap 参数内容，key：pid，value：pvalue
--- ---
content 服务属性内容
content中的did 设备sn
content中的event 服务定义id
content中的out 事件的参数

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 35,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "event",
                "content": "{\"devices\":[{\"event\":\"testE1\",\"did\":\"xxx\",\"out\":{\"parameter2\":true,\"parameter1\":\"abc\"}}]}",
                "createDate": "2020-12-12 15:44:47"
            },
            {
                "iid": "xxx2",
                "deviceSn": "xxx",
                "pdid": "",
                "act": "event",
                "content": "{\"devices\":[{\"event\":\"testE2\",\"did\":\"xxx\",\"out\":{\"parameter2\":false,\"parameter1\":\"efg\"}}]}",
                "createDate": "2020-12-12 15:40:26"
            }
        ]
    }
}

设备事件日志统计

  • Request Url
{api_url}/dataLog/eventLog/count

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 否
deviceSn 设备sn 是
deviceSns 设备sn list 否
startDate 起始时间 否
endDate 结束时间 否
sids sid属性定义id 否
content 事件内容 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "content": ""
}


  • Response Body
字段 值描述
payload 统计总数

示例：

{
    "status": 0,
    "description": "成功",
    "payload": 35
}


获取事件日志

  • Request Url
{api_url}/dataLog/eventLog/get

  • Request Method

    POST

  • Request Body

字段 值描述 必填
documentId 日志id 是
createDate 日志创建事件 是

示例：

{
    "documentId": "",
    "createDate": "2020-12-01 00:00:00"
}


  • Response Body
字段 值描述
documentId 日志id
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，这里为"event"
createDate 创建时间
sids sid
names 事件的名称
paramMap 参数内容，key：pid，value：pvalue
--- ---
content 服务属性内容
content中的did 设备sn
content中的event 服务定义id
content中的out 事件的参数

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
       "iid": "xxx2",
       "deviceSn": "xxx",
       "pdid": "",
       "act": "event",
       "content": "{\"devices\":[{\"event\":\"testE2\",\"did\":\"xxx\",\"out\":{\"parameter2\":false,\"parameter1\":\"efg\"}}]}",
       "createDate": "2020-12-12 15:40:26"
   }
}


根据iid获取相关联的所有事件日志

  • Request Url
{api_url}/dataLog/eventLog/findByIid

  • Request Method

    POST

  • Request Body

字段 值描述 必填
iid 设备上报的事件消息id 是
createDate 日志创建事件 是

示例：

{
    "iid": "",
    "createDate": "2020-12-01 00:00:00"
}


  • Response Body
字段 值描述
documentId 日志id
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，这里为"event"
createDate 创建时间
sids sid
names 事件的名称
paramMap 参数内容，key：pid，value：pvalue
--- ---
content 服务属性内容
content中的did 设备sn
content中的event 服务定义id
content中的out 事件的参数

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 35,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "event",
                "content": "{\"devices\":[{\"event\":\"testE1\",\"did\":\"xxx\",\"out\":{\"parameter2\":true,\"parameter1\":\"abc\"}}]}",
                "createDate": "2020-12-12 15:44:47"
            },
            {
                "iid": "xxx2",
                "deviceSn": "xxx",
                "pdid": "",
                "act": "event",
                "content": "{\"devices\":[{\"event\":\"testE2\",\"did\":\"xxx\",\"out\":{\"parameter2\":false,\"parameter1\":\"efg\"}}]}",
                "createDate": "2020-12-12 15:40:26"
            }
        ]
    }
}


获取事件日志，获取iid相关联的所有事件日志

  • Request Url
{api_url}/dataLog/eventLog/linkLog

  • Request Method

    POST

  • Request Body

字段 值描述 必填
documentId 日志id 是
createDate 日志创建事件 是

示例：

{
    "documentId": "",
    "createDate": "2020-12-01 00:00:00"
}


  • Response Body
字段 值描述
documentId 日志id
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，这里为"event"
createDate 创建时间
sids sid
names 事件的名称
paramMap 参数内容，key：pid，value：pvalue
--- ---
content 服务属性内容
content中的did 设备sn
content中的event 服务定义id
content中的out 事件的参数

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 35,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "event",
                "content": "{\"devices\":[{\"event\":\"testE1\",\"did\":\"xxx\",\"out\":{\"parameter2\":true,\"parameter1\":\"abc\"}}]}",
                "createDate": "2020-12-12 15:44:47"
            },
            {
                "iid": "xxx2",
                "deviceSn": "xxx",
                "pdid": "",
                "act": "event",
                "content": "{\"devices\":[{\"event\":\"testE2\",\"did\":\"xxx\",\"out\":{\"parameter2\":false,\"parameter1\":\"efg\"}}]}",
                "createDate": "2020-12-12 15:40:26"
            }
        ]
    }
}


设备命令日志

  • Request Url
{api_url}/dataLog/cmdLog/findPage

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 是
deviceSn 设备sn 是
startDate 起始时间 否
endDate 结束时间 否
content 命令内容 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "content": ""
}


  • Response Body
字段 值描述
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，这里为"cmd"
ack 响应topic
intent 命令类型，getProperties：获取服务属性，setProperties：设置服务属性，action：调用方法，upgrade：固件升级
createDate 创建时间
content 命令内容
content中的did 设备sn
content中的propts setProperties时需要设置的服务属性，示例中的"1-0"：1代表服务定义id，0代表属性定义id
content中的serv_pros getProperties时需要获取的服务属性
content中的method action时的方法名称
content中的in action时的方法的输入参数
content中的model upgrade时的固件类型
content中的imgurl upgrade时的固件链接地址
content中的imgsize upgrade时的固件文件大小
content中的version upgrade时的版本号
content中的md5 upgrade时的文件的md5校验码
content中的startDate upgrade时的允许升级的开始时间
content中的endDate upgrade时的允许升级的结束时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 100,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "cmd",
                "ack": "svr/xxx",
                "content": "{\"devices\":[{\"propts\":{\"1-0\":123,\"2-0\":\"abc\"},\"did\":\"xxx\"}],\"intent\":\"setProperties\"}",
                "intent": "setProperties",
                "createDate": "2021-12-15 10:38:58"
            },
            {
                "iid": "xxx2",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "cmd",
                "ack": "svr/xx",
                "content": "{\"devices\":[{\"serv_pros\":[\"1-0\",\"2-0\"],\"did\":\"xxx\"}],\"intent\":\"getProperties\"}",
                "intent": "getProperties",
                "createDate": "2021-12-15 10:38:51"
            },
            {
                "iid": "xxx3",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "cmd",
                "ack": "svr/xxx",
                "content": "{\"action\":[{\"method\":\"setup_apk\",\"in\":{\"test\":true,\"testliz\":345,\"test1\":5456.987},\"did\":\"xxx\"}],\"intent\":\"action\"}",
                "intent": "action",
                "createDate": "2020-12-12 17:01:17"
            },
            {
                "iid": "xxx4",
                "pdid": "",
                "deviceSn": "xxx",
                "act": "cmd",
                "ack": "svr/xxx",
                "content": "{\"upgrade\":[{\"imgurl\":\"http_url\",\"endDate\":\"23:59\",\"model\":\"m1\",\"imgsize\":10915757,\"version\":\"11.12.29\",\"did\":\"xxx\",\"startDate\":\"00:00\"}],\"intent\":\"upgrade\"}",
                "intent": "upgrade",
                "createDate": "2020-12-11 15:00:11"
            }
        ]
    }
}


设备消息响应日志

  • Request Url
{api_url}/dataLog/msgRespLog/get

  • Request Method

    POST

  • Request Body

字段 值描述 必填
iid 消息id 是

示例：

{
    "iid": "xxx1"
}


  • Response Body
字段 值描述
iid 消息id
pdid 产品id
deviceSn 设备sn
act 消息类型，"upload-resp"：设备上报(服务属性)，"event-resp"：设备事件，"cmd-resp"：命令响应，
handleStatus 处理状态，0：成功，1：失败
handleMessage 是否处理失败的消息
createDate 创建时间
logSource 响应的数据内容

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "iid": "xxx1",
        "pdid": "",
        "deviceSn": "xxx",
        "act": "upload-resp",
        "handleStatus": 0,
        "handleMessage": null,
        "logSource": "{\"act\":\"upload-resp\",\"iid\":\"6c233bb44eb94b8dafe2388e0ffcbcd2\"}",
        "createDate": "2020-12-12 15:57:51"
    }
}


离线日志

  • Request Url
{api_url}/dataLog/offlineLog/findPage

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 是
deviceSn 设备sn 是
startDate 起始时间 否
endDate 结束时间 否
offline 0：在线，1：离线 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "offline": 0
}


  • Response Body
字段 值描述
iid 消息id
pdid 产品id
deviceSn 设备sn
offline 0：在线，1：离线
offlineDate 离线时间
createDate 创建时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 67,
        "data": [
            {
                "pdid": "",
                "deviceSn": "xxx",
                "offline": 1,
                "offlineDate": "2020-12-28 18:22:47",
                "createDate": "2020-12-28 18:22:47"
            },
            {
                "deviceSn": "xxx",
                "pdid": "",
                "offline": 0,
                "offlineDate": "2020-12-26 11:07:33",
                "createDate": "2020-12-26 11:07:34"
            }
        ]
    }
}


固件升级任务日志

  • Request Url
{api_url}/dataLog/firmwareUpdateJobLog/findPage

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 是
deviceSn 设备sn 是
startDate 起始时间 否
endDate 结束时间 否
startVersion 需要升级的设备版本 否
endVersion 升级的目标版本 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "startVersion": "1.1.1",
    "endVersion": "11.12.29"
}


  • Response Body
字段 值描述
iid 消息id
pdid 产品id
deviceSn 设备sn
jobId 固件升级任务id
jobName 固件升级任务名称
firmwareId 固件id
firmwareName 固件名称
model 固件型号
startVersion 需要升级的设备版本
endVersion 升级的目标版本
createDate 创建时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 3,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "jobId": 1,
                "jobName": "test111",
                "firmwareId": 1,
                "firmwareName": "testName",
                "model": "m1",
                "startVersion": "1.1.1",
                "endVersion": "11.12.29",
                "createDate": "2020-12-26 15:00:11"
            }
        ]
    }
}


告警日志

  • Request Url
{api_url}/dataLog/alarmRuleLog/findPage

  • Request Method

    POST

  • Request Body

字段 值描述 必填
pageIndex 分页的页码，从1开始 是
pageSize 每页显示数据条数 是
pdid 产品id 是
deviceSn 设备sn 是
startDate 起始时间 否
endDate 结束时间 否
ruleName 告警规则名称 否

示例：

{
    "pageIndex": 1,
    "pageSize": 10,
    "pdid": "",
    "deviceSn": "xxx",
    "startDate": "2020-12-01 00:00:00",
    "endDate": "2020-12-31 00:00:00",
    "ruleName": "",
}


  • Response Body
字段 值描述
documentId 日志id
createDate 创建时间
iid 消息id
pdid 产品id
deviceSn 设备sn
ruleId 告警规则id
ruleName 告警规则名称
ruleLevel 告警级别，0：轻级，1：中级，2：严重
triggerType 触发类型，0：service根据属性触发，1：event根据事件触发
alarmType 告警类型, 0：告警, 1：故障
sid 即service、event等的定义id
deviceIdParameters 设备参数源数据, key1为sid，key2为pid

示例：

{
    "status": 0,
    "description": "成功",
    "payload": {
        "pageIndex": 1,
        "pageSize": 10,
        "total": 16,
        "data": [
            {
                "iid": "xxx1",
                "pdid": "",
                "deviceSn": "xxx",
                "ruleId": 1,
                "ruleName": "testEventAlarm",
                "ruleLevel": 1,
                "triggerType": 1,
                "createDate": "2020-12-12 15:40:28"
            }
        ]
    }
}

results matching ""

    No results matching ""