DescribeLedger - Amazon Quantum Ledger Database (Amazon QLDB)

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeLedger

Devuelve información sobre un libro mayor, incluido su estado, modo de permisos, configuración de cifrado en reposo y cuándo se creó.

Sintaxis de la solicitud

GET /ledgers/name HTTP/1.1

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

name

El nombre de contabilidad que desea describir.

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 32 caracteres.

Patrón: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Obligatorio: Sí

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationDateTime": number, "DeletionProtection": boolean, "EncryptionDescription": { "EncryptionStatus": "string", "InaccessibleKmsKeyDateTime": number, "KmsKeyArn": "string" }, "Name": "string", "PermissionsMode": "string", "State": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

Arn

El nombre de recurso de Amazon (ARN) del libro mayor.

Type: Cadena

Restricciones de longitud: Longitud mínima de 20. La longitud máxima es de 1600 caracteres.

CreationDateTime

Es la fecha y la hora en que se creó el libro mayor. (El formato de tiempo en formato Unix es el número de segundos transcurridos desde las 12:00:00 a.m. del 1 de enero de 1970 en UTC.)

Type: Marca temporal

DeletionProtection

Especifica si el libro mayor está protegido contra la eliminación de un usuario. Si no se define durante la creación del libro mayor, esta característica está habilitada (true) de forma predeterminada.

Si la protección contra eliminación está habilitada, primero debe deshabilitarla para poder eliminar el libro mayor. Puede deshabilitarlo llamando alUpdateLedgerpara establecer este parámetro enfalse.

Type: Booleano

EncryptionDescription

Información sobre el cifrado de datos en reposo en el libro mayor. Esto incluye el estado actual, elAWS KMSy cuando la clave se volvió inaccesible (en caso de error).

Tipo: objeto LedgerEncryptionDescription

Name

El nombre de contabilidad.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 32 caracteres.

Patrón: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

PermissionsMode

El modo de permisos del libro mayor.

Type: Cadena

Valores válidos: ALLOW_ALL | STANDARD

State

El estado actual del libro mayor.

Type: Cadena

Valores válidos: CREATING | ACTIVE | DELETING | DELETED

Errores

Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.

InvalidParameterException

Uno o varios parámetros de la solicitud no son válidos.

Código de estado HTTP: 400

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 404

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: