GetSecretValue - - Centre de documentation Alibaba Cloud

Obtient la valeur d'un secret.

Description de l'opération

Pour plus d'informations sur la stratégie d'accès qui doit être accordée à un utilisateur Resource Access Management (RAM) ou à un rôle RAM pour appeler cette opération, consultez Contrôle d'accès.
Si vous ne spécifiez pas de numéro de version ou d'état de version, KMS renvoie par défaut la valeur du secret de la version marquée comme ACSCurrent.
Si le secret utilise une clé principale personnalisée 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 de récupération de 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

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

kms:GetSecretValue

get

*Secret.

acs:kms:{#regionId}:{#accountId}:secret/{#SecretName}

Aucune

kms:Decrypt

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
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 saisir l'ARN du secret. Le format de l'ARN du secret est `acs:kms:${region}:${account}:secret/${secret-name}`.	secret001
VersionStage	string	Non	L'état de la version. Valeur par défaut : ACSCurrent. Si vous spécifiez ce paramètre, la valeur du secret de l'état de version spécifié est renvoyée. Si vous ne spécifiez pas ce paramètre, la valeur du secret de l'état de version ACSCurrent est renvoyée. Remarque Pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM dynamiques et les secrets ECS dynamiques, seules les valeurs de secret correspondant à ACSPrevious et ACSCurrent peuvent être récupérées.	ACSCurrent
VersionId	string	Non	Le numéro de version. Remarque La spécification de VersionId n'est pas prise en charge pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM dynamiques ou les secrets ECS dynamiques. Si vous définissez ce paramètre, il est ignoré.	v1
FetchExtendedConfig	boolean	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 la configuration étendue. Si vous définissez ce paramètre, il est ignoré.	true
DryRun	string	Non	Indique si le mode DryRun doit être activé. Valeurs valides : true : active le mode DryRun. false (par défaut) : désactive le mode DryRun. Le mode DryRun est utilisé pour tester les appels d'API, vérifier si vous disposez des autorisations requises sur les ressources spécifiées et contrôler si les paramètres de requête sont configurés correctement. Lorsque le mode DryRun est activé, KMS renvoie toujours un échec avec la raison de l'échec. Les raisons d'échec possibles incluent : DryRunOperationError : la requête réussirait si le paramètre DryRun n'était pas configuré. ValidationError : un paramètre spécifié dans la requête n'est pas valide. AccessDeniedError : vous n'avez pas l'autorisation d'effectuer cette opération sur la ressource KMS.	false
Recipient	string	Non		{ "AttestationDocument":"base64-encoded-attestion-document", "KeyEncryptionAlgorithm":"RSAES_OAEP_SHA_256" }

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.

Éléments de réponse

Élément	Type	Description	Exemple
	object
SecretDataType	string	Le type de la valeur du secret. Valeurs valides : text binary	binary
CreateTime	string	L'heure de création du secret.	2024-02-21T15:39:26Z
VersionId	string	Le numéro de version du secret.	v1
NextRotationDate	string	L'heure de la prochaine rotation. Remarque Ce paramètre est renvoyé lorsque la rotation automatique est activée.	2024-07-06T18:22:03Z
SecretData	string	La valeur du secret. KMS déchiffre la valeur du secret en texte chiffré stockée et renvoie ce paramètre. Pour les secrets génériques, la valeur du secret que vous avez spécifiée est renvoyée. Pour les secrets ApsaraDB RDS et les secrets Redis/Tair, la valeur du secret est renvoyée au format suivant : `{"AccountName":"","AccountPassword":""}`. Pour les secrets RAM dynamiques, la valeur du secret est renvoyée au format suivant : `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`. Pour les secrets ECS dynamiques, la valeur du secret est renvoyée dans l'un des 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**"}`. Pour les secrets PolarDB, la valeur du secret est renvoyée au format suivant : `{"AccountName":"","AccountPassword":""}`.	testdata1
RotationInterval	string	L'intervalle de rotation automatique du secret. Le format est `integer[unit]`, où `integer` indique la durée et `unit` indique l'unité de temps. Valeurs valides de `unit` : s (secondes). Par exemple, un intervalle de rotation de 7 jours est exprimé sous la forme 604800s. Remarque Ce paramètre est renvoyé lorsque la rotation automatique est activée.	604800s
ExtendedConfig	string	La configuration étendue du secret. Remarque Ce paramètre est renvoyé uniquement pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM dynamiques ou les secrets ECS dynamiques lorsque FetchExtendedConfig est défini sur true.	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	L'heure de la rotation la plus récente. Remarque Ce paramètre est renvoyé lorsque le secret a fait l'objet d'au moins une rotation.	2023-07-05T08:22:03Z
RequestId	string	L'identifiant de la requête, qui est un identifiant unique généré par Alibaba Cloud pour la requête. Vous pouvez utiliser cet identifiant pour dépanner et localiser les problèmes.	6a3e9c36-1150-4881-84d3-eb8672fcafad
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 n'est pas activée. Invalid : l'état de rotation est anormal et KMS ne peut pas effectuer la rotation automatique du secret. Remarque Ce paramètre est renvoyé uniquement pour les secrets ApsaraDB RDS, les secrets PolarDB, les secrets Redis/Tair, les secrets RAM dynamiques ou les secrets ECS dynamiques.	Enabled
SecretType	string	Le type de secret. Valeurs valides : Generic : secret générique. Rds : secret ApsaraDB RDS. Redis : secret Redis/Tair. RAMCredentials : secret RAM dynamique. ECS : secret ECS dynamique. PolarDB : secret PolarDB.	Generic
VersionStages	object
VersionStage	array	Le libellé d'état de la version du secret.
	string	Le libellé d'état de la version du secret.	{ "VersionStage": [ "ACSCurrent" ] }
CiphertextForRecipient	string		*CipherForRecipient*

Exemples

JSON format

{
  "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": [
      "{ \"VersionStage\": [ \t\"ACSCurrent\" \t] }"
    ]
  },
  "CiphertextForRecipient": "***CipherForRecipient***"
}

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.