Sintassi della richiesta Parametri della richiesta URI Corpo della richiesta Sintassi della risposta Elementi di risposta Errori Vedi anche

DescribeLedger

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

Sintassi della richiesta


GET /ledgers/name HTTP/1.1

Parametri della richiesta URI

La richiesta utilizza i seguenti parametri URI.

name

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

La richiesta non ha un corpo della richiesta.

Sintassi della risposta


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

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

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

Arn

L'Amazon Resource Name (ARN) per il registro.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 1600 caratteri.

CreationDateTime

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

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

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

Name