API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 凭据管理系统 > 数据安全相关接口 > 获取凭据详细信息

获取凭据详细信息

最近更新时间：2024-03-12 01:48:24

我的收藏

本页目录：

1. 接口描述

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

获取凭据的详细属性信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSecret。
Version 是 String 公共参数，本接口取值：2019-09-23。
Region 是 String 公共参数，详见产品支持的 地域列表。
SecretName 是 String 指定需要获取凭据详细信息的凭据名称。
示例值：test

3. 输出参数

参数名称 类型 描述
SecretName String 凭据名称。
示例值：test
Description String 凭据描述信息。
示例值：description
KmsKeyId String 用于加密的KMS CMK ID。
示例值：13437ab9-e002-11e9-9936-5254006d0810
CreateUin Integer 创建者UIN。
示例值：3350000000
Status String 凭据状态：Enabled、Disabled、PendingDelete, Creating, Failed。
示例值：Disabled
DeleteTime Integer 删除日期，uinx 时间戳，非计划删除状态的凭据为0。
示例值：1
CreateTime Integer 创建日期。
示例值：1574160561
SecretType Integer 0 -- 用户自定义凭据类型；1 -- 数据库凭据类型；2 -- SSH密钥对凭据类型；3 -- 云API密钥（AKSK）凭据类型（使用此功能需要联系云助手单独开启白名单）；4 -- Redis类型凭据。
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ProductName String 云产品名称。
注意：此字段可能返回 null，表示取不到有效值。
示例值：Mysql
ResourceID String 云产品实例ID。
注意：此字段可能返回 null，表示取不到有效值。
示例值：cdb-xxxxxxx
RotationStatus Boolean 是否开启轮转：True -- 开启轮转；False -- 关闭轮转。
注意：此字段可能返回 null，表示取不到有效值。
示例值：True
RotationFrequency Integer 轮转周期，默认以天为单位。
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ResourceName String 当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对凭据的名称。
注意：此字段可能返回 null，表示取不到有效值。
ProjectID Integer 当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对所属的项目ID。
注意：此字段可能返回 null，表示取不到有效值。
AssociatedInstanceIDs Array of String 当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对所关联的CVM实例ID。
注意：此字段可能返回 null，表示取不到有效值。
TargetUin Integer 当凭据类型为云API密钥对凭据时，此字段有效，用于表示此云API密钥对所属的用户UIN。
注意：此字段可能返回 null，表示取不到有效值。
示例值：12345
AdditionalConfig String 凭据额外配置
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取凭据详情信息

获取凭据详情信息

输入示例

https://ssm.tencentcloudapi.com/?Action=DescribeSecret
&SecretName=test
&<公共请求参数>

输出示例

{
    "Response": {
        "Status": "Enabled",
        "Description": "hello",
        "CreateUin": 1,
        "ResourceID": "inst-1",
        "ProductName": "redis",
        "RotationStatus": true,
        "KmsKeyId": "abc-ddd",
        "RequestId": "abc-hhm",
        "SecretType": 0,
        "SecretName": "secret-a",
        "RotationFrequency": 1,
        "DeleteTime": 1,
        "CreateTime": 1,
        "ResourceName": "db-user1",
        "ProjectID": 1,
        "AssociatedInstanceIDs": [
            "inst-1"
        ],
        "TargetUin": 12345,
        "AdditionalConfig": "{}"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
OperationDenied.RoleNotExist 角色不存在。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.NotPurchased 服务未购买。
UnauthorizedOperation 未授权操作。
中国站