1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
拉取云存事件列表
默认接口请求频率限制:10000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCloudStorageEvents。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-15。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ProductId | 是 | String | 产品ID 示例值:QDA1PZLBNB |
DeviceName | 是 | String | 设备名称 示例值:dev01 |
StartTime | 否 | Integer | 起始时间(Unix 时间戳,秒级), 为0 表示 当前时间 - 24h 示例值:1560355200 |
EndTime | 否 | Integer | 结束时间(Unix 时间戳,秒级), 为0 表示当前时间 示例值:1601196327 |
Context | 否 | String | 请求上下文, 用作查询游标 示例值:DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA |
Size | 否 | Integer | 查询数据项目的最大数量, 默认为10。假设传Size=10,返回的实际事件数量为N,则 5 <= N <= 10。 示例值:10 |
EventId | 否 | String | 事件标识符,可以用来指定查询特定的事件,如果不指定,则查询所有事件。 示例值:low_voltage |
UserId | 否 | String | 用户ID 示例值:user |
ChannelId | 否 | Integer | 通道ID 非NVR设备则不填 NVR设备则必填 默认为无 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Events | Array of CloudStorageEvent | 云存事件列表 |
Context | String | 请求上下文, 用作查询游标 示例值:DnF1ZXJ5VGhlbkZldGNoCgAAAAAAABO3FkI2SzRCVTJYUjZxUVRnbUJRaUJzc0EA |
Listover | Boolean | 拉取结果是否已经结束 示例值:true |
Total | Integer | 内部结果数量,并不等同于事件总数。 示例值:10 |
VideoURL | String | 视频播放URL 示例值:http://test.iotvideo.tencentcs.com/timeshift/live/test.m3u8 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取云存事件列表
输入示例
输出示例
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 | 操作不支持。 |