Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Mengembalikan informasi tentang buku besar, termasuk statusnya, mode izin, enkripsi pada pengaturan istirahat, dan kapan dibuat.

## Minta Sintaks
<a name="API_DescribeLedger_RequestSyntax"></a>

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

## Parameter Permintaan URI
<a name="API_DescribeLedger_RequestParameters"></a>

Permintaan menggunakan parameter URI berikut.

 ** [name](#API_DescribeLedger_RequestSyntax) **   <a name="qldb-DescribeLedger-request-uri-Name"></a>
Nama buku besar yang ingin Anda gambarkan.  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.  
Pola: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`   
Wajib: Ya

## Isi Permintaan
<a name="API_DescribeLedger_RequestBody"></a>

Permintaan tidak memiliki isi permintaan.

## Sintaks Respons
<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"
}
```

## Elemen Respons
<a name="API_DescribeLedger_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [Arn](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Arn"></a>
Nama Sumber Daya Amazon (ARN) untuk buku besar.  
Tipe: String  
Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

 ** [CreationDateTime](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-CreationDateTime"></a>
Tanggal dan waktu, dalam format waktu epoch, saat buku besar dibuat. (Format waktu zaman adalah jumlah detik yang berlalu sejak 12:00:00 1 Januari 1970 UTC.)  
Tipe: Timestamp

 ** [DeletionProtection](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-DeletionProtection"></a>
Menentukan apakah buku besar dilindungi dari dihapus oleh setiap pengguna. Jika tidak ditentukan selama pembuatan buku besar, fitur ini diaktifkan (`true`) secara default.  
Jika perlindungan penghapusan diaktifkan, Anda harus menonaktifkannya terlebih dahulu sebelum dapat menghapus buku besar. Anda dapat menonaktifkannya dengan memanggil `UpdateLedger` operasi untuk mengatur parameter ini`false`.  
Jenis: Boolean

 ** [EncryptionDescription](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-EncryptionDescription"></a>
Informasi tentang enkripsi data saat istirahat di buku besar. Ini termasuk status saat ini, AWS KMS kunci, dan ketika kunci menjadi tidak dapat diakses (dalam kasus kesalahan). Jika parameter ini tidak terdefinisi, buku besar menggunakan kunci KMS yang AWS dimiliki untuk enkripsi.  
Tipe: Objek [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md)

 ** [Name](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Name"></a>
Nama buku besar.  
Tipe: String  
Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.  
Pola: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-PermissionsMode"></a>
Mode izin buku besar.  
Tipe: String  
Nilai yang Valid: `ALLOW_ALL | STANDARD` 

 ** [State](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-State"></a>
Status buku besar saat ini.  
Tipe: String  
Nilai yang Valid: `CREATING | ACTIVE | DELETING | DELETED` 

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

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InvalidParameterException **   
Satu atau beberapa parameter dalam permintaan tidak valid.  
Kode Status HTTP: 400

 ** ResourceNotFoundException **   
Sumber daya yang ditentukan tidak ada.  
Kode Status HTTP: 404

## Lihat Juga
<a name="API_DescribeLedger_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeLedger)