1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
查询 TWeSee 预付费订阅
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTWeSeeSubscription。 |
| Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
| ProductId | 是 | String | 产品 ID 示例值:69E4CNU1F0 |
| DeviceName | 是 | String | 设备名称 示例值:10001 |
| ServiceType | 是 | String | 算法类型。可选值:
示例值:VID_COMP |
| ChannelId | 否 | Integer | 通道 ID 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 资源 ID 示例值:twesee-753yd29zay9tzk8t140mner |
| ServiceTier | String | 套餐规格 枚举值:
示例值:ADVANCED |
| ExpireTime | Integer | 到期时间,秒级时间戳 示例值:1793172443 |
| Enabled | Boolean | 启用状态, 示例值:true |
| Status | String | 订阅状态。可能取值:
示例值:NORMAL |
| ComprehensionConfig | SeeComprehensionConfig | 视觉理解配置(适用于视频理解、图片理解) |
| CompHighlightConfig | SeeCompHighlightConfig | 视频语义浓缩配置(适用于视频语义浓缩) |
| EventIdFilterConfig | SeeEventIdFilterConfig | 云存事件 ID 过滤规则配置项 |
| SummarizeConfig | SeeSummarizeConfig | 每日与每周总结配置 |
| CreditsQuota | Float | 当前周期内的额度总量 示例值:9000 |
| CreditsUsed | Float | 当前周期内的已使用额度 示例值:23.5 |
| QuotaRefreshTime | Integer | 额度刷新时间 示例值:1793172443 |
| QuotaBasic | Integer | 当前周期基础能力总额度(已废弃,当 ServiceTier=BASIC 时,取值等于 CreditsQuota) 示例值:3000 |
| QuotaUsedBasic | Integer | 当前周期基础能力已用额度(已废弃,当 ServiceTier=BASIC 时,取值等于 CreditsUsed 向下取整) 示例值:2 |
| QuotaAdvanced | Integer | 当前周期高级能力总额度(已废弃,当 ServiceTier=ADVANCED 时,取值等于 CreditsQuota) 示例值:9000 |
| QuotaUsedAdvanced | Integer | 当前周期高级能力已用额度(已废弃,当 ServiceTier=ADVANCED 时,取值等于 CreditsUsed 向下取整) 示例值:23 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 TWeSee 视频理解订阅
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTWeSeeSubscription
<公共请求参数>
{
"ProductId": "69E4CNU1F0",
"DeviceName": "10001",
"ServiceType": "VID_COMP"
}
输出示例
{
"Response": {
"ComprehensionConfig": {
"DetectTypes": [
"person"
]
},
"CreditsQuota": 9000,
"CreditsUsed": 23.5,
"Enabled": true,
"ExpireTime": 1793172443,
"QuotaAdvanced": 9000,
"QuotaRefreshTime": 1793172443,
"QuotaUsedAdvanced": 23,
"ResourceId": "twesee-753yd29zay9tzk8t140mner",
"ServiceTier": "ADVANCED",
"Status": "NORMAL",
"RequestId": "3af64ac3-74d8-4435-b02a-1a0803427518"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.DBOperationError | DB操作错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.DeviceChannelNotExist | 设备通道尚未创建或已被删除。 |
| ResourceNotFound.DeviceNotExist | 设备不存在。 |
| ResourceNotFound.SeePrePaidSubscriptionNotExist | TWeSee 预付费订阅不存在 |