获取凭据明文

最近更新时间: 2026-10-10 00:09:51

1. 接口描述

接口请求域名： ssm.api3.fincloud.tencent.com。

获取指定凭据名称和版本的凭据明文信息，只能获取启用状态的凭据明文。

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

接口更新时间：2019-12-26 14:20:31。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：GetSecretValue
Version	是	否	String	公共参数，本接口取值：2019-09-23
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
SecretName	是	否	String	指定凭据的名称。示例值： test_secret
VersionId	是	否	String	指定对应凭据的版本号。示例值： v1.0

3. 输出参数

参数名称	类型	描述
SecretName	String	凭据的名称。示例值： test3-secret
VersionId	String	该凭据对应的版本号。示例值： v3
SecretBinary	String	在创建凭据(CreateSecret)时，如果指定的是二进制数据，则该字段为返回结果，并且使用base64进行编码，应用方需要进行base64解码后获取原始数据。SecretBinary和SecretString只有一个不为空。示例值： 5Yet5o2udmFsdWUyCg==
SecretString	String	在创建凭据(CreateSecret)时，如果指定的是普通文本数据，则该字段为返回结果。SecretBinary和SecretString只有一个不为空。示例值：凭据value3
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameterValue	参数取值错误。
InternalError	内部错误。
UnauthorizedOperation	未授权操作。
ResourceNotFound	资源不存在。
FailedOperation.AccessKmsError	KMS操作失败。
ResourceUnavailable.ResourceDisabled	凭据被禁用。
ResourceUnavailable.ResourcePendingDeleted	凭据处于计划删除状态。
ResourceUnavailable.NotPurchased	服务未购买。

5. 示例

示例1 获取凭据明文信息

输入示例

https://ssm.api3.fincloud.tencent.com/?Action=GetSecretValue
&SecretName=test_secret
&VersionId=v1.0
&<Common Parameters>

输出示例

{
    "Response": {
        "RequestId": "b8e6b67f-3ca7-4341-b4fa-a372bdf4e11c",
        "SecretName": "test_secret",
        "VersionId": "v1.0",
        "SecretBinary": "",
        "SecretString": "test"
    }
}