秘密の値を取得します。

バージョン番号またはステージラベルを指定しない場合、Secrets ManagerはACSCurrentでマークされたバージョンのシークレット値を返します。

シークレット値を暗号化するために顧客マスターキー (CMK) が指定されている場合、GetSecretValue操作を呼び出すには、CMKに対するkms:Decrypt権限も必要です。

この例では、secret001という名前のシークレットの値が取得されます。 シークレット値はSecretDataパラメーターで返されます。 シークレット値はtestdata1です。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 GetSecretValue

実行する操作です。 値をGetSecretValueに設定します。

SecretName String 必須 secret001

秘密の名前。The name of the secret.

VersionStage String 任意 ACSCurrent

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

デフォルト値: ACSCurrent。

注 マネージドApsaraDB RDSシークレット、マネージドRAMシークレット、またはマネージドECSシークレットの場合、Secrets Managerは、ACSPreviousまたはACSCurrentでマークされたバージョンのシークレット値のみを返すことができます。
VersionId String 任意 00000000000000000000000000000001

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

注 このパラメーターは、マネージドApsaraDB RDSシークレット、マネージドRAMシークレット、またはマネージドECSシークレットでは無視されます。
FetchExtendedConfig Boolean 任意 true

シークレットの拡張構成を取得するかどうかを指定します。 設定可能な値は以下のとおりです。

  • true
  • false: これはデフォルト値です。
注 このパラメーターは、ジェネリックシークレットでは無視されます。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター データ型 例 説明
AutomaticRotation String 提供済み

Indicates whether automatic rotation is enabled. 設定可能な値は以下のとおりです。

  • Enabled: indicates that automatic rotation is enabled.
  • Disabled: 自動ローテーションが無効であることを示します。
  • 無効: 自動ローテーションのステータスが異常であることを示します。 この場合、Secrets Managerはシークレットを自動的に回転できません。
注 このパラメーターは、マネージドApsaraDB RDSシークレット、マネージドRAMシークレット、またはマネージドECSシークレットに対してのみ返されます。
CreateTime String 20-02-21T15:39:26Z

シークレットが作成された時刻。

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

シークレットの拡張設定。

注 FetchExtendedConfigパラメーターをtrueに設定した場合、このパラメーターが返されます。 このパラメーターは、マネージドApsaraDB RDSシークレット、マネージドRAMシークレット、またはマネージドECSシークレットに対してのみ返されます。
LastRotationDate String 2020-07-05T08:22:03Z

最後のローテーションが実行された時刻。

注 このパラメーターは、シークレットがローテーションされた場合に返されます。
NextRotationDate String 2020-07-06T18:22:03Z

The time when the next rotation will be performed.

注 自動回転が有効になっている場合、このパラメーターが返されます。
RequestId String 6a3e9c36-1150-4881-84d3-eb8672fcafad

リクエストの ID です。

RotationInterval String 604800s

The interval for automatic rotation.

値はinteger[unit] 形式です。 unitフィールドは、sの固定値を有する。 たとえば、値が604800秒の場合、7日間隔で自動ローテーションが実行されます。

注 自動回転が有効になっている場合、このパラメーターが返されます。
SecretData String testdata1

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

  • ジェネリックシークレットの場合、指定されたバージョンのシークレット値が返されます。
  • マネージApsaraDB RDSシークレットの場合、値は {"AccountName":"","AccountPassword":"" "} の形式で返されます。
  • マネージRAMシークレットの場合、シークレット値は次の形式で返されます。{"AccessKeyId": "Adfdsfd","AccessKeySecret": "fdsfdsf","GenerateTimestamp": "2016-03-25T10:42:40Z"} 。
  • マネージECSシークレットの場合、シークレット値は次のいずれかの形式で返されます。
    • {"UserName":"root","Password":"H5asdasdsads ****"}: ECSシークレットがパスワードの場合、シークレット値がこの形式で返されます。
    • {"UserName": "root","PublicKey": "ssh-rsa **** mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21 ****"}: この形式で返される秘密の値は、ECSシークレットはSSHキーのペアです。 秘密鍵は、プライバシー強化メール (PEM) 形式である。
SecretDataType String binary

シークレット値の型。 設定可能な値は以下のとおりです。

  • text
  • binary
SecretName String secret001

秘密の名前。The name of the secret.

SecretType String ジェネリック

シークレットのタイプ。 設定可能な値は以下のとおりです。

  • Generic: ジェネリックシークレットを示します。
  • Rds: 管理対象のApsaraDB RDSシークレットを示します。
  • RAMCredentials: マネージRAMシークレットを示します。
  • ECS: マネージドECSシークレットを示します。
VersionId String 00000000000000000000000000000001

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

VersionStages List {"VersionStage": [ "ACSCurrent" ] }

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

例

リクエストの例

http(s):// [エンドポイント]/?Action=GetSecretValue
&SecretName=secret001
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<KMS>
      <SecretName>secret001</SecretName>
      <VersionId>00000000000000000000000000000001</VersionId>
      <SecretData>testdata1</SecretData>
      <SecretType> ジェネリック </SecretType>
      <SecretDataType> バイナリ </SecretDataType>
      <VersionStages>
            <VersionStage>ACSCurrent</VersionStage>
      </VersionStages>
      <CreateTime>2020-07-23T11:56:29Z</CreateTime>
      <RequestId>6a3e9c36-1150-4881-84d3-eb8672fcafad</RequestId>
</KMS>

JSON 形式 

{
    "SecretName": "secret001" 、
    "VersionId": "00000000000000000000000000000001" 、
    "SecretData": "testdata1" 、
    "SecretType": "Generic" 、
    "SecretDataType": "バイナリ" 、
    "VersionStages": {
        "VersionStage": [
            "ACSCurrent"
        ]
    },
    "CreateTime": "2020-07-23T11:56:29Z" 、
    "RequestId": "6a3e9c36-1150-4881-84d3-eb8672fcafad"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。