GetSecretValue - Key Management Service - Alibaba Cloud ドキュメントセンター

シークレット値を取得します。

操作説明

RAM ユーザーまたは RAM ロールがこの操作を呼び出すために必要なアクセスポリシーの詳細は、アクセス制御をご参照ください。
バージョン番号またはバージョンステージを指定しない場合、KMS はデフォルトで ACSCurrent としてマークされたバージョンのシークレット値を返します。
シークレットがユーザー指定キーを使用してシークレット値を保護している場合、呼び出し元は対応するマスターキーの kms:Decrypt 権限も必要です。

このトピックでは、secret001 という名前のシークレットのシークレット値を取得する方法の例を示します。レスポンスでは、シークレット値 SecretData が testdata1 であることが示されています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SecretName	string	必須	シークレット名またはシークレットの Alibaba Cloud リソースネーム (ARN)。説明別の Alibaba Cloud アカウントのシークレットにアクセスするには、シークレット ARN を指定する必要があります。シークレット ARN の形式は `acs:kms:${region}:${account}:secret/${secret-name}` です。	secret001
VersionStage	string	任意	バージョンステージ。デフォルト値は `ACSCurrent` です。このパラメーターを指定すると、指定されたバージョンステージのシークレット値が返されます。このパラメーターを指定しない場合、`ACSCurrent` バージョンステージのシークレット値が返されます。説明 ApsaraDB RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、および ECS シークレットの場合、取得できるのは `ACSPrevious` および `ACSCurrent` バージョンのシークレット値のみです。	ACSCurrent
VersionId	string	任意	バージョン番号。説明 ApsaraDB RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、および ECS シークレットは `VersionId` の指定をサポートしていません。このパラメーターを指定しても無視されます。	v1
FetchExtendedConfig	boolean	任意	シークレットの拡張設定を取得するかどうかを指定します。有効な値： `true`：拡張設定を取得します。 `false` (デフォルト)：拡張設定を取得しません。説明汎用シークレットは拡張設定をサポートしていません。このパラメーターを指定しても無視されます。	true
DryRun	string	任意	ドライランモードを有効にするかどうかを指定します。有効な値： `true`：ドライランモードを有効にします。 `false` (デフォルト)：ドライランモードを無効にします。ドライランモードは、API 呼び出しをテストし、対応するリソースに対する必要な権限があるかどうか、およびリクエストパラメーターが正しく設定されているかどうかを検証するために使用します。ドライランモードが有効な場合、KMS は常にリクエストの失敗を返し、その理由を示します。失敗の理由には次のものがあります： `DryRunOperationError`：`DryRun` パラメーターがなければ、リクエストは成功するはずです。 `ValidationError`：リクエストで指定されたパラメーターが無効です。 `AccessDeniedError`：KMS リソースに対してこの操作を実行する権限がありません。	false

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

レスポンスフィールド

フィールド	型	説明	例
	object
SecretDataType	string	シークレット値のタイプ。有効な値：テキストバイナリ	binary
CreateTime	string	シークレットが作成された時刻。	2024-02-21T15:39:26Z
VersionId	string	シークレットのバージョン番号。	v1
NextRotationDate	string	次回ローテーションの時刻。説明このパラメーターは、自動ローテーションが有効な場合にのみ返されます。	2024-07-06T18:22:03Z
SecretData	string	シークレット値。 KMS は保存されている暗号文のシークレット値を復号し、このパラメーターを返します。汎用シークレットの場合、指定したシークレット値が返されます。 ApsaraDB RDS シークレットおよび Redis/Tair シークレットの場合、シークレット値は `{"AccountName":"","AccountPassword":""}` のフォーマットで返されます。 RAM シークレットの場合、シークレット値は `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}` のフォーマットで返されます。 ECS シークレットの場合、シークレット値は次のフォーマットで返されます：パスワードタイプのシークレット： `{"UserName":"ecs-user","Password":"H5asdasdsads**"}`。公開鍵/プライベートキーペアタイプのシークレット (PEM フォーマットのプライベートキー) ： `{"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}`。 PolarDB シークレットの場合、シークレット値は `{"AccountName":"","AccountPassword":""}` のフォーマットで返されます。	testdata1
RotationInterval	string	シークレットの自動ローテーションの間隔。フォーマットは `integer[unit]` です。 `integer` は期間、 `unit` は時間単位を指定します。 `unit` の値は s (秒) です。たとえば、ローテーション間隔が 7 日の場合は 604800 s です。説明このパラメーターは、自動ローテーションが有効な場合にのみ返されます。	604800s
ExtendedConfig	string	シークレットの拡張設定。説明このパラメーターは、FetchExtendedConfig が true に設定されている場合にのみ、 ApsaraDB RDS シークレット、 PolarDB シークレット、 Redis/Tair シークレット、 RAM シークレット、または ECS シークレットに対して返されます。	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	直近のローテーションの時刻。説明このパラメーターは、シークレットがローテーションされたことがある場合にのみ返されます。	2023-07-05T08:22:03Z
RequestId	string	リクエスト ID。 Alibaba Cloud が生成するリクエストの一意な識別子で、問題のトラブルシューティングに使用できます。	6a3e9c36-1150-4881-84d3-eb8672fcafad
SecretName	string	シークレット名。	secret001
AutomaticRotation	string	自動ローテーションが有効かどうかを表します。有効な値： Enabled：自動ローテーションが有効です。 Disabled：自動ローテーションが無効です。 Invalid：ローテーションのステータスが異常です。 KMS はシークレットを自動ローテーションできません。説明このパラメーターは、 ApsaraDB RDS シークレット、 PolarDB シークレット、 Redis/Tair シークレット、 RAM シークレット、または ECS シークレットに対してのみ返されます。	Enabled
SecretType	string	シークレットのタイプ。有効な値： Generic：汎用シークレット。 Rds： ApsaraDB RDS シークレット。 Redis： Redis/Tair シークレット。 RAMCredentials： RAM シークレット。 ECS： ECS シークレット。 PolarDB： PolarDB シークレット。	Generic
VersionStages	array
	string	シークレットのバージョンに付与されるステージラベル。	{ "VersionStage": [ "ACSCurrent" ] }

例

成功レスポンス

JSONJSON

{
  "SecretDataType": "binary",
  "CreateTime": "2024-02-21T15:39:26Z",
  "VersionId": "v1",
  "NextRotationDate": "2024-07-06T18:22:03Z",
  "SecretData": "testdata1",
  "RotationInterval": "604800s",
  "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate": "2023-07-05T08:22:03Z",
  "RequestId": "6a3e9c36-1150-4881-84d3-eb8672fcafad",
  "SecretName": "secret001",
  "AutomaticRotation": "Enabled",
  "SecretType": "Generic",
  "VersionStages": [
    "{ \"VersionStage\": [ \t\"ACSCurrent\" \t] }"
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.DKMSInstanceStateInvalid	The DKMS instance state is invalid.
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.	アクセスキーが有効になっていません。
404	Forbidden.ResourceNotFound	Resource not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。