有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeApiKey)用于查询密钥详情。
用户在创建密钥后,可用此接口查询一个 API 密钥的详情,该接口会显示密钥 Key。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApiKey。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
AccessKeyId String API 密钥 ID。
示例值:AKID1IGx7Tu5mk150ds6fhbdi1RqD8KlI6dW32MD

3. 输出参数

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

4. 示例

示例1 DescribeApiKey

输入示例

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

输出示例

{
    "Response": {
        "Result": {
            "AccessKeyId": "AKID1IGx7Tu5mk150ds6fhbdi1RqD8KlI6dW32MD",
            "AccessKeySecret": "hvhuan76de5im5Fa0bqh8aaBcOO9cy6c7yg2ywlf",
            "AccessKeyType": "auto",
            "SecretName": "dd",
            "Status": 1,
            "CreatedTime": "2020-02-26T06:09:44Z",
            "ModifiedTime": "2020-02-26T06:45:57Z"
        },
        "RequestId": "ac423dbe-4e28-470d-b3f7-b8c95c614124"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CamException CAM异常
ResourceNotFound.InvalidAccessKeyId 密钥不存在。