1. 接口描述
接口请求域名: tokenhub.tencentcloudapi.com 。
查询 TokenPlan 套餐详情。
返回套餐基本信息及额度中心主额度包余量。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTokenPlan。 |
| Version | 是 | String | 公共参数,本接口取值:2026-03-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TeamId | 是 | String | 套餐 ID。可通过 DescribeTokenPlanList 接口获取。 示例值:tp-ent-abcdefgh |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TeamId | String | 套餐 ID。 示例值:tp-ent-abcdefgh |
| Name | String | 套餐名称。 示例值:生产环境套餐 |
| AppId | String | 主账号 APP ID。 示例值:1300000001 |
| Uin | String | 主账号 UIN。 示例值:100000000001 |
| Status | String | 状态。取值:enable(启用)、disable(停用)。 示例值:enable |
| StopReason | String | 关停原因。取值:取值:NORMAL(套餐正常)、ISOLATED(隔离/欠费)、FROZEN(冻结)、EXHAUSTED(额度耗尽)、DESTROYED(已销毁)。 示例值:none |
| ApiKeyMax | Integer | 可创建APIKey 上限。 示例值:1000 |
| PrepayResourceID | String | 云计费预付费资源包 ID。 示例值:pre-abc12345 |
| Creator | String | 创建人,子账号创建的套餐将展示子账号UIN。 示例值:100000000002 |
| CreatedAt | Timestamp ISO8601 | 创建时间。 示例值:2026-04-01T00:00:00Z |
| UpdatedAt | Timestamp ISO8601 | 更新时间。 示例值:2026-04-01T00:00:00Z |
| PackageInfo | TokenPlanPackageInfo | 套餐包基本信息 |
| AutoRenewFlag | Integer | 自动续费标识。取值:0(手动续费)、1(自动续费)、2(明确不自动续费)。未绑定预付费资源时不返回。 示例值:1 |
| ApiKeyCount | Integer | 当前已创建的 API Key 数量 示例值:5 |
| TokenSummary | TokenSummary | 当前周期 Token 用量明细 |
| ProductType | String | 套餐类型。取值:enterprise(企业版专业套餐)、enterprise-auto(企业版轻享套餐) 示例值:enterprise |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeTokenPlan
测试查询 TokenPlan 套餐详情
输入示例
POST / HTTP/1.1
Host: tokenhub.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTokenPlan
<公共请求参数>
{
"TeamId": "team-1a2b3c4d"
}
输出示例
{
"Response": {
"ApiKeyCount": 10,
"ApiKeyMax": 10000,
"AppId": "12438230",
"AutoRenewFlag": 0,
"CreatedAt": "2026-04-05T21:06:09+08:00",
"Creator": "12438230",
"Name": "my-test-team",
"PrepayResourceID": "",
"RequestId": "45b1f117-4a30-4d5f-a73c-6966d50ab010",
"Status": "enable",
"StopReason": "",
"TeamId": "team-1a2b3c4d",
"Uin": "21239852",
"UpdatedAt": "2026-04-07T23:26:01+08:00"
}
}
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 | InternalError.InternalError |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| MissingParameter.MissingParameter | MissingParameter.MissingParameter |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |