查询 Token Plan 套餐的 API Key 列表

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

我的收藏

1. 接口描述

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

查询 TokenPlan APIKey 列表。

返回指定套餐下的 APIKey 列表,密钥已脱敏。主账号可查看全部,子账号仅可查看自己创建的。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTokenPlanApiKeyList。
Version String 公共参数,本接口取值:2026-03-22。
Region String 公共参数,详见产品支持的 地域列表
TeamId String 套餐 ID。可通过DescribeTokenPlanList接口获取。
示例值:tp-ent-abcdefgh
Offset Integer 分页查询偏移量,默认为 0。
示例值:0
Limit Integer 分页查询返回数量,默认为 20,最大值为 100。
示例值:20
Filters.N Array of RequestFilter 分页查询过滤条件列表。支持的过滤字段:ApiKeyId (API Key ID)、Name (API Key 名称)、Status (API Key是否可用)、StopReason (API Key停用原因)、UseStatus (API Key用户侧开关)。
Sorts.N Array of RequestSort 分页查询排序条件列表。支持的排序字段:CreatedAt(创建时间)、UpdatedAt(更新时间)。默认按 CreatedAt 降序。

3. 输出参数

参数名称 类型 描述
ApiKeySet Array of TokenPlanApiKeyListItem API Key 列表。
TotalCount Integer API Key总数量。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeTokenPlanApiKeyList

输入示例

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

{
    "TeamId": "team-3a834f2dbcf48840115cbf4b48f25342",
    "Offset": 1,
    "Limit": 1
}

输出示例

{
    "Response": {
        "ApiKeySet": [
            {
                "AllowedModels": "[\"glm-5\"]",
                "ApiKey": "sk-tp-****lQw0",
                "ApiKeyId": "ak-tp-20260407-cd2b616ac0ce4d89ffc0f8be03220606",
                "AppId": "1300056794",
                "CreatedAt": "2026-05-25T15:04:10+08:00",
                "Creator": "600000563014",
                "KeyVersion": 1,
                "Name": "syytest1111",
                "Status": "enable",
                "StopReason": "",
                "TeamId": "team-3a834f2dbcf48840115cbf4b48f25342",
                "Uin": "600000563014",
                "UpdatedAt": "2026-05-25T15:04:26+08:00",
                "UseStatus": "enable"
            }
        ],
        "RequestId": "c2e09e22-f9eb-4881-b1a2-7f9f170381d3",
        "TotalCount": 47
    }
}

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
MissingParameter.MissingParameter MissingParameter.MissingParameter
UnauthorizedOperation.UnauthorizedOperation UnauthorizedOperation.UnauthorizedOperation