

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# DescribeLedger
<a name="API_DescribeLedger"></a>

Restituisce informazioni su un registro, inclusi lo stato, la modalità di autorizzazione, le impostazioni di crittografia a riposo e la data di creazione.

## Sintassi della richiesta
<a name="API_DescribeLedger_RequestSyntax"></a>

```
GET /ledgers/name HTTP/1.1
```

## Parametri della richiesta URI
<a name="API_DescribeLedger_RequestParameters"></a>

La richiesta utilizza i seguenti parametri URI.

 ** [name](#API_DescribeLedger_RequestSyntax) **   <a name="qldb-DescribeLedger-request-uri-Name"></a>
Il nome del libro mastro che si desidera descrivere.  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 32 caratteri.  
Modello: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`   
Campo obbligatorio: sì

## Corpo della richiesta
<a name="API_DescribeLedger_RequestBody"></a>

La richiesta non ha un corpo della richiesta.

## Sintassi della risposta
<a name="API_DescribeLedger_ResponseSyntax"></a>

```
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"
}
```

## Elementi di risposta
<a name="API_DescribeLedger_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [Arn](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Arn"></a>
L'Amazon Resource Name (ARN) per il registro.  
Tipo: stringa  
Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 1600 caratteri.

 ** [CreationDateTime](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-CreationDateTime"></a>
La data e l'ora, in formato epoch time, in cui è stato creato il libro mastro. (Il formato dell'ora epoch è il numero di secondi trascorsi dalle 00:00 del 1° gennaio 1970 UTC.)  
Tipo: Timestamp

 ** [DeletionProtection](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-DeletionProtection"></a>
Specifica se il libro mastro è protetto dall'eliminazione da parte di un utente qualsiasi. Se non definita al momento della creazione del libro mastro, questa caratteristica è abilitata (`true`) per impostazione predefinita.  
Se la protezione dall'eliminazione è abilitata, è necessario innanzitutto disabilitarla prima di poter eliminare il libro mastro. Puoi disabilitarla chiamando l'operazione `UpdateLedger` per impostare questo parametro su `false`.  
Tipo: Booleano

 ** [EncryptionDescription](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-EncryptionDescription"></a>
Informazioni sulla crittografia dei dati inattivi nel registro. Ciò include lo stato corrente, la AWS KMS chiave e il momento in cui la chiave è diventata inaccessibile (in caso di errore). Se questo parametro non è definito, il registro utilizza una chiave KMS AWS proprietaria per la crittografia.  
Tipo: oggetto [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md)

 ** [Name](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Name"></a>
Il nome del libro mastro.  
Tipo: stringa  
Limitazioni di lunghezza: lunghezza minima pari a 1. La lunghezza massima è 32 caratteri.  
Modello: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-PermissionsMode"></a>
La modalità di autorizzazione del libro mastro.  
Tipo: stringa  
Valori validi: `ALLOW_ALL | STANDARD` 

 ** [State](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-State"></a>
Lo stato attuale del libro mastro.  
Tipo: stringa  
Valori validi: `CREATING | ACTIVE | DELETING | DELETED` 

## Errori
<a name="API_DescribeLedger_Errors"></a>

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** InvalidParameterException **   
Uno o più parametri nella richiesta non sono validi.  
Codice di stato HTTP: 400

 ** ResourceNotFoundException **   
La risorsa specificata non esiste.  
Codice di stato HTTP: 404

## Vedi anche
<a name="API_DescribeLedger_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [Interfaccia a riga di comando AWS](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeLedger) 