物联网智能视频服务（消费版）
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 物联网智能视频服务（消费版） > API 文档 > 消费版数据查询相关接口 > 获取设备的历史事件

获取设备的历史事件

最近更新时间：2024-03-12 01:35:03

我的收藏

本页目录：

1. 接口描述

接口请求域名： iotvideo.tencentcloudapi.com 。

获取设备的历史事件

默认接口请求频率限制：5000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDeviceEventHistory。
Version 是 String 公共参数，本接口取值：2021-11-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
ProductId 是 String 产品ID
示例值：QDA1PZLBNB
DeviceName 是 String 设备名称
示例值：dev01
Type 否 String 搜索的事件类型：alert 表示告警，fault 表示故障，info 表示信息，为空则表示查询上述所有类型事件
示例值：alert
StartTime 否 Integer 起始时间（Unix 时间戳，秒级）, 为0 表示 当前时间 - 24h
示例值：1560355200
EndTime 否 Integer 结束时间（Unix 时间戳，秒级）, 为0 表示当前时间
示例值：1601196327
Context 否 String 搜索上下文, 用作查询游标
示例值：DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA
Size 否 Integer 单次获取的历史数据项目的最大数量, 缺省10
示例值：10
EventId 否 String 事件标识符，可以用来指定查询特定的事件，如果不指定，则查询所有事件。
示例值：low_voltage

3. 输出参数

参数名称 类型 描述
Context String 搜索上下文, 用作查询游标
注意：此字段可能返回 null，表示取不到有效值。
示例值：DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA
Total Integer 搜索结果数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：10
Listover Boolean 搜索结果是否已经结束
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
EventHistory Array of EventHistoryItem 搜集结果集
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备的历史事件

输入示例

POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceEventHistory
<公共请求参数>

{
    "ProductId": "QDA1PZLBNB",
    "DeviceName": "dev01",
    "Type": "",
    "EventId": "low_voltage",
    "StartTime": 1560355200,
    "EndTime": 1601196327,
    "Size": 50
}

输出示例

{
    "Response": {
        "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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
UnsupportedOperation 操作不支持。
中国站