1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
获取设备上下线日志
默认接口请求频率限制:10000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeviceStatusLog。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-15。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
MinTime | 是 | Integer | 开始时间(毫秒) 示例值:1548677099000 |
MaxTime | 是 | Integer | 结束时间(毫秒) 示例值:1548763499000 |
ProductId | 是 | String | 产品ID 示例值:QY8BAN391G |
DeviceName | 是 | String | 设备名称 示例值:dev_test |
Limit | 否 | Integer | 返回条数 示例值:5 |
Context | 否 | String | 检索上下文 示例值:H541SOP191FAWEF== |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Listover | Boolean | 数据是否已全部返回,true 表示数据全部返回,false 表示还有数据待返回,可将 Context 作为入参,继续查询返回结果。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Context | String | 检索上下文,当 ListOver 为false时,可以用此上下文,继续读取后续数据 注意:此字段可能返回 null,表示取不到有效值。 |
Results | Array of DeviceStatusLogItem | 日志数据结果数组,返回对应时间点及取值。 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 日志数据结果总条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取设备上下线日志
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceStatusLog
<公共请求参数>
{
"MinTime": 1548677099000,
"MaxTime": 1548763499000,
"ProductId": "QY8BAN391G",
"DeviceName": "dev_test",
"Limit": 5
}
输出示例
{
"Response": {
"TotalCount": 0,
"Listover": true,
"Results": [
{
"Data": "xx",
"Type": "xx",
"Time": "xx"
}
],
"Context": "xx",
"RequestId": "5e9bb8c5-95d3-40f8-ba9f-9d74a31004f2"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnsupportedOperation | 操作不支持。 |