GetSecretValue

调用GetSecretValue接口通过KMS实例网关获取凭据值。

请求参数

名称

类型

是否必选

示例值

描述

SecretName

string

secret001

凭据名称。

VersionStage

String

ACSCurrent

版本状态。如果指定该参数,则凭据管家返回被标记为指定状态的版本的凭据值。

默认值:ACSCurrent。

说明
  • 数据库凭据(包含RDS凭据和Redis凭据)、RAM凭据和ECS凭据只能获取ACSPrevious和ACSCurrent对应版本的凭据值。

  • 如果同时输入VersionStageVersionId,系统会校验是否存在VersionStageVersionId都对应的凭据值,存在则返回对应的凭据值,否则返回参数错误。

VersionId

String

00000000000000000000000000000001

版本号。如果指定该参数,则凭据管家返回指定版本号的凭据值。

说明
  • 数据库凭据(包含RDS凭据和Redis凭据)、RAM凭据和ECS凭据不支持指定VersionId,设置该参数将被忽略。

  • 如果同时输入VersionStageVersionId,系统会校验是否存在VersionStageVersionId都对应的凭据值,存在则返回对应的凭据值,否则返回参数错误。

FetchExtendedConfig

Boolean

false

是否获取凭据的拓展配置。

  • true(默认值):是

  • false:否

响应数据

名称

类型

示例值

描述

SecretName

String

secret001

凭据名称。

SecretType

String

Generic

凭据类型。取值:

Generic:普通凭据。

SecretData

String

testdata1

凭据值。凭据管家将存储的密文凭据值进行解密后返回该参数。

SecretDataType

String

binary

凭据值类型。取值:

  • text:文本

  • binary:二进制

VersionId

String

00000000000000000000000000000001

凭据版本的标识符。

VersionStages

List

[ "ACSCurrent" ]

凭据版本的状态标记。

CreateTime

String

2020-02-21T15:39:26Z

创建凭据的时间。

RequestId

String

6a3e9c36-1150-4881-84d3-eb8672fcafad

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

LastRotationDate

String

2020-07-05T08:22:03Z

最近一次轮转的时间。

NextRotationDate

String

2020-07-06T18:22:03Z

下一次轮转的时间。

ExtendedConfig

String

{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }

凭据的拓展配置。

AutomaticRotation

String

Enabled

是否开启自动轮转。取值:

  • Enabled:开启自动轮转。

  • Disabled:不开启自动轮转。

  • Invalid:轮转状态异常,凭据管家无法为您自动轮转。

RotationInterval

String

604800s

凭据自动轮转的周期。格式为integer[unit]

  • integer:表示时间长度。

  • [unit]:表示时间单位,取值:s(秒)。

例如:7天的轮转周期为604800s。

错误码

HTTP状态码

错误码

错误消息

描述

404

Forbidden.ResourceNotFound

The resource does not exist in the system.

凭据不存在。

409

Rejected.Disabled

The request was rejected because the key state is Disabled.

加密凭据的密钥为禁用状态。

访问公共错误码查看更多错误码。