物联网开发平台获取设备历史数据-API 文档-文档中心-腾讯云

1. 接口描述

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

获取设备在指定时间范围内上报的历史数据。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDeviceDataHistory。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
MinTime	是	Integer	区间开始时间（Unix 时间戳，毫秒级）示例值：1548677099000
MaxTime	是	Integer	区间结束时间（Unix 时间戳，毫秒级）示例值：1548763499000
ProductId	是	String	产品ID 示例值：LJ0INDNU7U
DeviceName	是	String	设备名称示例值：light1
FieldName	是	String	属性字段名称，对应数据模板中功能属性的标识符示例值：color
Limit	否	Integer	返回条数示例值：5
Context	否	String	检索上下文示例值：xxx

3. 输出参数

参数名称	类型	描述
FieldName	String	属性字段名称，对应数据模板中功能属性的标识符注意：此字段可能返回 null，表示取不到有效值。示例值：color
Listover	Boolean	数据是否已全部返回，true 表示数据全部返回，false 表示还有数据待返回，可将 Context 作为入参，继续查询返回结果。注意：此字段可能返回 null，表示取不到有效值。示例值：1
Context	String	检索上下文，当 ListOver 为false时，可以用此上下文，继续读取后续数据注意：此字段可能返回 null，表示取不到有效值。示例值：xxx
Results	Array of DeviceDataHistoryItem	历史数据结果数组，返回对应时间点及取值。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备历史数据

获取设备历史数据

输入示例

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

{
    "MinTime": 1548677099000,
    "MaxTime": 1548763499000,
    "ProductId": "LJ0INDNU7U",
    "DeviceName": "light1",
    "FieldName": "color",
    "Limit": 5
}

输出示例

{
    "Response": {
        "RequestId": "5c982342-fb08-4fac-8e70-f63834667b52",
        "FieldName": "color",
        "Listover": true,
        "Context": "",
        "Results": [
            {
                "Time": "1550055697000",
                "Value": "1"
            },
            {
                "Time": "1550055698000",
                "Value": "3"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.DBOpertaionError	DB操作错误。
InternalError.InternalRPCError	内部RPC错误。
InternalError.InternalServerException	发生错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound.DeviceNotExist	设备不存在。
ResourceNotFound.ProductNotExist	产品不存在。
ResourceNotFound.StudioProductNotExist	产品不存在。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionToStudioProduct	产品ACL错误。
UnsupportedOperation.InstanceIsolated	由于实例到期已被禁用，请续费后使用。