查询 API 密钥详情

最近更新时间:2026-06-18 01:59:49

我的收藏

1. 接口描述

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

根据 API 密钥 ID 或密钥值查询 API 密钥详情,返回明文密钥。ApiKeyId 和 ApiKey 至少需传入其一,优先使用 ApiKeyId。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApiKey。
Version String 公共参数,本接口取值:2026-03-22。
Region String 公共参数,详见产品支持的 地域列表
Platform String 平台类型。当前支持填值:maas
示例值:maas
ApiKeyId String API 密钥 ID,与 ApiKey 至少需传入其一,优先使用 ApiKeyId。
示例值:ak-20260320-a1b2c3d4
ApiKey String API 密钥明文,与 ApiKeyId 至少需传入其一。
示例值:sk-xxx

3. 输出参数

参数名称 类型 描述
ApiKeyId String API 密钥 ID。
示例值:ak-20260320-a1b2c3d4
Name String 名称。
示例值:my-api-key
ApiKey String API 密钥值(明文)。
示例值:sk-abcdefghijklmnopqrstuvwxyz123456
Remark String 备注。
示例值:test api key
Platform String 平台类型。枚举:maas
示例值:maas
Uin String 主账号。
示例值:100000000001
SubUin String 子账号。
示例值:100000000002
Status String 状态。取值:enable(启用)、disable(禁用)。
示例值:enable
BindType String 绑定类型。取值:all(全部模型和接入点)、model_all_endpoint_custom(全部模型+自定义接入点)、model_custom_endpoint_all(自定义模型+全部接入点)、model_custom_endpoint_custom(自定义模型+自定义接入点)。
示例值:all
CreateTime String 创建时间。格式:YYYY-MM-DD HH:mm:ss。
示例值:2026-03-01 00:00:00
UpdateTime String 更新时间。格式:YYYY-MM-DD HH:mm:ss。
示例值:2026-03-01 00:00:00
AppId String 应用 ID。
示例值:1300000001
Editable Boolean 是否可编辑。true 表示可编辑,false 表示不可编辑。
示例值:true
BindingItems Array of BindingItem 绑定资源列表,区分 endpoint 和 model 类型。
IpWhitelist Array of String IP 白名单列表。支持 IPv4和 CIDR 格式。空数组表示不限制 IP。
示例值:["1.1.1.1"]
Creator String 当Platform为maas时该字段为空
示例值:张三
QuotaSet Array of QuotaInfo Token 限额多维度信息。未配置限额时不返回该字段。
QuotaStatus String Token 限额状态。空字符串表示未配置任何限额包;active 表示已配置且当前可用;inactive 表示已配置但额度耗尽
示例值:active
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeApiKey

输入示例

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

{
    "Platform": "maas",
    "ApiKeyId": "ak-20260609-f294a4aa4e2a7412780914226ad3ffd8"
}

输出示例

{
    "Response": {
        "ApiKey": "sk-7PNKNHibBH617l8ly8xTzUj5Jej359BOJMjguq2St22CVEtM",
        "ApiKeyId": "ak-20260609-f294a4aa4e2a7412780914226ad3ffd8",
        "AppId": "1300056794",
        "BindType": "all",
        "BindingItems": [],
        "CreateTime": "2026-06-09 20:55:16",
        "Creator": "",
        "Editable": true,
        "IpWhitelist": [],
        "Name": "my-api-key",
        "Platform": "maas",
        "Remark": "",
        "Status": "enable",
        "SubUin": "600000563014",
        "Uin": "600000563014",
        "UpdateTime": "2026-06-09 20:55:16",
        "RequestId": "9a5c9c84-0566-4a8c-9be9-135d834e668c"
    }
}

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