全部產品
Search
文件中心

Key Management Service:GetSecretValue

更新時間:Nov 23, 2024

調用GetSecretValue介面通過KMS執行個體網關擷取憑據值。

請求參數

名稱

類型

是否必選

樣本值

描述

SecretName

string

secret001

憑據名稱。

VersionStage

String

ACSCurrent

版本狀態。如果指定該參數,則憑據管家返回被標記為指定狀態的版本的憑據值。

預設值:ACSCurrent。

說明
  • 資料庫憑據(包含RDS憑據、PolarDB憑據和Redis憑據)、RAM憑據和ECS憑據只能擷取ACSPrevious和ACSCurrent對應版本的憑據值。

  • 如果同時輸入VersionStageVersionId,系統會校正是否存在VersionStageVersionId都對應的憑據值,存在則返回對應的憑據值,否則返回參數錯誤。

VersionId

String

00000000000000000000000000000001

版本號碼。如果指定該參數,則憑據管家返回指定版本號碼的憑據值。

說明
  • 資料庫憑據(包含RDS憑據、PolarDB憑據和Redis憑據)、RAM憑據和ECS憑據不支援指定VersionId,設定該參數將被忽略。

  • 如果同時輸入VersionStageVersionId,系統會校正是否存在VersionStageVersionId都對應的憑據值,存在則返回對應的憑據值,否則返回參數錯誤。

FetchExtendedConfig

Boolean

false

是否擷取憑據的拓展配置。

  • true(預設值):是

  • false:否

響應資料

名稱

類型

樣本值

描述

SecretName

String

secret001

憑據名稱。

SecretType

String

Generic

憑據類型。取值:

  • Generic:通用憑據。

  • Rds:RDS憑據。

  • Redis:Redis/Tair憑據。

  • RAMCredentials:RAM憑據。

  • ECS:ECS憑據。

  • PolarDB:PolarDB憑據

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.

加密憑據的密鑰為禁用狀態。

訪問公用錯誤碼查看更多錯誤碼。