查询 API 密钥列表

最近更新时间:2026-06-01 02:59:51

我的收藏

1. 接口描述

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

查询 API 密钥列表。

查询当前用户的 API 密钥列表,密钥值脱敏展示。支持分页、过滤和排序。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApiKeyList。
Version String 公共参数,本接口取值:2026-03-22。
Region String 公共参数,详见产品支持的 地域列表
Platform String 平台类型。当前支持填值:maas
示例值:maas
Limit Integer 返回数量,默认为 20,最大值为 100。
示例值:20
Offset Integer 偏移量,默认为 0。
示例值:0
Filters.N Array of RequestFilter 过滤条件列表。支持的过滤字段:apikeyId(API 密钥 ID)、apiKeyName(名称)、platform(平台类型)、status(状态)、bindType(绑定类型)。
Sorts.N Array of RequestSort 排序条件列表。支持的排序字段:apiKeyName

3. 输出参数

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

4. 示例

示例1 查询 API 密钥列表。

查询当前用户的 API 密钥列表,密钥值脱敏展示。支持分页、过滤和排序。

输入示例

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

{
    "Platform": "maas",
    "Filters": [
        {
            "Name": "apiKeyName",
            "Op": "EXACT",
            "Values": [
                "my-apikey"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "ApiKeySet": [
            {
                "ApiKey": "sk-2b***3sQc",
                "ApiKeyId": "ak-20260325-xxxxxx",
                "AppId": "1300056794",
                "BindType": "model_custom_endpoint_custom",
                "BindingItems": [
                    {
                        "ResourceId": "deepseek-v3.2",
                        "ResourceType": "model"
                    }
                ],
                "CreateTime": "2026-03-25 19:50:56",
                "Creator": "",
                "Editable": true,
                "Name": "my-apikey",
                "Platform": "maas",
                "Remark": "for test use",
                "Status": "enable",
                "SubUin": "1234556",
                "Uin": "1234556",
                "UpdateTime": "2026-03-25 19:50:56"
            }
        ],
        "RequestId": "3ec32d91-3e21-40bf-8874-516fa9197d5b",
        "TotalCount": 1
    }
}

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