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
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
GET /ledgers/name HTTP/1.1
Paramètres de demande URI
La demande utilise les paramètres URI suivants.
- name
-
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
La demande n’a pas de corps de requête.
Syntaxe de la réponse
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
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
-
Le nom de ressource Amazon (ARN) du registre.
Type : chaîne
Contraintes de longueur : longueur minimale de 20. Longueur maximale de 1600.
- CreationDateTime
-
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
-
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
UpdateLedgerpour définir ce paramètre surfalse.Type : booléen
- EncryptionDescription
-
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
- Name
-
Nom du registre.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 32.
Modèle :
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ - PermissionsMode
-
Le mode d'autorisations du registre.
Type : chaîne
Valeurs valides :
ALLOW_ALL | STANDARD - State
-
État actuel du registre.
Type : chaîne
Valeurs valides :
CREATING | ACTIVE | DELETING | DELETED
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.
- 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
Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :
