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

更新 API 密钥信息

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

我的收藏

1. 接口描述

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

更新 API 密钥信息。

更新 API 密钥的备注信息、 IP 白名单和 Token 限额(修改限额推荐使用QuotaDesired参数)。所有可选参数不传表示不修改。

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

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

2. 输入参数

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

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

API 密钥 ID。


示例值:ak-20260624-39f1918de39ec5a7abc48f7a99c4e1a3
Platform String

平台类型。取值:maas。


示例值:maas
ApiKeyName String

API 密钥名称。最大 128 字符。不传表示不修改。


示例值:apikey-new-name
Remark String

备注。


示例值:remark
IpWhitelist.N Array of String

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


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

【修改限额推荐使用QuotaDesired参数】Token 限额期望状态。可选,不传表示不修改,传入空数组表示清空。和 Quotas(Token限额配置)字段互斥,不支持同时传入

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ModifyApiKeyInfo 更新 API 密钥备注信息

更新 API 密钥备注信息为“test-new-remark”

输入示例

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

{
    "ApiKeyId": "ak-20260320-a1b2c3d4",
    "Platform": "maas",
    "Remark": "test-new-remark"
}

输出示例

{
    "Response": {
        "RequestId": "abcdaaab-2aa3-4e03-87fb-795cf37b2079"
    }
}

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