1. 接口描述
接口请求域名： iotexplorer.tencentcloudapi.com 。
修改 TWeSee 预付费订阅
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyTWeSeeSubscription。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
| ProductId | 是 | String | 产品 ID 示例值：4AHMY9X89Y |
| DeviceName | 是 | String | 设备名称 示例值：dev002 |
| ServiceType | 是 | String | 算法类型。可选值： - VID_COMP：视频理解示例值：VID_COMP |
| ChannelId | 否 | Integer | 通道 ID 示例值：0 |
| Enabled | 否 | Boolean | 功能开关。true 为开启，false 为关闭；不传表示不修改示例值：true |
| ComprehensionConfig | 否 | SeeComprehensionConfig | 视觉理解配置（适用于视频理解、图片理解），不传则不修改 |
| CompHighlightConfig | 否 | SeeCompHighlightConfig | 视频语义浓缩配置（适用于视频语义浓缩），不传则不修改 |
| EventIdFilterConfig | 否 | SeeEventIdFilterConfig | 云存事件 ID 过滤规则配置，不传则不修改 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置云存事件 ID 过滤规则
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTWeSeeSubscription
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev002",
"ServiceType": "VID_COMP",
"ChannelId": 0,
"EventIdFilterConfig": {
"IncludeOnly": [
"_sys_id1_data"
]
}
}输出示例
{
"Response": {
"RequestId": "e53525ed-e1c1-4748-81fa-513e89fa55c8"
}
}示例2 设置输出语言
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTWeSeeSubscription
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev002",
"ServiceType": "VID_COMP",
"ChannelId": 0,
"ComprehensionConfig": {
"OutputLang": "zh",
"AlternativeOutputLang": "en"
}
}输出示例
{
"Response": {
"RequestId": "c6d53e3e-15c5-4a56-8331-d3b680c12220"
}
}示例3 设置启用视频搜索高级功能
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTWeSeeSubscription
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev002",
"ServiceType": "VID_COMP",
"ChannelId": 0,
"ComprehensionConfig": {
"EnableSearch": true
}
}输出示例
{
"Response": {
"RequestId": "8f0e601e-cbac-4e5c-8443-e3c1478ec5a2"
}
}示例4 设置需检测的事件标签
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTWeSeeSubscription
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev002",
"ServiceType": "VID_COMP",
"ChannelId": 0,
"ComprehensionConfig": {
"DetectTypes": [
"person_climbing_fence"
]
}
}输出示例
{
"Response": {
"RequestId": "1b32234f-60bb-48dc-9791-2fffc690b035"
}
}示例5 设置多摄布局
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTWeSeeSubscription
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev002",
"ServiceType": "VID_COMP",
"ChannelId": 0,
"ComprehensionConfig": {
"MultiCameraLayout": "Vertical,Num=2,Index=0;1"
}
}输出示例
{
"Response": {
"RequestId": "5f73ced5-7059-4698-ba18-3d1683f1e06a"
}
}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.SeePrePaidSubscriptionInvalidStatus | TWeSee 预付费订阅状态异常，不能进行该操作 |
| FailedOperation.SeePrePaidSubscriptionIsolated | TWeSee 预付费订阅已隔离，不能进行该操作 |
| InternalError | 内部错误。 |
| InternalError.DBOperationError | DB操作错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.DeviceChannelNotExist | 设备通道尚未创建或已被删除。 |
| ResourceNotFound.DeviceNotExist | 设备不存在。 |
| ResourceNotFound.SeePrePaidSubscriptionNotExist | TWeSee 预付费订阅不存在 |
