获取设备的历史事件

最近更新时间:2019-08-29 20:37:41

1. 接口描述

接口请求域名: iotexplorer.tencentcloudapi.com 。

获取设备的历史事件

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListEventHistory
Version String 公共参数,本接口取值:2019-04-23
Region String 公共参数,详见产品支持的 地域列表
ProductId String 产品ID
DeviceName String 设备名称
Type String 搜索的事件类型
StartTime Integer 起始时间, 为0 表示 当前时间 - 24h
EndTime Integer 结束时间, 为0 表示当前时间
Context String 搜索上下文, 用作查询游标
Size Integer 单次获取的历史数据项目的最大数量

3. 输出参数

参数名称 类型 描述
Context String 搜索上下文, 用作查询游标
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 搜索结果数量
注意:此字段可能返回 null,表示取不到有效值。
Listover Boolean 搜索结果是否已经结束
注意:此字段可能返回 null,表示取不到有效值。
EventHistory Array of EventHistoryItem 搜集结果集
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ListEventHistory

用于查询设备上报的历史事件信息

输入示例

https://iotcloud.tencentcloudapi.com/?Action=ListEventHistory
&ProductId=QDA1PZLBNB&DeviceName=dev01
&EndTime=1560417460&StartTime=1560355200&Type=
&Context=&Size=50
&<公共请求参数>

输出示例

{
  "Listover": true,
  "RequestId": "3b64cf0b-c10e-4b4a-97a1-40ab7116b362",
  "EventHistory": [
    {
      "TimeStamp": 1561619346000,
      "ProductId": "QDA1PZLBNB",
      "DeviceName": "dev01",
      "EventId": "low_voltage",
      "Type": "alert",
      "Data": "{\"voltage\": 3.487172}"
    }
  ],
  "Total": 1,
  "Context": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EAAAAAAAATuBZCNks0QlUyWFI2cVFUZ21CUWlCc3NBAAAAAAAAE7kWQjZLNEJVMlhSNnFRVGdtQlFpQnNzQQAAAAAAABO6FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EAAAAAAAATuxZCNks0QlUyWFI2cVFUZ21CUWlCc3NBAAAAAAAAE7wWQjZLNEJVMlhSNnFRVGdtQlFpQnNzQQAAAAAAABO9FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EAAAAAAAATvhZCNks0QlUyWFI2cVFUZ21CUWlCc3NBAAAAAAAAE78WQjZLNEJVMlhSNnFRVGdtQlFpQnNzQQAAAAAAABPAFkI2SzRCVTJYUjZxUVRnbUJRaUJzc0E="
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ProductAlreadyExist 创建的产品名已存在。
InvalidParameterValue.ProductIDInvalid 产品ID非法。
ResourceNotFound.ProductNotExist 产品不存在。
ResourceNotFound.ProductOrDeviceNotExist 产品或设备不存在。
ResourceNotFound.ProjectNotExist 项目不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermissionToProject 项目ACL错误。
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。