查询 Token Plan 套餐的 API Key 详情

最近更新时间:2026-05-29 10:58:21

我的收藏

1. 接口描述

接口请求域名: tokenhub.tencentcloudapi.com 。

查询 TokenPlan APIKey 详情。

返回 APIKey 完整信息(含明文密钥)及子额度包余量。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTokenPlanApiKey。
Version String 公共参数,本接口取值:2026-03-22。
Region String 公共参数,详见产品支持的 地域列表
ApiKeyId String API Key ID。可通过DescribeTokenPlanApiKeyList接口获取。
示例值:ak-tp-20260401-a1b2c3d4

3. 输出参数

参数名称 类型 描述
ApiKey TokenPlanApiKeyInfo API Key 详情信息。
Balance SubPackageBalance API Key 额度及用量信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeTokenPlanApiKey

输入示例

POST / HTTP/1.1
Host: tokenhub.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTokenPlanApiKey
<公共请求参数>

{
    "ApiKeyId": "ak-tp-20260412-72dddac0126f0eadf4670f6ce63b3db1"
}

输出示例

{
    "Response": {
        "ApiKey": {
            "AllowedModels": "[\"glm-5\", \"auto\"]",
            "ApiKey": "sk-tp-****L8py",
            "ApiKeyId": "ak-tp-20260412-72dddac0126f0eadf4670f6ce63b3db1",
            "AppId": "1300056794",
            "CreatedAt": "2026-04-12T20:10:47+08:00",
            "Creator": "600000563014",
            "KeyVersion": 1,
            "Name": "my-test-apikey",
            "Status": "enable",
            "StopReason": "NORMAL",
            "TPM": 0,
            "TeamId": "team-3a834f2dbcf48840115cbf4b48f25342",
            "Uin": "600000563014",
            "UpdatedAt": "2026-04-12T20:10:47+08:00",
            "UseStatus": "enable"
        },
        "RequestId": "b51cda8e-5153-4855-bc34-a2910ec682f9"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.InternalError InternalError.InternalError
InvalidParameter.InvalidParameter InvalidParameter.InvalidParameter
InvalidParameterValue.InvalidParameterValue InvalidParameterValue.InvalidParameterValue
MissingParameter.MissingParameter MissingParameter.MissingParameter
ResourceNotFound 资源不存在。
UnauthorizedOperation.UnauthorizedOperation UnauthorizedOperation.UnauthorizedOperation