获取设备通讯日志

最近更新时间:2024-03-12 19:52:29

我的收藏

1. 接口描述

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

获取设备在指定时间范围内的通讯日志

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceCommLog。
Version String 公共参数,本接口取值:2020-12-15。
Region String 公共参数,本接口不需要传递此参数。
MinTime Integer 开始时间 13位时间戳 单位毫秒
示例值:1612235855834
MaxTime Integer 结束时间 13位时间戳 单位毫秒
示例值:1612237655834
ProductId String 产品ID
示例值:TDCZ2WD29Z
DeviceName String 设备名称
示例值:DoNotDelete_34082530_1
Limit Integer 返回条数 默认为50
示例值:10
Context String 检索上下文
示例值:xrnWgKu0fCz7q8JIQYFiNP
Type String 类型:shadow 下行,device 上行 默认为空则全部查询
示例值:shadow

3. 输出参数

参数名称 类型 描述
Listover Boolean 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。
示例值:true
Context String 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据
示例值:DnF1ZXJ5VGhlbkZldGNoBQAAAAAAk0zFFnBpdzE2UUE4UlZ1UnFtTjhIeV81THcA
Results Array of DeviceCommLogItem 日志数据结果数组,返回对应时间点及取值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备通讯日志

输入示例

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

{
    "ProductId": "TDCZ2WD29Z",
    "DeviceName": "DoNotDelete_34082530_1",
    "MinTime": 1612235855834,
    "MaxTime": 1612237655834
}

输出示例

{
    "Response": {
        "Context": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAk0zFFnBpdzE2UUE4UlZ1UnFtTjhIeV81THcAAAAAAIJzFxZ2aThIdjFTVlJveUo3aGEzRlBrRkdRAAAAAABDhPEWaUdjOWIxWTBUQ3lWNGxVOC1CeGQ5ZwAAAAAAX2TWFl9CSDZsdnE1UkNpbmJ3U3lfNTVGX0EAAAAAAIKcmhZDTnp1RmZPNVFVR1pLMWF4Q3V5eDNR",
        "Listover": true,
        "RequestId": "ce3c2fd6-e5d2-4676-9696-3d27e52f608d",
        "Results": []
    }
}

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 操作不支持。