1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
同步执行设备云存 AI 分析任务
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:InvokeCloudStorageAIServiceTask。 |
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 |
StartTime | 是 | Integer | 待分析云存的起始时间 示例值:1704038400 |
EndTime | 是 | Integer | 待分析云存的结束时间 示例值:1704124800 |
ChannelId | 否 | Integer | 通道 ID 示例值:1 |
Config | 否 | String | 视频分析配置参数 示例值:{"param1":"value1"} |
ROI | 否 | String | 视频分析识别区域 示例值:{”x0":0,"x1":640,"y0":0,"y1":480} |
VideoURLs.N | 否 | Array of String | 分析外部传入的视频 URL 列表,支持 HLS 点播(m3u8)及常见视频格式(mp4 等) 示例值:["https://example.com/timeshift.m3u8"] |
CustomId | 否 | String | 自定义任务 ID 示例值:event-123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Completed | Boolean | 任务是否执行完成 示例值:true |
TaskId | String | 任务 ID 示例值:fb066d7a-baac-4706-acda-058f56f82759 |
TaskInfo | CloudStorageAIServiceTask | 任务信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建设备云存 AI 分析任务(执行成功)
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeCloudStorageAIServiceTask
<公共请求参数>
{
"ProductId": "TSLFHRWDSD",
"DeviceName": "dev002",
"ServiceType": "VideoToText",
"StartTime": 1732780832,
"EndTime": 1732780835,
"VideoURLs": [
"https://example.com/video.mp4"
]
}
输出示例
{
"Response": {
"Completed": true,
"RequestId": "5acdfd09-5634-4ae3-8ebd-1d4c33bb7dd7",
"TaskId": "019371d2-da8b-7171-a6de-fc077173b205",
"TaskInfo": {
"ChannelId": 0,
"CreateTime": 1732781464,
"DeviceName": "dev002",
"EndTime": 1732780835,
"Files": [],
"ProductId": "TSLFHRWDSD",
"Result": "{\"DetectedClassifications\": [\"person\"], \"Summary\": \"白衣人走在湿漉漉的路面上\"}",
"ServiceType": "VideoToText",
"StartTime": 1732780832,
"Status": 3,
"TaskId": "019371d2-da8b-7171-a6de-fc077173b205",
"UpdateTime": 1732781466
}
}
}
示例2 创建设备云存 AI 分析任务(超时未完成,转异步)
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InvokeCloudStorageAIServiceTask
<公共请求参数>
{
"ProductId": "TSLFHRWDSD",
"DeviceName": "dev002",
"ServiceType": "VideoToText",
"StartTime": 1732780832,
"EndTime": 1732780835,
"VideoURLs": [
"https://example.com/video.mp4"
]
}
输出示例
{
"Response": {
"Completed": false,
"RequestId": "5acdfd09-5634-4ae3-8ebd-1d4c33bb7dd7",
"TaskId": "019371d2-da8b-7171-a6de-fc077173b205",
"TaskInfo": {
"ChannelId": 0,
"CreateTime": 1732781464,
"DeviceName": "dev002",
"EndTime": 1732780835,
"Files": [],
"ProductId": "TSLFHRWDSD",
"Result": "",
"ServiceType": "VideoToText",
"StartTime": 1732780832,
"Status": 4,
"TaskId": "019371d2-da8b-7171-a6de-fc077173b205",
"UpdateTime": 1732781464
}
}
}
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.CloudStorageAIServiceTaskAlreadyExists | 云存 AI 分析任务已存在,不支持重复创建 |
FailedOperation.ProductIotVideoServiceNotEnabled | 产品未开通 IoT Video 服务 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceInsufficient.CloudStorageAIServiceTaskQuotaInsufficient | 云存 AI 分析任务创建额度不足 |