1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
查询 TWeSee 直传信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTWeSeeDirectUploadInfo。 |
| Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
| ProductId | 是 | String | 产品 ID 示例值:default |
| DeviceName | 是 | String | 设备名称 示例值:dev001 |
| ServiceType | 是 | String | 服务类型。 枚举值:
示例值:VID_COMP |
| UploadMethod | 否 | String | 上传方式。 枚举值:
默认值:single 示例值:single |
| UploadTarget | 否 | String | 上传目标,固定取值为 枚举值:
默认值:stream 示例值:stream |
| ChannelId | 否 | Integer | 通道 ID,非 NVR 设备不填,NVR 设备必填 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| COSURI | String | TWeSee 直传目录的 COS URI 示例值:cos://twesee-input-125*99.ap-guangzhou/Direct/*711/vid-z1-s/ |
| StorageBucket | String | TWeSee 直传存储桶 示例值:twesee-input-125*99 |
| StoragePath | String | TWeSee 直传目录路径 示例值:Direct/*711/vid-z1-s/ |
| StorageRegion | String | TWeSee 直传存储地域 示例值:ap-guangzhou |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 TWeSee 直传信息
查询指定设备的视频理解单文件直传目录
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTWeSeeDirectUploadInfo
<公共请求参数>
{
"ProductId": "default",
"DeviceName": "dev001",
"ChannelId": 0,
"ServiceType": "VID_COMP",
"UploadTarget": "stream",
"UploadMethod": "single"
}
输出示例
{
"Response": {
"StorageRegion": "ap-guangzhou",
"StorageBucket": "twesee-input-125*****99",
"StoragePath": "Direct/*********711/vid-z1-s/",
"COSURI": "cos://twesee-input-125*****99.ap-guangzhou/Direct/*********711/vid-z1-s/",
"RequestId": "a0fc12a1-3196-4fa7-8125-10d29d52e8df"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ProductIotVideoServiceNotEnabled | 产品未开通 IoT Video 服务 |
| InternalError | 内部错误。 |
| InternalError.DBOperationError | DB操作错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.DeviceChannelNotExist | 设备通道尚未创建或已被删除。 |
| ResourceNotFound.DeviceNotExist | 设备不存在。 |
| ResourceNotFound.ProductNotExist | 产品不存在。 |