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

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

操作説明

RAM ユーザーまたは RAM ロールがこの API 操作を呼び出すために必要なアクセスポリシーについては、「リソースアクセス管理」をご参照ください。
バージョン番号またはステージを指定しない場合、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 でマークされたバージョンのシークレット値が返されます。説明 RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、および ECS シークレットの場合、ACSPrevious および ACSCurrent とマークされているバージョンのシークレット値のみを取得できます。	ACSCurrent
VersionId	string	任意	バージョン番号。説明 RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、または ECS シークレットには VersionId パラメーターを指定できません。このパラメーターを設定しても無視されます。	00000000000000000000000000000001
FetchExtendedConfig	boolean	任意	シークレットの拡張構成を取得するかどうかを指定します。有効な値： true: 拡張構成を取得します。 false (デフォルト): 拡張構成を取得しません。説明汎用シークレットは拡張構成をサポートしていません。汎用シークレットにこのパラメーターを設定しても無視されます。	true
DryRun	string	任意	ドライラン機能を有効にするかどうかを指定します。 true: ドライラン機能を有効にします。 false (デフォルト): ドライラン機能を無効にします。ドライラン機能は、API 呼び出しをテストするために使用されます。リソースに必要な権限があるかどうか、およびリクエストパラメーターが有効かどうかを確認します。ドライラン機能を有効にすると、KMS は常にエラーの原因を示すエラー応答を返します。考えられるエラーの原因は次のとおりです。 DryRunOperationError: DryRun パラメーターが指定されていなければ、リクエストは成功していました。 ValidationError: リクエストで指定されたパラメーターが無効です。 AccessDeniedError: KMS リソースでこの操作を実行する権限がありません。	false

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

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
SecretDataType	string	シークレット値のタイプ。有効な値： text binary	binary
CreateTime	string	シークレットが作成された日時。	2020-02-21T15:39:26Z
VersionId	string	シークレットのバージョン番号。	00000000000000000000000000000001
NextRotationDate	string	シークレットが次回回転される日時。説明このパラメーターは、自動回転が有効になっている場合にのみ返されます。	2020-07-06T18:22:03Z
SecretData	string	シークレットの値。値は KMS によって暗号文から復号化されて返されます。汎用シークレットの場合、指定した値が返されます。 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 日間の回転期間は 604800s です。説明このパラメーターは、自動回転が有効になっている場合にのみ返されます。	604800s
ExtendedConfig	string	シークレットの拡張構成。説明このパラメーターは、FetchExtendedConfig が true に設定されている場合にのみ、RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、または ECS シークレットに対して返されます。	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	シークレットが最後に回転された日時。説明このパラメーターは、シークレットが回転された場合にのみ返されます。	2020-07-05T08:22:03Z
RequestId	string	リクエスト ID。Alibaba Cloud によって生成される一意の識別子です。この ID を使用して問題のトラブルシューティングを行うことができます。	6a3e9c36-1150-4881-84d3-eb8672fcafad
SecretName	string	シークレットの名前。	secret001
AutomaticRotation	string	自動回転が有効になっているかどうかを示します。有効な値： Enabled: 自動回転が有効です。 Disabled: 自動回転は有効になっていません。 Invalid: 回転ステータスが異常であり、KMS はシークレットを自動的に回転できません。説明このパラメーターは、RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、または ECS シークレットに対してのみ返されます。	Enabled
SecretType	string	シークレットのタイプ。有効な値： Generic: 汎用シークレット。 Rds: RDS シークレット。 Redis: Redis/Tair シークレット。 RAMCredentials: RAM シークレット。 ECS: ECS シークレット。 PolarDB: PolarDB シークレット。	Generic
VersionStages	array	シークレットバージョンをマークするステージラベル。
	string	シークレットバージョンをマークするステージラベル。	{ "VersionStage": [ "ACSCurrent" ] }

例

成功レスポンス

JSONJSON

{
  "SecretDataType": "binary",
  "CreateTime": "2020-02-21T15:39:26Z",
  "VersionId": "00000000000000000000000000000001",
  "NextRotationDate": "2020-07-06T18:22:03Z",
  "SecretData": "testdata1",
  "RotationInterval": "604800s",
  "ExtendedConfig": "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate": "2020-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.

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

変更履歴

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