PutSecretValue
为凭据存入一个新版本的凭据值
服务地址:
华东1 金融云
输入参数
只看必填
VersionId凭据的版本号
SecretName凭据名称或凭据资源名称(ARN)
SecretData凭据值
SecretDataType凭据值类型
VersionStages凭据版本在存入时需要被同时标记的版本状态
插件下载了解更多
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.

接口说明

说明 仅通用凭据支持本接口,每个通用凭据最多保存 10 个凭据版本,超出时 KMS 会滚动删除最早的凭据版本。

默认情况下,新存入的凭据值被标记为 ACSCurrent,而 ACSCurrent 标记的前一个版本被标记为 ACSPrevious。您可以通过指定 VersionStage 参数来覆盖该默认行为。

此接口用于存入新版本的凭据值,而不能用于修改已有版本的凭据值。存入新版本时需指定版本号,KMS 按照如下规则进行操作:

  • 版本号在凭据内不存在:创建新版本并存入凭据值。
  • 版本号在凭据内存在:如果入参中的凭据值和凭据内该版本号对应的凭据值相同,则请求会被忽略,并且返回成功(请求是幂等的),不相同时则请求会被拒绝,且返回失败。

本文将提供一个示例,为凭据名称是secret001的凭据存入一个新版本的凭据值,新凭据版本号VersionIdv3、凭据值SecretDataimportantdata

请求参数

字段名称字段详情
VersionIdstring

凭据的版本号,在该凭据内唯一。

示例值:v3参考取值来源:
    ListSecretVersionIds
    CreateKeyVersion
SecretNamestring

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

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

凭据值。加密后存入指定的新版本中。

示例值:importantdata参考取值来源:
    CreateSecret
    GetSecretValue
SecretDataTypestring

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

示例值:text枚举值:textbinary参考取值来源:
    GetSecretValue
VersionStagesstring

凭据版本在存入时需要被同时标记的版本状态。如果您不指定此参数,KMS 默认为新版本标记 ACSCurrent。

示例值:["ACSCurrent","ACSNext"]参考取值来源:
    ListSecretVersionIds

请求说明

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

返回参数

字段名称字段详情
SecretNamestring

凭据名称。

示例值:secret001
VersionIdstring

凭据的版本号。

示例值:v3
RequestIdstring

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

示例值:f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8
VersionStagesobject
变更历史
暂无变更历史