帮你快速理解、总结文档立即下载

创建 API 密钥

最近更新时间:2026-07-13 03:01:00

我的收藏

1. 接口描述

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

创建 API 密钥。

创建一个新的 API 密钥,创建成功后返回 API 密钥 ID。需指定平台类型、绑定方式和初始状态。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateApiKey。
Version String 公共参数,本接口取值:2026-03-22。
Region String 公共参数,详见产品支持的 地域列表
ApiKeyName String

API 密钥名称,创建后不可修改。


示例值:my-api-key
Platform String

平台类型。取值:maas


示例值:maas
BindType String

绑定类型。取值:all(全部模型和接入点)、model_custom_endpoint_custom(自定义模型+自定义接入点)。

枚举值:

  • all: 全部模型和接入点
  • model_custom_endpoint_custom: 自定义模型+自定义接入点

示例值:all
Remark String

备注信息


示例值:remark
Status String

初始状态。取值:enable(启用)、disable(禁用)。不传默认 enable。


示例值:enable
Bindings.N Array of BindingItem

资源绑定列表(model 和 endpoint 混合),每项需显式指定 ResourceType。BindType 为 all 时不填;BindType 为model_custom_endpoint_custom时必填。

IpWhitelist.N Array of String

IP 白名单列表。支持 IPv4(如 1.2.3.4)和 CIDR(如 10.0.0.0/24)格式,IPv6暂不支持。最多 50 个条目,不支持重复。不传或传空数组表示不限制 IP。


示例值:["1.2.3.4"]
Quotas.N Array of QuotaCreateItem

Token 限额配置多维度列表。可选,不传表示不开启限额。

3. 输出参数

参数名称 类型 描述
ApiKeyId String

apikey id


示例值:ak-20260624-39f1918de39ec5a7abc48f7a99c4e1a3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateApiKey

输入示例

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

{
    "ApiKeyName": "my-api-key",
    "Platform": "maas",
    "BindType": "all",
    "Quotas": [
        {
            "CycleUnit": "d",
            "CycleCredits": "1000"
        }
    ]
}

输出示例

{
    "Response": {
        "ApiKeyId": "ak-20260609-f294a4aa4e2a7412780914226ad3ffd8",
        "RequestId": "c7fdc4d0-04d5-4c76-a55e-b8528047a782"
    }
}

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
LimitExceeded 超过配额限制。
MissingParameter.MissingParameter MissingParameter.MissingParameter
UnauthorizedOperation.UnauthorizedOperation UnauthorizedOperation.UnauthorizedOperation