API 网关 密钥相关接口

一、1. 接口描述

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

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

二、2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UpdateApiKey。
Version	是	String	公共参数，本接口取值：2018-08-08。
Region	是	String	公共参数，详见产品支持的地域列表。
AccessKeyId	是	String	待更换的密钥 ID。示例值：AKID***********************************************
AccessKeySecret	否	String	待更换的密钥 Key，更新自定义密钥时，该字段为必传。长度10 – 50字符，包括字母、数字、英文下划线。

三、3. 输出参数

参数名称	类型	描述
Result	ApiKey	更换后的密钥详情。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、输入示例

https://apigateway.tencentcloudapi.com/?Action=UpdateApiKey
&AccessKeyId=AKID***********************************************
&<公共请求参数>

五、输出示例

{
"Response": {
"Result": {
"AccessKeyId": "AKID***********************************************",
"AccessKeySecret": "qYSyjR************************************",
"AccessKeyType": "auto",
"SecretName": "dd",
"Status": 1,
"CreatedTime": "2020-02-26T06:09:44Z",
"ModifiedTime": "2020-02-26T06:45:57Z"
},
"RequestId": "3d0d6dc0-1fa9-4634-9c42-a1ff635c0bd5"
}
}

六、腾讯云 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. 错误码

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

错误码	描述
InternalError.OssException	oss内部请求错误，请稍后重试。若无法解决，请联系智能客服或提交工单。
InvalidParameter.FormatError	参数格式错误。
ResourceNotFound.InvalidAccessKeyId	密钥不存在。
UnsupportedOperation.UinNotInWhiteList	当前Uin未在手工密钥白名单列表内。