凭据管理系统获取凭据详细信息-数据安全相关接口-API 中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
SecretName	String	凭据名称。示例值：lzctest
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类型凭据。示例值：1
ProductName	String	云产品名称。示例值：Mysql
ResourceID	String	云产品实例ID。示例值：cdb-n4j3y33j
RotationStatus	Boolean	是否开启轮转：True -- 开启轮转；False -- 关闭轮转。示例值：True
RotationFrequency	Integer	轮转周期，默认以天为单位。示例值：1
ResourceName	String	当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对凭据的名称。示例值：resource_name
ProjectID	Integer	当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对所属的项目ID。示例值：0
AssociatedInstanceIDs	Array of String	当凭据类型为SSH密钥对凭据时，此字段有效，用于表示SSH密钥对所关联的CVM实例ID。注意：此字段可能返回 null，表示取不到有效值。示例值：["cvm-test"]
TargetUin	Integer	当凭据类型为云API密钥对凭据时，此字段有效，用于表示此云API密钥对所属的用户UIN。示例值：700001224420
AdditionalConfig	String	凭据额外配置示例值：{"key1":"value1"}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取凭据详情信息

获取凭据详情信息

输入示例

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

输出示例

{
    "Response": {
        "AdditionalConfig": "key1",
        "AssociatedInstanceIDs": [
            "cvm-test"
        ],
        "CreateTime": 1730272571,
        "CreateUin": 700001224419,
        "DeleteTime": 0,
        "Description": "测试数据库凭据创建",
        "KmsKeyId": "6abd1fdb-86d4-11ef-b72d-52540089bc41",
        "ProductName": "Mysql",
        "ProjectID": 0,
        "RequestId": "deb31013-2d0d-4b0c-a9dd-b62d8c3b2465",
        "ResourceID": "cdb-n4j3y33j",
        "ResourceName": "testresource",
        "RotationFrequency": 30,
        "RotationStatus": true,
        "SecretName": "test3-db-secret",
        "SecretType": 1,
        "Status": "Enabled",
        "TargetUin": 0
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

获取凭据详细信息

本页目录：