Key Management Service:GetSecretValue

パラメーター

型

必須 / 任意

例

説明

SecretName

String

対象

secret001

秘密の名前。

VersionStage

String

任意

ACSCurrent

シークレットバージョンをマークするステージラベル。 このパラメーターを指定すると、KMSは指定されたステージラベルでマークされたバージョンのシークレット値を返します。

デフォルト値: ACSCurrent。

VersionId

String

任意

00000000000000000000000000000001

バージョンID。 このパラメーターを設定すると、KMSは指定されたバージョンのシークレット値を返します。

FetchExtendedConfig

Boolean

非対象

false

シークレットの拡張構成を取得するかどうかを指定します。

• true (デフォルト): はい

• false

パラメーター

タイプ

例

説明

SecretName

String

secret001

秘密の名前。

SecretType

String

ジェネリック

シークレットのタイプ。 有効な値：

Generic: ジェネリックシークレットを示します。

SecretData

String

testdata1

秘密の値。The secret value. KMSは、シークレット値の暗号文を復号化し、このパラメーターのシークレット値のプレーンテキストを返します。

SecretDataType

String

binary

シークレット値の型。 有効な値：

• text

• binary

VersionId

String

00000000000000000000000000000001

シークレット値のバージョン番号。

VersionStages

List

["ACSCurrent"]

シークレットバージョンをマークするステージラベル。

CreateTime

String

20-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: 自動ローテーションが無効であることを示します。

• 無効: 自動ローテーションのステータスが異常であることを示します。 この場合、KMSはシークレットを自動的にローテーションできません。

RotationInterval

String

604800s

自動回転の間隔。 値はinteger[unit] 形式でなければなりません。

• integer: 時間の長さを示します。

• [unit]: 時間の単位を示します。 有効値: s (秒) 。

たとえば、ローテーション期間が7日の場合、このパラメーターは604800秒に設定されます。

HTTPステータスコード

エラーコード

エラーメッセージ

説明

404

Forbidden.ResourceNotFound

リソースがシステムに存在しません。

秘密は存在しません。

409

Rejected.Disabled

キーの状態が無効であるため、リクエストが拒否されました。

シークレットの暗号化に使用されるキーは無効です。