1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
查询指定设备的云存 AI 分析任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCloudStorageAIServiceTasks。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
ProductId | 是 | String | 产品 ID 示例值:TQBDY6RPI9 |
DeviceName | 是 | String | 设备名称 示例值:cs_112114601_2 |
ServiceType | 是 | String | 云存 AI 服务类型。可选值: - RealtimeObjectDetect :目标检测- Highlight :视频浓缩- VideoToText :视频语义理解示例值:Highlight |
Limit | 是 | Integer | 分页拉取数量 示例值:20 |
Offset | 否 | Integer | 分页拉取偏移 示例值:0 |
Status | 否 | Integer | 任务状态。可选值: - (不传):查询全部状态的任务 - 1 :失败- 2 :成功但结果为空- 3 :成功且结果非空- 4 :执行中示例值:3 |
UserId | 否 | String | 用户 ID 示例值:user |
ChannelId | 否 | Integer | 通道 ID 示例值:1 |
DeviceNames.N | 否 | Array of String | 设备名称列表。 当需要同时查询多台设备的任务列表时传入,优先级高于参数 DeviceName 示例值:["dev001", "dev002"] |
StartTime | 否 | Integer | 查询任务时间范围的起始时间(秒级 UNIX 时间戳) 示例值:1740585600 |
EndTime | 否 | Integer | 查询任务时间范围的结束时间(秒级 UNIX 时间戳) 示例值:1740671999 |
FileURLExpireTime | 否 | Integer | 下载 URL 的过期时间。 若传入该参数,则响应中将包含所有文件的下载 URL 示例值:1743436800 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Tasks | Array of CloudStorageAIServiceTask | 任务列表 |
Total | Integer | 任务数量 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询视频浓缩结果列表
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudStorageAIServiceTasks
<公共请求参数>
{
"ProductId": "KH6Q8C4N0D",
"DeviceName": "aaa_31400554_1",
"ServiceType": "Highlight",
"Offset": 0,
"Limit": 20
}
输出示例
{
"Response": {
"Tasks": [
{
"TaskId": "fb066d7a-baac-4706-acda-058f56f82759",
"ProductId": "TQBDY6RPI9",
"DeviceName": "cs_112114601_2",
"ChannelId": 0,
"ServiceType": "Highlight",
"StartTime": 1710487888,
"EndTime": 1710487898,
"Status": 3,
"Result": "",
"Files": [
"highlight.mp4",
"thumbnail.jpg"
],
"FilesInfo": [
{
"FileName": "highlight.mp4"
},
{
"FileName": "thumbnail.mp4"
}
],
"CreateTime": 1710490000,
"UpdateTime": 1710490000
}
],
"Total": 1,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
示例2 查询视频语义理解结果列表
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudStorageAIServiceTasks
<公共请求参数>
{
"ProductId": "TSLFHRWDSD",
"DeviceName": "dev004",
"ServiceType": "VideoToText",
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"RequestId": "b97d82c1-bf0b-421b-a2c1-cc5053c214ea",
"Tasks": [
{
"ChannelId": 0,
"CreateTime": 1736994466,
"DeviceName": "dev004",
"EndTime": 1736994458,
"Files": [],
"ProductId": "TSLFHRWDSD",
"Result": "{\"DetectedClassifications\": [\"person\"], \"Summary\": \"一个人在雨天街道上行走\"}",
"ServiceType": "VideoToText",
"StartTime": 1736994450,
"Status": 3,
"TaskId": "01946cf0-27ee-7ebc-b3a3-5ae31ff61424",
"UpdateTime": 1736994478
}
],
"Total": 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ProductIotVideoServiceNotEnabled | 产品未开通 IoT Video 服务 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |