物联网开发平台创建 TWeSee COS 直传凭据

1. 接口描述

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

创建 TWeSee COS 直传凭据。调用方获取临时密钥后，可将视频 / 图片上传到返回的 StoragePath 前缀下；对象上传成功后由 COS 事件触发 TWeSee 任务创建。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateTWeSeeDirectUploadCredential。
Version	是	String	公共参数，本接口取值：2019-04-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou 。
ProductId	是	String	产品 ID 非 IoT 设备可传 `default` 示例值：4AHMY9X89Y
DeviceName	是	String	设备名称示例值：dev002
ServiceType	是	String	算法类型枚举值： VID_COMP：视频理解（支持视频文件或多帧图片） IMG_COMP：图片理解（单帧图片）示例值：VID_COMP
ChannelId	否	Integer	通道 ID 默认值：0 示例值：0
CallbackId	否	String	回调目标 ID 示例值：cb-n9sl1wur
ComprehensionConfig	否	SeeComprehensionConfig	视觉理解配置项
CustomId	否	String	自定义事件 ID，会透传到任务元数据与回调中示例值：custom-id-123
DurationSeconds	否	Integer	临时密钥有效期，单位：秒。默认 300 秒，取值范围 5 到 86400。示例值：86400
MaxInvokeCount	否	Integer	该直传凭据最多可触发的分析次数取值范围：[1, 10000] 默认值：1 示例值：200
StorageRegion	否	String	上传 COS 存储桶所在地域。不填时使用默认地域。示例值：ap-guangzhou
UploadMethod	否	String	上传方式枚举值： single：单文件上传 manifest：上传源文件与 Manifest（先上传多个源文件，然后上传 Manifest JSON 触发分析）默认值：single 示例值：manifest

3. 输出参数

参数名称	类型	描述
ExpiredTime	Integer	访问 COS 的临时密钥过期时间（秒级 UNIX 时间戳）示例值：1782809094
SecretId	String	访问 COS 的临时密钥 SecretId 示例值：AKIDbz4LQvqmLPyr9wHI2jo***i1cuAW8mbg5nd5HMUvjh26
SecretKey	String	访问 COS 的临时密钥 SecretKey 示例值：sxuVY/Gx0MYKgcj***vO+OWUsqrxFgU=
StorageBucket	String	COS 存储桶名称示例值：twesee-input-test-1258344699
StoragePath	String	COS 对象 Key 前缀。返回的临时凭据仅允许上传到此前缀下，格式为 Direct/{Uin}/{SessionId}/。示例值：Direct/700000975417/019f128d-8cfa-774d-a195-5bc9f9e4e5d9/
StorageRegion	String	COS 存储桶所在地域示例值：ap-guangzhou
Token	String	访问 COS 的临时密钥 Token 示例值：8tE1OzlWwpXF***WOoHgaZIj8tk
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建 TWeSee COS 直传凭据

输入示例

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

{
    "ProductId": "4AHMY9X89Y",
    "DeviceName": "dev002",
    "ServiceType": "VID_COMP",
    "ChannelId": 0,
    "CallbackId": "cb-n9sl1wur",
    "CustomId": "custom-id-123",
    "DurationSeconds": 86400,
    "MaxInvokeCount": 200,
    "StorageRegion": "ap-guangzhou",
    "UploadMethod": "manifest"
}

输出示例

{
    "Response": {
        "ExpiredTime": 1782809094,
        "SecretId": "AKIDbz4LQvqmLPyr9wHI2jo***********************i1cuAW8mbg5nd5HMUvjh26",
        "SecretKey": "sxuVY/Gx0MYKgcj***************vO+OWUsqrxFgU=",
        "StorageBucket": "twesee-input-test-1258344699",
        "StoragePath": "Direct/700000975417/019f128d-8cfa-774d-a195-5bc9f9e4e5d9/",
        "StorageRegion": "ap-guangzhou",
        "Token": "8tE1OzlWwpXFWOoHgaZIj8tkfxYrfMDa66eac88da6820056a20bdb1928cfe5050AXEPri_7vsnPiWB9dNtYuSXlxlCr1ziGfXw2OJm9HRUImer3rIMrqIX-qURjgfS85QYWk4w_3VGrH6ogH3iq9H-KlbnyTXPDaTjBkMsudFyhO7MYajMoaUZC*****************************************************************************************************************************************************************************************O8nplkBg1AbAldlJ-1nb-Hr-1pRSusV2k4qgDKjnp2-7gPD8Pmu2kqFDYyLY5fp8ktMj_r6ZBMPRso4kj_m1qSvdMKqmnlZbW1tJXLJ0ltJb1KLinCY8iGB_hFbj2AKorF_BSF30Bl47oDsHLvWivEVuVFX1yNSH2KdIdT7ZldmK97wLNZVISGwqY",
        "RequestId": "8be65a7a-cfc9-45f7-ac4c-3210cbfb48b6"
    }
}

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. 错误码

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

错误码	描述
FailedOperation.SeePostPaidServiceIsolated	TWeSee 后付费服务已隔离
FailedOperation.SeePostPaidServiceIsolatedByAccount	TWeSee 后付费服务已隔离（账号欠费）
FailedOperation.SeePostPaidServiceNotExists	未开通 TWeSee 算法的后付费服务
InternalError	内部错误。
InternalError.DBOperationError	DB操作错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound.SeeCallbackNotExist	指定的 TWeSee 回调目标不存在
UnsupportedOperation	操作不支持。

创建 TWeSee COS 直传凭据

本页目录：