查询设备云存AI分析任务列表

最近更新时间:2024-07-30 01:46:57

我的收藏

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:视频浓缩
示例值:Highlight
Limit Integer 分页拉取数量
示例值:20
Offset Integer 分页拉取偏移
示例值:0
Status Integer 任务状态。可选值:
- (不传):查询全部状态的任务
- 1:失败
- 2:成功但结果为空
- 3:成功且结果非空
- 4:执行中
示例值:3
UserId String 用户 ID
示例值:user
ChannelId Integer 通道 ID
示例值:1

3. 输出参数

参数名称 类型 描述
Tasks Array of CloudStorageAIServiceTask 任务列表
Total Integer 任务数量
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询设备云存 AI 分析任务列表

输入示例

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": "PackageDetect",
                "StartTime": 1710487888,
                "EndTime": 1710487898,
                "Status": 3,
                "Result": "{\"param1\":\"value1\"}",
                "Files": [
                    "output.mp4"
                ],
                "CreateTime": 1710490000,
                "UpdateTime": 1710490000
            }
        ],
        "Total": 1,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.ProductIotVideoServiceNotEnabled 产品未开通 IoT Video 服务
InternalError 内部错误。
InvalidParameter 参数错误。