1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
开通 TWeSee 预付费订阅
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateTWeSeeSubscription。 |
| Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-guangzhou 。 |
| ProductId | 是 | String | 产品 ID 示例值:4AHMY9X89Y |
| DeviceName | 是 | String | 设备名称 示例值:dev002 |
| ServiceType | 是 | String | 算法类型。可选值: - VID_COMP:视频理解示例值:VID_COMP |
| ServiceTier | 是 | String | 套餐规格。可选值: - BASIC:包年包月基础版(适用于视频理解)示例值:BASIC |
| Period | 是 | Integer | 订阅购买时长,单位:月,支持 1-60 示例值:1 |
| ChannelId | 否 | Integer | 通道 ID 示例值:0 |
| CustomOrderId | 否 | String | 自定义订单 ID 示例值:order-0012 |
| RenewFlag | 否 | String | 续费标识。可选值: - NOTIFY_AND_MANUAL_RENEW:到期前通知并手动续费(默认)- NOTIFY_AND_AUTO_RENEW:到期前通知并自动续费- DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知且手动续费示例值:NOTIFY_AND_MANUAL_RENEW |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| OrderId | String | 订单 ID 示例值:20260420*550201 |
| Status | String | 订单状态 示例值:DELIVERED |
| ResourceId | String | 资源 ID 示例值:twesee-753yd29x30****jqww1 |
| OriginalPrice | String | 原价 示例值:2000 |
| DiscountPrice | String | 折后价 示例值:1200 |
| Currency | String | 币种 示例值:CNY |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开通 TWeSee 视频理解基础版
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTWeSeeSubscription
<公共请求参数>
{
"ProductId": "4AHMY9X89Y",
"DeviceName": "dev002",
"ServiceType": "VID_COMP",
"Period": 1,
"ServiceTier": "BASIC"
}
输出示例
{
"Response": {
"Currency": "CNY",
"DiscountPrice": "1200",
"OrderId": "20260420*********550201",
"OriginalPrice": "2000",
"ResourceId": "twesee-753yd29x30********jqww1",
"Status": "DELIVERED",
"RequestId": "6f7647ba-757c-439c-8781-c187b5a561f3"
}
}
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 | 操作失败。 |
| FailedOperation.AnotherOperationIsRunning | 已有操作正在进行中 |
| FailedOperation.BalanceInsufficient | 账户余额不足 |
| FailedOperation.CloudStoragePackageRequired | 需先开通云存套餐 |
| FailedOperation.CreateOrderFailed | 创建订单失败 |
| FailedOperation.CustomOrderIdAlreadyExist | 自定义订单 ID 已存在 |
| FailedOperation.DeliverOrderFailed | 订单发货失败 |
| FailedOperation.SeePrePaidSubscriptionAlreadyExists | 该设备已开通指定的 TWeSee 算法预付费订阅,不能重复开通 |
| FailedOperation.SeePrePaidSubscriptionConflicts | 该设备已开通的 TWeSee 算法预付费订阅与正在开通的 ServiceType 冲突 |
| FailedOperation.SeePrePaidSubscriptionEndTimeExceeded | TWeSee 预付费订阅生效时长不能超过已开通云存套餐的生效时长 |
| InternalError | 内部错误。 |
| InternalError.DBOperationError | DB操作错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.DeviceChannelNotExist | 设备通道尚未创建或已被删除。 |
| ResourceNotFound.DeviceNotExist | 设备不存在。 |
| UnauthorizedOperation.CertificationNeedUpgrade | 因账号安全升级,购买云资源需完善您的实名信息。 |
| UnauthorizedOperation.NoPermissionToPay | 当前子账号无支付权限 |
| UnauthorizedOperation.NotCertification | 账号没有实名认证,支付失败。 |
| UnsupportedOperation | 操作不支持。 |