Todos los productos
Search

Este producto

    Key Management Service:GetSecretValue

    Centro de documentos

    Key Management Service:GetSecretValue

    Última actualización: Sep 03, 2026

    Recupera el valor en texto plano de un secreto from la puerta de enlace de una instancia de KMS. La respuesta incluye los datos del secreto descifrados, junto con información de versión, estado de rotación y configuración extendida si se solicita.

    Parámetros de solicitud

    ParámetroTipoObligatorioPredeterminadoEjemploDescripción
    SecretNameStringSí—secret001Nombre del secreto.
    VersionStageStringNoACSCurrentACSCurrentEtiqueta de etapa que identifica la versión del secreto por recuperar. KMS devuelve el valor del secreto de la versión marcada con la etiqueta de etapa especificada. Valores válidos: ACSCurrent, ACSPrevious. Valor predeterminado: ACSCurrent.
    Nota

    Para secretos de Resource Access Management (RAM), secretos de base de datos y secretos de Elastic Compute Service (ECS), KMS solo devuelve las versiones marcadas con ACSCurrent o ACSPrevious. Los secretos de base de datos incluyen secretos de ApsaraDB RDS, secretos de PolarDB y secretos de ApsaraDB for Redis/Tair.

    VersionIdStringNo—00000000000000000000000000000001ID de versión del valor del secreto por recuperar. Si especifica tanto VersionStage como VersionId, KMS comprueba si existe la versión indicada. De existir, se devuelve el valor del secreto; de lo contrario, se retorna un error de parámetro.
    Nota

    Los secretos de RAM, los secretos de base de datos y los secretos de ECS no admiten este parámetro. Si especifica VersionId para estos tipos de secretos, el parámetro se ignora.

    FetchExtendedConfigBooleanNofalsefalseIndica si se debe devolver la configuración extendida del secreto. Si se establece en true, la respuesta incluye el campo ExtendedConfig. Valor predeterminado: false.

    Elementos de respuesta

    Parámetro

    Tipo

    Ejemplo

    Descripción

    SecretName

    String

    secret001

    Nombre del secreto.

    SecretType

    String

    Generic

    Tipo de secreto. Valores válidos: Generic (secreto genérico), Rds (secreto de ApsaraDB RDS), Redis (secreto de ApsaraDB for Redis/Tair), RAMCredentials (secreto de RAM), ECS (secreto de ECS), PolarDB (secreto de PolarDB).

    SecretData

    String

    testdata1

    Valor del secreto en texto plano. KMS descifra el texto cifrado almacenado y devuelve el texto plano en este campo.

    SecretDataType

    String

    binary

    Formato del valor del secreto. Valores válidos: text, binary.

    VersionId

    String

    00000000000000000000000000000001

    ID de versión del valor del secreto devuelto.

    VersionStages

    List

    ["ACSCurrent"]

    Etiquetas de etapa asociadas a la versión del secreto devuelta.

    CreateTime

    String

    2020-02-21T15:39:26Z

    Hora de creación del secreto. Sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ. Se muestra en UTC.

    LastRotationDate

    String

    2020-07-05T08:22:03Z

    Hora de la última rotación del secreto. Sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ. Se muestra en UTC.

    NextRotationDate

    String

    2020-07-06T18:22:03Z

    Próxima hora programada para la rotación del secreto. Sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ. Se muestra en UTC.

    AutomaticRotation

    String

    Enabled

    Estado de la rotación automática del secreto. Valores válidos: Enabled (la rotación automática está habilitada), Disabled (la rotación automática está deshabilitada), Invalid (el estado de la rotación automática es anómalo y KMS no puede rotar el secreto automáticamente).

    RotationInterval

    String

    604800s

    Intervalo entre rotaciones automáticas, en formato integer[unit]. Actualmente, la única unidad compatible es s (segundos). Por ejemplo, 604800s representa un intervalo de rotación de 7 días.

    ExtendedConfig

    String

    {"SecretSubType":"SingleUser","DBInstanceId":"rm-uf667446pc955****","CustomData":{}}

    Configuración extendida del secreto. Este campo se devuelve solo cuando FetchExtendedConfig se establece en true.

    RequestId

    String

    6a3e9c36-1150-4881-84d3-eb8672fcafad

    ID de la solicitud.

    Códigos de error

    Código de estado HTTP

    Código de error

    Mensaje de error

    Descripción

    404

    Forbidden.ResourceNotFound

    The resource does not exist in the system.

    El secreto especificado no existe.

    409

    Rejected.Disabled

    The request was rejected because the key state is Disabled.

    La clave de cifrado utilizada para proteger el secreto está deshabilitada.

    Para obtener una lista completa de códigos de error, consulte Service error codes.