GetSecretValue_密钥管理服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

如果不指定版本号或版本状态,则 KMS 默认返回被标记为 ACSCurrent 的版本凭据值。 如果凭据使用了用户指定的密钥来保护凭据值,则需要调用者同时具备相应主密钥的kms:Decrypt权限。

本文将提供一个示例,获取一个名为secret001凭据的凭据值,返回结果显示凭据值SecretDatatestdata1

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
SecretNamestring

凭据名称或凭据资源名称(ARN)。展开详情

示例值:secret001参考取值来源:
    RotateSecret
    CreateSecret
    UpdateSecret
    PutSecretValue
    RestoreSecret
    ListSecrets
VersionStagestring

版本状态。默认值:ACSCurrent。展开详情

示例值:ACSCurrent参考取值来源:
    ListSecretVersionIds
VersionIdstring

版本号。展开详情

示例值:v1参考取值来源:
    ListSecretVersionIds
    CreateKeyVersion
FetchExtendedConfigboolean

是否获取凭据的拓展配置。取值:展开详情

示例值:true
DryRunstring

是否开启 DryRun 模式。展开详情

示例值:false

请求说明

关于公共请求参数的详情,请参见公共参数

返回参数

字段名称字段详情
SecretDataTypestring

凭据值类型。取值:展开详情

示例值:binary
CreateTimestring

创建凭据的时间。

示例值:2024-02-21T15:39:26Z
VersionIdstring

凭据的版本号。

示例值:v1
NextRotationDatestring

下一次轮转的时间。 展开详情

示例值:2024-07-06T18:22:03Z
SecretDatastring

凭据值。KMS 将存储的密文凭据值进行解密后返回该参数。 展开详情

示例值:testdata1
RotationIntervalstring

凭据自动轮转的周期。 展开详情

示例值:604800s
ExtendedConfigstring

凭据的拓展配置。 展开详情

示例值:{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDatestring

最近一次轮转的时间。 展开详情

示例值:2023-07-05T08:22:03Z
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例值:6a3e9c36-1150-4881-84d3-eb8672fcafad
SecretNamestring

凭据名称。

示例值:secret001
AutomaticRotationstring

是否开启了自动轮转。取值:展开详情

示例值:Enabled
SecretTypestring

凭据类型。取值:展开详情

示例值:Generic
VersionStagesobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
Forbidden.DKMSInstanceStateInvalid
The DKMS instance state is invalid.诊断
403
Forbidden.DKMSInstanceNotFound
The specified DKMS Instance is not found.诊断
404
Forbidden.KeyNotFound
The specified Key is not found.诊断
404
Forbidden.ResourceNotFound
Resource not found.诊断

变更历史

变更时间变更内容概要操作
2024-08-13
新增请求参数DryRun
2023-10-23
变更错误码403
变更错误码404
删除错误码400
删除错误码409
删除错误码500
2022-09-22
变更错误码404

相关示例

通过调用 GetSecretValue 接口获取凭据值示例
2022-06-17