BatchGetSecretValue - Key Management Service - Centro de documentación de Alibaba Cloud

Obtiene valores de secretos en lotes.

Descripción de la operación

Para obtener detalles sobre la política de acceso requerida para que un usuario o rol de Resource Access Management (RAM) invoque esta operación, consulte Control de acceso.
Si no especifica un número de versión ni una etapa de versión, KMS devuelve el valor del secreto de la versión marcada como ACSCurrent de forma predeterminada.
El invocador debe tener el permiso kms:GetSecretValue en todos los secretos del lote.
Si un secreto utiliza una clave maestra del cliente para proteger el valor del secreto, el invocador también debe tener el permiso kms:Decrypt en la clave maestra correspondiente.

Este tema proporciona un ejemplo de cómo obtener el valor de un secreto llamado secret001. La respuesta muestra que el valor del secreto SecretData es testdata1.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Sintaxis de la solicitud

GET  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
SecretsList	array<object>	No	La lista de información de secretos. Puede consultar hasta 20 secretos diferentes a la vez.
	object	No
SecretName	string	Sí	El nombre del secreto o el Nombre de Recurso de Alibaba Cloud (ARN) del secreto. Nota Al acceder a un secreto en otra cuenta de Alibaba Cloud, debe especificar el ARN del secreto. El formato de un ARN de secreto es `acs:kms:${region}:${account}:secret/${secret-name}`.	secret001
VersionStage	string	No	La etapa de versión. Valor predeterminado: ACSCurrent. Si especifica este parámetro, se devuelve el valor del secreto de la etapa de versión especificada. Si no especifica este parámetro, se devuelve el valor del secreto de la etapa de versión ACSCurrent. Nota Para secretos de ApsaraDB RDS, secretos de PolarDB, secretos de Redis/Tair, secretos de RAM y secretos de ECS, solo puede obtener los valores de secreto de las versiones ACSPrevious y ACSCurrent.	ACSCurrent
VersionId	string	No	El número de versión.	v1
FetchExtendedConfig	string	No	Especifica si se debe obtener la configuración extendida del secreto. Valores válidos: true: Obtener la configuración extendida. false (predeterminado): No obtener la configuración extendida. Nota Los secretos genéricos no admiten configuraciones extendidas. Este parámetro se ignora para los secretos genéricos. Valores válidos: true : Obtener la configuración extendida. false : No obtener la configuración extendida.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	8252db58-2036-408c-a3d5-56e656dc2551
SecretValues	array<object>	La lista de secretos que se obtuvieron correctamente.
	array<object>
SecretDataType	string	El tipo del valor del secreto. Valores válidos: text binary	binary
CreateTime	string	La hora en que se creó el secreto (UTC).	2024-02-21T15:39:26Z
VersionId	string	El número de versión del secreto.	v1
NextRotationDate	string	La hora de la siguiente rotación (UTC). Nota Este parámetro se devuelve solo cuando la rotación automática está habilitada.	2024-07-06T18:22:03Z
SecretData	string	El valor del secreto. KMS descifra el valor del secreto cifrado almacenado y devuelve este parámetro. Un secreto genérico devuelve el valor del secreto que usted especificó. Un secreto de ApsaraDB RDS o un secreto de Redis/Tair devuelve el valor del secreto en el siguiente formato: `{"AccountName":"","AccountPassword":""}`. Un secreto de RAM devuelve el valor del secreto en el siguiente formato: `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`. Un secreto de ECS devuelve el valor del secreto en los siguientes formatos: Secreto de tipo contraseña: `{"UserName":"ecs-user","Password":"H5asdasdsads**"}`. Secreto de tipo par de claves pública-privada (clave privada en formato PEM): `{"UserName":"ecs-user","PublicKey":"ssh-rsa mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21**"}`. Un secreto de PolarDB devuelve el valor del secreto en el siguiente formato: `{"AccountName":"","AccountPassword":""}`.	testdata1
RotationInterval	string	El intervalo para la rotación automática del secreto. El formato es entero[unidad], donde entero especifica la duración y unidad especifica la unidad de tiempo. El valor de unidad es s (segundos). Por ejemplo, un intervalo de rotación de 7 días es 604800s. Nota Este parámetro se devuelve solo cuando la rotación automática está habilitada.	604800s
ExtendedConfig	string	La configuración extendida del secreto. Nota Este parámetro se devuelve solo para secretos de ApsaraDB RDS, secretos de PolarDB, secretos de Redis/Tair, secretos de RAM o secretos de ECS cuando FetchExtendedConfig se establece en true.	{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }
LastRotationDate	string	La hora de la rotación más reciente (UTC). Nota Este parámetro se devuelve solo cuando el secreto ha sido rotado.	2023-07-05T08:22:03Z
RequestId	string	El ID de esta solicitud, que es un identificador único generado por Alibaba Cloud con fines de solución de problemas.	8252db58-2036-408c-a3d5-56e656dc2551
SecretName	string	El nombre del secreto.	secret001
AutomaticRotation	string	Indica si la rotación automática está habilitada. Valores válidos: Enabled: La rotación automática está habilitada. Disabled: La rotación automática está deshabilitada. Invalid: El estado de rotación es anómalo. KMS no puede rotar el secreto automáticamente. Nota Este parámetro se devuelve solo para secretos de ApsaraDB RDS, secretos de PolarDB, secretos de Redis/Tair, secretos de RAM o secretos de ECS.	Enabled
SecretType	string	El tipo del secreto. Valores válidos: Generic: secreto genérico. Rds: secreto de ApsaraDB RDS. Redis: secreto de Redis/Tair. RAMCredentials: secreto de RAM. ECS: secreto de ECS. PolarDB: secreto de PolarDB.	Generic
VersionStages	object	Las etapas de versión del secreto.
VersionStage	array	Las etapas de versión del secreto.
	string	Las etapas de versión del secreto.	{ "VersionStage": [ "ACSCurrent" ] }
Errors	array<object>	La lista de errores para los secretos que no se pudieron obtener.
	object	Ninguna.
SecretName	string	El nombre del secreto.	secret002
HttpStatus	integer	El código de estado HTTP devuelto para el error.	404
Code	string	El código de error del servicio.	Forbidden.ResourceNotFound
Message	string	El mensaje de error para la obtención fallida del secreto.	Resource not found

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	Forbidden.DKMSInstanceStateInvalid	The DKMS instance state is invalid.	Your dedicated KMS instance is invalid.
403	Forbidden.DKMSInstanceNotFound	The specified DKMS Instance is not found.	Your dedicated KMS instance is not found.
404	Forbidden.KeyNotFound	The specified Key is not found.	The error message returned because the specified CMK does not exist.
404	Forbidden.ResourceNotFound	Resource not found.	The resource is not found.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.