物联网开发平台查询 TWeSee 人员关联的云存事件

1. 接口描述

接口请求域名： iotexplorer.tencentcloudapi.com 。

查询 TWeSee 人员关联的云存事件及 AI 任务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCloudStorageEventsByTWeSeePerson。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou 。
ProductId	是	String	产品 ID 示例值：QDA1PZLBNB
DeviceName	是	String	设备名称示例值：dev001
PersonId	是	String	人员 ID 示例值：person-11111111-2222-3333-4444-555555555555
Limit	是	Integer	分页拉取数量，取值范围为 1-100 示例值：20
Offset	否	Integer	分页拉取偏移示例值：0
ChannelId	否	Integer	通道 ID，非 NVR 设备不填，NVR 设备必填示例值：0

3. 输出参数

参数名称	类型	描述
Events	Array of CloudStorageEventWithAITasks	人员关联的云存事件列表
Total	Integer	人员关联的云存事件总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 TWeSee 人员关联的云存事件

查询指定 TWeSee 人员所关联的云存事件及 AI 任务。

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudStorageEventsByTWeSeePerson
<公共请求参数>

{
    "ProductId": "QDA1PZLBNB",
    "DeviceName": "dev001",
    "ChannelId": 0,
    "PersonId": "person-11111111-2222-3333-4444-555555555555",
    "Offset": 0,
    "Limit": 20
}

输出示例

{
    "Response": {
        "Total": 1,
        "Events": [
            {
                "StartTime": 1710487888,
                "EndTime": 1710487898,
                "Thumbnail": "/10000****725/QDA****BNB/dev001/events/1710487888.jpg",
                "EventId": "event-123",
                "UploadStatus": "Finished",
                "Data": "",
                "AITasks": [
                    {
                        "TaskId": "fb066d7a-baac-4706-acda-058f56f82759",
                        "ProductId": "QDA1PZLBNB",
                        "DeviceName": "dev001",
                        "ChannelId": 0,
                        "ServiceType": "VideoToText",
                        "StartTime": 1710487888,
                        "EndTime": 1710487898,
                        "StartTimeMs": 1710487888270,
                        "EndTimeMs": 1710487898990,
                        "Status": 3,
                        "Result": "{\"Summary\":\"一个人在门前经过\"}",
                        "Files": [],
                        "CreateTime": 1711338476,
                        "UpdateTime": 1711338476,
                        "CustomId": "event-123"
                    }
                ]
            }
        ],
        "RequestId": "3eace4a0-d09c-4dc9-b91c-98c10d48b009"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.DBOperationError	DB操作错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound.DeviceChannelNotExist	设备通道尚未创建或已被删除。
ResourceNotFound.DeviceNotExist	设备不存在。
ResourceNotFound.SeePersonNotExist	指定的人员不存在
UnsupportedOperation	操作不支持。

查询 TWeSee 人员关联的云存事件

本页目录：