Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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

Renvoie des informations sur un registre, notamment son état, son mode d'autorisation, les paramètres de chiffrement au repos et sa date de création.

## Syntaxe de la demande
<a name="API_DescribeLedger_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_DescribeLedger_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [name](#API_DescribeLedger_RequestSyntax) **   <a name="qldb-DescribeLedger-request-uri-Name"></a>
Le nom du registre que vous souhaitez décrire.  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.  
Modèle : `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`   
Obligatoire : oui

## Corps de la demande
<a name="API_DescribeLedger_RequestBody"></a>

La demande n’a pas de corps de requête.

## Syntaxe de la réponse
<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"
}
```

## Eléments de réponse
<a name="API_DescribeLedger_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [Arn](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Arn"></a>
Le nom de ressource Amazon (ARN) du registre.  
Type : String  
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.

 ** [CreationDateTime](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-CreationDateTime"></a>
Date et heure, au format epoch time, auxquelles le registre a été créé. (Le format Epoch est le nombre de secondes écoulées depuis 00h00 le 1er janvier 1970 UTC.)  
Type : Timestamp

 ** [DeletionProtection](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-DeletionProtection"></a>
Spécifie si le registre est protégé contre la suppression par un utilisateur. À défaut de définition lors de la création du registre, cette fonctionnalité est activée (`true`) par défaut.  
Si la protection contre la suppression est activée, vous devez commencer par la désactiver avant de pouvoir supprimer le registre. Vous pouvez la désactiver en appelant l'opération `UpdateLedger` pour définir ce paramètre sur `false`.  
Type : booléen

 ** [EncryptionDescription](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-EncryptionDescription"></a>
Informations sur le chiffrement des données au repos dans le registre. Cela inclut l'état actuel, la AWS KMS clé et le moment où la clé est devenue inaccessible (en cas d'erreur). Si ce paramètre n'est pas défini, le registre utilise une clé KMS AWS détenue pour le chiffrement.  
Type : objet [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md)

 ** [Name](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Name"></a>
Nom du registre.  
Type : String  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.  
Modèle : `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-PermissionsMode"></a>
Le mode d'autorisations du registre.  
Type : String  
Valeurs valides : `ALLOW_ALL | STANDARD` 

 ** [State](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-State"></a>
État actuel du registre.  
Type : String  
Valeurs valides : `CREATING | ACTIVE | DELETING | DELETED` 

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

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** InvalidParameterException **   
Un ou plusieurs paramètres de la demande ne sont pas valides.  
Code d’état HTTP : 400

 ** ResourceNotFoundException **   
La ressource spécifiée n’existe pas.  
Code d’état HTTP : 404

## consultez aussi
<a name="API_DescribeLedger_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeLedger)