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

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

操作説明

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

この Topic では、secret001 という名前のシークレットの値を取得する例を示します。応答は、シークレット値 SecretData が testdata1 であることを示しています。

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SecretsList	array<object>	任意	シークレット情報のリストです。一度に最大 20 個の異なるシークレットをクエリできます。
	object	任意
SecretName	string	必須	シークレット名またはシークレットの Amazon リソースネーム (ARN) です。説明別の Alibaba Cloud アカウントのシークレットにアクセスする場合は、シークレット ARN を指定する必要があります。シークレット ARN のフォーマットは `acs:kms:${リージョン}:${account}:secret/${secret-name}` です。	シークレット001
VersionStage	string	任意	バージョンステージです。デフォルト値: ACSCurrent。このパラメーターを指定すると、指定したバージョンステージのシークレット値が返されます。このパラメーターを指定しない場合、ACSCurrent バージョンステージのシークレット値が返されます。説明 ApsaraDB RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、および ECS シークレットの場合、ACSPrevious および ACSCurrent バージョンのシークレット値のみを取得できます。	ACSCurrent
VersionId	string	任意	バージョン番号です。	v1
FetchExtendedConfig	string	任意	シークレットの拡張構成を取得するかどうかを指定します。有効な値: true: 拡張構成を取得します。 false (デフォルト): 拡張構成を取得しません。説明汎用シークレットは拡張構成をサポートしていません。汎用シークレットの場合、このパラメーターは無視されます。列挙値: true : 拡張構成を取得します。 false : 拡張構成を取得しません。	true

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID です。	8252db58-2036-408c-a3d5-56e656dc2551
SecretValues	array<object>	正常に取得されたシークレットのリストです。
	array<object>
SecretDataType	string	シークレット値のタイプです。有効な値: text バイナリ	バイナリ
CreateTime	string	シークレットが作成された時間 (UTC) です。	2024-02-21T15:39:26Z
VersionId	string	シークレットのバージョン番号です。	v1
NextRotationDate	string	次の回転の時間 (UTC) です。説明このパラメーターは、自動回転が有効な場合にのみ返されます。	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 日間の回転間隔は 604800s です。説明このパラメーターは、自動回転が有効な場合にのみ返されます。	604800s
ExtendedConfig	string	シークレットの拡張構成です。説明このパラメーターは、FetchExtendedConfig が true に設定されている場合に、ApsaraDB RDS シークレット、PolarDB シークレット、Redis/Tair シークレット、RAM シークレット、または ECS シークレットに対してのみ返されます。	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	最新の回転の時間 (UTC) です。説明このパラメーターは、シークレットが回転された場合にのみ返されます。	2023-07-05T08:22:03Z
RequestId	string	このリクエストの ID です。これは、トラブルシューティングのために Alibaba Cloud によって生成される一意の識別子です。	8252db58-2036-408c-a3d5-56e656dc2551
SecretName	string	シークレット名です。	シークレット001
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	object	シークレットのバージョンステージです。
VersionStage	array
	string		{ "VersionStage": [ "ACSCurrent" ] }
Errors	array<object>	取得に失敗したシークレットのエラーリストです。
	object	なし。
SecretName	string	シークレット名です。	シークレット002
HttpStatus	integer	エラーに対して返された HTTP 状態コードです。	404
Code	string	サービスエラーコードです。	Forbidden.ResourceNotFound
Message	string	シークレット取得が失敗した際のエラーメッセージです。	Resource not found

例

成功レスポンス

JSONJSON

{
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "SecretValues": [
    {
      "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": "8252db58-2036-408c-a3d5-56e656dc2551",
      "SecretName": "secret001",
      "AutomaticRotation": "Enabled",
      "SecretType": "Generic",
      "VersionStages": {
        "VersionStage": [
          "{ \"VersionStage\": [ \"ACSCurrent\" ] }"
        ]
      }
    }
  ],
  "Errors": [
    {
      "SecretName": "secret002",
      "HttpStatus": 404,
      "Code": "Forbidden.ResourceNotFound",
      "Message": "Resource not found."
    }
  ]
}

エラーコード

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.

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

変更履歴

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