查询AI网关密钥详情

1. 接口描述

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

查询密钥详情（SecretValue 字段会被掩码）。
普通版批量新建密钥的生成来源扩展：新页面按需 IncludeCreationInfo=true，省略/false 保持原响应字段。原 GenerateType 不新增 Batch；批量记录仍为 System。协议：https://iwiki.woa.com/p/4042678235。
【消费者批量自动分配 API Key｜修改：可选参数及可选出参】增加可选 IncludeCreationInfo（默认 false）。仅 true 且 ResourceType=Consumer 时在原 Result 增加 CredentialGenerateType、CreationSource、BatchId 三个非必返字段；省略/false 保持旧响应。原字段、SecretValue 脱敏和单条详情结构不变。 完整接口清单与逐项说明：https://iwiki.woa.com/p/4042678235（第 2、2.4 节）。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询密钥详情

输入示例

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

{
    "GatewayId": "gateway-xxx",
    "SecretKeyId": "secret-xxx"
}

输出示例

{
    "Response": {
        "RequestId": "8edcd3b9-68fd-42a9-bba3-d38e17ee4777",
        "Result": {
            "BindCount": 0,
            "CreateTime": "2025-11-19 10:39:44",
            "Description": "密钥描述",
            "GenerateType": "System",
            "KmsKeyName": "",
            "KmsKeyVersion": "",
            "ModifyTime": "2025-11-19 16:04:39",
            "Name": "密钥11",
            "ResourceType": "Consumer",
            "SecretKeyId": "secret-xxxx",
            "SecretType": "ApiKey",
            "SecretValue": "sk-****ptz",
            "Status": "Enable"
        }
    }
}

示例2 查询密钥详情并返回创建来源信息

示例仅展示相关字段；实际返回保留原有字段。省略 IncludeCreationInfo 或传 false 时不增加三个创建来源字段。示例 ID 不是实际资源。

输入示例

POST / HTTP/1.1
Host: cngw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudNativeAPIGatewaySecretKey
X-TC-Version: 2023-04-18
X-TC-Region: ap-guangzhou
<其他公共请求参数与 TC3 签名>

{
    "GatewayId": "gateway-example",
    "SecretKeyId": "secret-example",
    "IncludeCreationInfo": true
}

输出示例

{
    "Response": {
        "Result": {
            "SecretKeyId": "secret-example",
            "Name": "auto-team-a1B2",
            "ResourceType": "Consumer",
            "SecretType": "ApiKey",
            "GenerateType": "System",
            "Status": "Enable",
            "SecretValue": "sk-****123",
            "CreateTime": "2026-09-28 16:00:00",
            "ModifyTime": "2026-09-28 16:00:00",
            "CredentialGenerateType": "System",
            "CreationSource": "Batch",
            "BatchId": "keybatch-example"
        },
        "RequestId": "req-example"
    }
}

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. 错误码

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