BatchGetSecretValue - - Centre de documentation Alibaba Cloud

Obtient les valeurs des secrets par lots.

Description de l'opération

Pour plus d'informations sur la stratégie d'accès requise pour qu'un utilisateur ou un rôle Resource Access Management (RAM) puisse appeler cette opération, consultez Contrôle d'accès.
Si vous ne spécifiez pas de numéro de version ou d'étape de version, KMS renvoie par défaut la valeur du secret de la version marquée comme ACSCurrent.
L'appelant doit disposer de l'autorisation kms:GetSecretValue sur tous les secrets du lot.
Si un secret utilise une clé principale client pour protéger la valeur du secret, l'appelant doit également disposer de l'autorisation kms:Decrypt sur la clé principale correspondante.

Cette rubrique fournit un exemple montrant comment obtenir la valeur d'un secret nommé secret001. La réponse indique que la valeur du secret SecretData est testdata1.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Syntaxe de la requête

GET  HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SecretsList	array<object>	Non	La liste des informations de secret. Vous pouvez interroger jusqu'à 20 secrets différents à la fois.
	object	Non
SecretName	string	Oui	Le nom du secret ou le nom de ressource Alibaba Cloud (ARN) du secret. Remarque Lors de l'accès à un secret dans un autre compte Alibaba Cloud, vous devez spécifier l'ARN du secret. Le format d'un ARN de secret est `acs:kms:${region}:${account}:secret/${secret-name}`.	secret001
VersionStage	string	Non	L'étape de version. Valeur par défaut : ACSCurrent. Si vous spécifiez ce paramètre, la valeur du secret de l'étape de version spécifiée est renvoyée. Si vous ne spécifiez pas ce paramètre, la valeur du secret de l'étape de version ACSCurrent est renvoyée. Remarque Pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM et les secrets ECS, vous ne pouvez obtenir que les valeurs des secrets des versions ACSPrevious et ACSCurrent.	ACSCurrent
VersionId	string	Non	Le numéro de version.	v1
FetchExtendedConfig	string	Non	Indique si la configuration étendue du secret doit être récupérée. Valeurs valides : true : récupère la configuration étendue. false (par défaut) : ne récupère pas la configuration étendue. Remarque Les secrets génériques ne prennent pas en charge les configurations étendues. Ce paramètre est ignoré pour les secrets génériques. Valeurs valides : true : Récupère la configuration étendue. false : Ne récupère pas la configuration étendue.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	8252db58-2036-408c-a3d5-56e656dc2551
SecretValues	array<object>	La liste des secrets obtenus avec succès.
	array<object>
SecretDataType	string	Le type de la valeur du secret. Valeurs valides : text binary	binary
CreateTime	string	L'heure à laquelle le secret a été créé (UTC).	2024-02-21T15:39:26Z
VersionId	string	Le numéro de version du secret.	v1
NextRotationDate	string	L'heure de la prochaine rotation (UTC). Remarque Ce paramètre n'est renvoyé que lorsque la rotation automatique est activée.	2024-07-06T18:22:03Z
SecretData	string	La valeur du secret. KMS déchiffre la valeur chiffrée du secret stockée et renvoie ce paramètre. Un secret générique renvoie la valeur de secret que vous avez spécifiée. Un secret ApsaraDB RDS ou Redis/Tair renvoie la valeur du secret au format suivant : `{"AccountName":"","AccountPassword":""}`. Un secret RAM renvoie la valeur du secret au format suivant : `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`. Un secret ECS renvoie la valeur du secret aux formats suivants : Secret de type mot de passe : `{"UserName":"ecs-user","Password":"H5asdasdsads**"}`. Secret de type clé publique-privée (clé privée au format PEM) : `{"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}`. Un secret PolarDB renvoie la valeur du secret au format suivant : `{"AccountName":"","AccountPassword":""}`.	testdata1
RotationInterval	string	L'intervalle de rotation automatique du secret. Le format est entier[unité], où entier spécifie la durée et unité spécifie l'unité de temps. La valeur de l'unité est s (secondes). Par exemple, un intervalle de rotation de 7 jours correspond à 604800s. Remarque Ce paramètre n'est renvoyé que lorsque la rotation automatique est activée.	604800s
ExtendedConfig	string	La configuration étendue du secret. Remarque Ce paramètre n'est renvoyé que pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM ou les secrets ECS lorsque FetchExtendedConfig est défini sur true.	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	L'heure de la rotation la plus récente (UTC). Remarque Ce paramètre n'est renvoyé que lorsque le secret a fait l'objet d'une rotation.	2023-07-05T08:22:03Z
RequestId	string	L'identifiant de cette requête, qui est un identifiant unique généré par Alibaba Cloud à des fins de dépannage.	8252db58-2036-408c-a3d5-56e656dc2551
SecretName	string	Le nom du secret.	secret001
AutomaticRotation	string	Indique si la rotation automatique est activée. Valeurs valides : Enabled : la rotation automatique est activée. Disabled : la rotation automatique est désactivée. Invalid : l'état de la rotation est anormal. KMS ne peut pas effectuer la rotation automatique du secret. Remarque Ce paramètre n'est renvoyé que pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM ou les secrets ECS.	Enabled
SecretType	string	Le type du secret. Valeurs valides : Generic : secret générique. Rds : secret ApsaraDB RDS. Redis : secret Redis/Tair. RAMCredentials : secret RAM. ECS : secret ECS. PolarDB : secret PolarDB.	Generic
VersionStages	object	Les étapes de version du secret.
VersionStage	array
	string		{ "VersionStage": [ "ACSCurrent" ] }
Errors	array<object>	La liste des erreurs pour les secrets dont la récupération a échoué.
	object	Aucune.
SecretName	string	Le nom du secret.	secret002
HttpStatus	integer	Le code d'état HTTP renvoyé pour l'erreur.	404
Code	string	Le code d'erreur du service.	Forbidden.ResourceNotFound
Message	string	Le message d'erreur pour l'échec de récupération du secret.	Ressource introuvable

Exemples

JSON format

{
  "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."
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.