文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>云安全中心>密钥沙箱相关接口>查询凭证详情

查询凭证详情

最近更新时间：2026-03-31 01:32:41

我的收藏

本页目录：

1. 接口描述

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

查询凭证详情，返回凭证元数据和打码后的凭据数据。access类型返回Access数组（Key原文、Value打码），sts类型返回STS对象（System原文、SecretID和SecretKey打码）

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeKeySandboxCredential。
Version 是 String 公共参数，本接口取值：2022-11-21。
Region 否 String 公共参数，此参数为可选参数。
CredentialId 是 String 凭证ID
示例值：cred-abc12345
MemberId.N 否 Array of String 集团账号的成员id
示例值：["mem-6wfo0fzks3","mem-85fo0fzks4"]

3. 输出参数

参数名称 类型 描述
CredentialId String 凭证ID
示例值：cred-abc12345
CredentialName String 凭证名称
示例值：腾讯云-生产环境密钥
CredentialType String 凭证类型
枚举值：
access：常规密钥
sts：STS临时密钥
示例值：access
CredentialEffectScope CredentialEffectScope 生效机器范围
Access Array of AccessCredentialOutput 常规密钥凭据数据（打码后），CredentialType为access时返回
补充说明：Key为原文，Value为打码后的值（保留前3后4位，中间用***替代）
注意：此字段可能返回 null，表示取不到有效值。
STS STSCredentialOutput STS凭据数据（打码后），CredentialType为sts时返回
补充说明：System为原文，SecretID和SecretKey为打码后的值（保留前3后4位，中间用***替代）
注意：此字段可能返回 null，表示取不到有效值。
CreateTime String 创建时间
参数格式：YYYY-MM-DDTHH:mm:ssZ（ISO8601格式）
示例值：2026-01-15T08:30:00Z
UpdateTime String 更新时间
参数格式：YYYY-MM-DDTHH:mm:ssZ（ISO8601格式）
示例值：2026-03-10T14:29:03Z
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询access类型凭证详情

输入示例

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

{
    "CredentialId": "cred-abc12345"
}

输出示例

{
    "Response": {
        "CredentialId": "cred-abc12345",
        "CredentialName": "腾讯云-生产环境密钥",
        "CredentialType": "access",
        "CredentialEffectScope": {
            "Exclude": 1,
            "Instances": []
        },
        "Access": [
            {
                "Key": "SecretId",
                "Value": "AKI***abcd"
            },
            {
                "Key": "SecretKey",
                "Value": "abc***wxyz"
            }
        ],
        "CreateTime": "2026-01-15T08:30:00Z",
        "UpdateTime": "2026-03-10T14:29:03Z",
        "RequestId": "c368eae2-8739-4cc2-b4f8-8f4284a93b41"
    }
}

示例2 查询sts类型凭证详情

输入示例

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

{
    "CredentialId": "cred-sts56789"
}

输出示例

{
    "Response": {
        "CredentialId": "cred-sts56789",
        "CredentialName": "STS临时密钥-测试环境",
        "CredentialType": "sts",
        "CredentialEffectScope": {
            "Exclude": 1,
            "Instances": [
                "ins-abc12345",
                "ins-def67890"
            ]
        },
        "STS": {
            "System": "tencentCam",
            "SecretID": "AKI***efgh",
            "SecretKey": "abc***wxyz"
        },
        "CreateTime": "2026-02-20T10:00:00Z",
        "UpdateTime": "2026-03-09T10:15:00Z",
        "RequestId": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

中国站