1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
用于查询设备本地录像时间轴信息,为NVR/IPC本地存储的录像。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ControlRecordTimeline。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ChannelId | 是 | String | 通道 ID(从通道查询接口DescribeDeviceChannel中获取) 示例值:f7ca505f-be1b-4ce8-849b-**** |
Start | 是 | Integer | 起始时间 示例值:1702554113 |
End | 是 | Integer | 结束时间 示例值:1702555113 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of Timeline | 返回数据 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ControlRecordTimeline
<公共请求参数>
{
"ChannelId": "12345678-abcd-efgh-ijkl-1234567890ab",
"Start": 1685611685,
"End": 1685611785
}
输出示例
{
"Response": {
"Data": [
{
"Begin": 1687276800,
"End": 1687278194
}
],
"RequestId": "57c7a6c6-8334-450b-9a57-4c2c2a6e26d2"
}
}
示例2 无本地录像结果
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ControlRecordTimeline
<公共请求参数>
{
"ChannelId": "12345678-abcd-efgh-ijkl-1234567890ab",
"Start": 1685611685,
"End": 1685611785
}
输出示例
{
"Response": {
"Data": null,
"RequestId": "57c7a6c6-8334-450b-9a57-4c2c2a6e26d2"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DeviceResponseTimeOut | 设备响应超时 |
FailedOperation.DeviceResultTimeOut | 设备端结果响应超时 |
InvalidParameterValue | 无效的参数值 |
InvalidParameterValue.EndTimeZero | 结束时间不能为空 |
InvalidParameterValue.InvalidChannelId | 无效的通道ID |
InvalidParameterValue.StartOverEndTime | 开始时间不能大于结束时间 |
InvalidParameterValue.StartOverNowTime | 开始时间不能大于当前时间 |
InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | 开始时间不能大于等于结束时间 |
InvalidParameterValue.StartTimeZero | 开始时间不能为空 |
InvalidParameterValue.UnSupportedAccessType | 不支持的接入类型 |
ResourceNotFound | 资源不存在 |
ResourceUnavailable.DevDisable | 设备被禁用 |
ResourceUnavailable.DevNoRegister | 设备未注册 |
ResourceUnavailable.DevOffline | 设备离线 |