云开发 CloudBase 查询云开发平台的API Key列表

1. 接口描述

接口请求域名： tcb.tencentcloudapi.com 。

查询 API Key 列表。分页查询指定云开发环境下的 API Key 访问凭证列表。支持按类型过滤（api_key 或 publish_key）。未指定类型时，默认仅返回 api_key 类型的记录。列表查询中 api_key 类型的令牌值将进行脱敏处理（仅保留前后各 6 位字符）；publish_key 类型始终返回完整明文。接口需要管理员权限。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeApiKeyList。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	是	String	公共参数，详见产品支持的地域列表。
EnvId	是	String	环境 ID，用于标识该密钥归属的云开发环境，不同环境之间的数据相互隔离示例值：env-123
PageNumber	否	Integer	分页查询的页码，从 1 开始。与 PageSize 配合使用，不传则默认返回第 1 页示例值：1
PageSize	否	Integer	分页查询每页返回的记录条数。与 PageNumber 配合使用，不传则使用系统默认值示例值：10
KeyType	否	String	密钥类型过滤条件。可选值：api_key（服务端调用使用的 API 密钥，具有完整权限）、publish_key（客户端使用的公开密钥，权限受限）密钥类型过滤条件。不传默认值为api_key 示例值：api_key

3. 输出参数

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

4. 示例

示例1 查询API Key列表

输入示例

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

{
    "EnvId": "env-123",
    "PageNumber": 1,
    "PageSize": 10,
    "KeyType": "api_key"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "ApiKey": "agKSFS******jKdhas",
                "CreateAt": "2026-02-19T14:25:17+08:00",
                "ExpireAt": "2026-03-19T14:25:17+08:00",
                "KeyId": "akdj3jsk3112ks",
                "Name": "example_key"
            }
        ],
        "Total": 1,
        "RequestId": "13ef3988-16d7-48b5-91b8-505e35ea51b3"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
UnauthorizedOperation	未授权操作。

查询云开发平台的API Key列表

本页目录：