物联使能
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联使能 > 物联使能 API > 数据查询 > 获取设备的历史事件

获取设备的历史事件

最近更新时间：2023-07-19 17:34:52

我的收藏

本页目录：

1. 接口描述

接口请求域名：iot.cloud.tencent.com/api/exploreropen/serviceapi。 本接口（ServiceListEventHistory）用于获取设备的历史事件。

2. 输入参数

名称
类型
必选
描述
Action
String
是
公共参数，本接口取值：ServiceListEventHistory。
RequestId
String
是
公共参数，唯一请求 ID，可自行生成，推荐使用 uuid。定位问题时，需提供该次请求的 RequestId。
AppKey
String
是
公共参数，物联网 SaaS 的 AppKey ，用于标识对应的物联网 SaaS。
Signature
String
是
公共参数，请求签名，需用户自行生成，用于校验请求的合法性。
Timestamp
Int64
是
公共参数，请求的 Unix 时间戳（秒级）。
Nonce
Int
是
公共参数，随机正整数，与 Timestamp 联合起来，防止重放攻击。
ProductId
String
是
产品 ID。
DeviceName
String
是
设备名。
Type
String
是
搜索的事件类型。
alert：表示告警。
fault：表示故障。
info：表示信息。
为空则表示查询上述所有类型事件。
Context
String
否
翻页游标，首次查询时，非必填。
StartTime
Int
是
起始时间（Unix 时间戳，秒级），为0表示当前时间 - 24h。
EndTime
Int
是
结束时间（Unix 时间戳，秒级），为0表示当前时间。
Size
Int
是
单页数据量。

3. 输出参数

名称
类型
描述
RequestId
String
公共参数，唯一请求 ID，与入参相同，定位问题时，需提供该次请求的 RequestId。
Context
String
翻页游标。
Total
Int
搜索结果数量。
Listover
Bool
数据是否查询完成。
true：表示未完成可继续读取。
false：表示已全部读取完成。
EventHistory
返回数据。

4. 示例

输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/serviceapi HTTP/1.1
content-type: application/json
{
    "RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68",
    "Timestamp": 1599468019,
    "Nonce": 170533123,
    "AppKey": "AppKey",
    "Signature": "Signature",
    "Action": "ServiceListEventHistory",
    "Context": "",
    "Type":"",
    "ProductId": "QD****LBNB",
    "DeviceName": "dev01",
    "StartTime": 1560355200,
    "EndTime": 1560417460,
    "Size": 20
}
输出示例: 成功
{
	"Listover": true,
	"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68",
	"EventHistory": [{
		"TimeStamp": 1561619346000,
		"ProductId": "QD****LBNB",
		"DeviceName": "dev01",
		"EventId": "low_voltage",
		"Type": "alert",
		"Data": "{\\"voltage\\": 3.487172}"
	}],
	"Total": 1,
	"Context": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EAAAAAAAATuBZCNks0QlUyWFI2cVFUZ21CUWlCc3NBAAAAAAAAE7kWQjZLNEJVMlhSNnFRVGdtQlFpQnNzQQAAAAAAABO6FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EAAAAAAAATuxZCNks0QlUyWFI2cVFUZ21CUWlCc3NBAAAAAAAAE7wWQjZLNEJVMlhSNnFRVGdtQlFpQnNzQQAAAAAAABO9FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EAAAAAAAATvhZCNks0QlUyWFI2cVFUZ21CUWlCc3NBAAAAAAAAE78WQjZLNEJVMlhSNnFRVGdtQlFpQnNzQQAAAAAAABPAFkI2SzRCVTJYUjZxUVRnbUJRaUJzc0E="
}

5. 错误码

错误码
描述
InternalError
内部错误。
ErrorRequiredParamNotFound
必选参数缺失。
InvalidAction
Action 非法。
InvalidParameterValue
参数非法。
InvalidParameterValue.InvalidJSON
请求格式不是 JSON。
?
中国站


http://www.vxiaotou.com