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

请求消息定义

message GetSecretValueRequest {
  string SecretName = 1;
  string VersionStage = 2;
  string VersionId = 3;
  bool FetchExtendedConfig = 4;
}

请求参数

名称类型是否必选示例值描述
SecretNamestring是secret001凭据名称。
VersionStageString否ACSCurrent版本状态。如果指定该参数，则凭据管家返回被标记为指定状态的版本的凭据值。

默认值：ACSCurrent。

说明 如果同时输入VersionStage和VersionId，系统会校验是否存在VersionStage和VersionId都对应的凭据值，存在则返回对应的凭据值，否则返回参数错误。
VersionIdString否00000000000000000000000000000001版本号。如果指定该参数，则凭据管家返回指定版本号的凭据值。
说明 如果同时输入VersionStage和VersionId，系统会校验是否存在VersionStage和VersionId都对应的凭据值，存在则返回对应的凭据值，否则返回参数错误。
FetchExtendedConfigBoolean否false是否获取凭据的拓展配置。
  • true（默认值）：是
  • false：否

响应消息定义

message GetSecretValueResponse {
  string SecretName = 1;
  string SecretType = 2;
  string SecretData = 3;
  string SecretDataType = 4;
  repeated string VersionStages = 5;
  string VersionId = 6;
  string CreateTime = 7;
  string RequestId = 8;
  string LastRotationDate = 9;
  string NextRotationDate = 10;
  string ExtendedConfig = 11;
  string AutomaticRotation = 12;
  string RotationInterval = 13;
}

响应数据

名称类型示例值描述
SecretNameStringsecret001凭据名称。
SecretTypeStringGeneric凭据类型。取值：

Generic：普通凭据。

SecretDataStringtestdata1凭据值。凭据管家将存储的密文凭据值进行解密后返回该参数。
SecretDataTypeStringbinary凭据值类型。取值：
  • text：文本
  • binary：二进制
VersionIdString00000000000000000000000000000001凭据版本的标识符。
VersionStagesList[ "ACSCurrent" ]凭据版本的状态标记。
CreateTimeString2020-02-21T15:39:26Z创建凭据的时间。
RequestIdString6a3e9c36-1150-4881-84d3-eb8672fcafad本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
LastRotationDateString2020-07-05T08:22:03Z最近一次轮转的时间。
NextRotationDateString2020-07-06T18:22:03Z下一次轮转的时间。
ExtendedConfigString{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }凭据的拓展配置。
AutomaticRotationStringEnabled是否开启自动轮转。取值：
  • Enabled：开启自动轮转。
  • Disabled：不开启自动轮转。
  • Invalid：轮转状态异常，凭据管家无法为您自动轮转。
RotationIntervalString604800s凭据自动轮转的周期。格式为integer[unit]。
  • integer：表示时间长度。
  • [unit]：表示时间单位，取值：s（秒）。
例如：7天的轮转周期为604800s。

错误码

关于错误码的更多信息，请参见公共错误码。