Tous les produits
Search

Ce produit

    Key Management Service:GetSecretValue

    Centre de documentation

    Key Management Service:GetSecretValue

    Dernière mise à jour :Aug 09, 2026

    Récupère la valeur en texte clair d'un secret depuis une passerelle d'instance KMS. La réponse inclut les données déchiffrées du secret, ainsi que les informations de version, l'état de rotation et la configuration étendue si celle-ci est demandée.

    Paramètres de requête

    ParameterTypeRequiredDefaultExampleDescription
    SecretNameStringYes—secret001Nom du secret.
    VersionStageStringNoACSCurrentACSCurrentLibellé d'étape identifiant la version du secret à récupérer. KMS renvoie la valeur du secret associée à la version portant le libellé d'étape spécifié. Valeurs valides : ACSCurrent, ACSPrevious. Valeur par défaut : ACSCurrent.
    Remarque

    Pour les secrets Resource Access Management (RAM), les secrets de base de données et les secrets Elastic Compute Service (ECS), KMS ne renvoie que les versions portant les libellés ACSCurrent ou ACSPrevious. Les secrets de base de données incluent les secrets ApsaraDB RDS, les secrets PolarDB et les secrets ApsaraDB for Redis/Tair.

    VersionIdStringNo—00000000000000000000000000000001ID de version de la valeur de secret à récupérer. Si vous spécifiez à la fois VersionStage et VersionId, KMS vérifie l'existence de la version spécifiée. Si elle existe, KMS renvoie la valeur du secret. Sinon, il retourne une erreur de paramètre.
    Remarque

    Les secrets RAM, les secrets de base de données et les secrets ECS ne prennent pas en charge ce paramètre. Si vous spécifiez VersionId pour ces types de secrets, le paramètre est ignoré.

    FetchExtendedConfigBooleanNofalsefalseIndique s'il faut renvoyer la configuration étendue du secret. Si la valeur est true, la réponse inclut le champ ExtendedConfig. Valeur par défaut : false.

    Éléments de réponse

    Parameter Type Example Description
    SecretName String secret001 Nom du secret.
    SecretType String Generic Type du secret. Valeurs valides : Generic (secret générique), Rds (secret ApsaraDB RDS), Redis (secret ApsaraDB for Redis/Tair), RAMCredentials (secret RAM), ECS (secret ECS), PolarDB (secret PolarDB).
    SecretData String testdata1 Valeur du secret en texte clair. KMS déchiffre le texte chiffré stocké et renvoie le texte clair dans ce champ.
    SecretDataType String binary Format de la valeur du secret. Valeurs valides : text, binary.
    VersionId String 00000000000000000000000000000001 ID de version de la valeur de secret renvoyée.
    VersionStages List ["ACSCurrent"] Libellés d'étapes associés à la version du secret renvoyée.
    CreateTime String 2020-02-21T15:39:26Z Date de création du secret. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.
    LastRotationDate String 2020-07-05T08:22:03Z Date de la dernière rotation du secret. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.
    NextRotationDate String 2020-07-06T18:22:03Z Date de la prochaine rotation planifiée du secret. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.
    AutomaticRotation String Enabled État de la rotation automatique des secrets. Valeurs valides : Enabled (la rotation automatique est activée), Disabled (la rotation automatique est désactivée), Invalid (l'état de la rotation automatique est anormal et KMS ne peut pas effectuer automatiquement la rotation du secret).
    RotationInterval String 604800s Intervalle entre les rotations automatiques, au format integer[unit]. Actuellement, la seule unité prise en charge est s (secondes). Par exemple, 604800s représente un intervalle de rotation de 7 jours.
    ExtendedConfig String {"SecretSubType":"SingleUser","DBInstanceId":"rm-uf667446pc955****","CustomData":{}} Configuration étendue du secret. Ce champ n'est renvoyé que si FetchExtendedConfig est défini sur true.
    RequestId String 6a3e9c36-1150-4881-84d3-eb8672fcafad ID de la requête.

    Codes d'erreur

    HTTP status code Error code Error message Description
    404 Forbidden.ResourceNotFound The resource does not exist in the system. Le secret spécifié n'existe pas.
    409 Rejected.Disabled The request was rejected because the key state is Disabled. La clé de chiffrement utilisée pour protéger le secret est désactivée.

    Pour obtenir la liste complète des codes d'erreur, consultez Codes d'erreur du service.