기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

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

상태, 권한 모드, 저장 시 암호화 설정, 생성 날짜 등 원장에 대한 정보를 반환합니다.

## Request Syntax
<a name="API_DescribeLedger_RequestSyntax"></a>

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

## URI 요청 파라미터
<a name="API_DescribeLedger_RequestParameters"></a>

요청은 다음 URI 파라미터를 사용합니다.

 ** [name](#API_DescribeLedger_RequestSyntax) **   <a name="qldb-DescribeLedger-request-uri-Name"></a>
설명할 원장의 이름입니다.  
길이 제약: 최소 길이 1. 최대 길이 32.  
패턴: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`   
필수 여부: 예

## Request Body
<a name="API_DescribeLedger_RequestBody"></a>

해당 요청에는 본문이 없습니다.

## Response Syntax
<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"
}
```

## 응답 요소
<a name="API_DescribeLedger_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [Arn](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Arn"></a>
원장의 Amazon 리소스 이름(ARN)입니다.  
타입: 문자열  
길이 제약 조건: 최소 길이는 20입니다. 최대 길이는 1,600입니다.

 ** [CreationDateTime](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-CreationDateTime"></a>
원장이 생성된 날짜와 시간(epoch 시간 형식)입니다. (epoch 시간 형식은 UTC 기준으로 1970년 1월 1일 자정 12:00:00부터 경과된 초 단위의 시간입니다.)  
유형: 타임스탬프

 ** [DeletionProtection](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-DeletionProtection"></a>
사용자에 의해 삭제되지 않도록 원장을 보호할지 여부를 지정합니다. 원장 생성 중 정의하지 않을 경우 이 기능이 기본적으로 활성화됩니다(`true`).  
삭제 방지가 활성화된 경우 원장을 삭제하려면 먼저 이 기능을 비활성화해야 합니다. `UpdateLedger` 작업을 호출하여 이 파라미터를 `false`로 설정하면 비활성화할 수 있습니다.  
유형: 부울

 ** [EncryptionDescription](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-EncryptionDescription"></a>
원장의 저장 데이터 암호화에 대한 정보. 여기에는 현재 상태, AWS KMS 키, 키에 액세스할 수 없게 된 시간(오류 발생 시)이 포함됩니다. 이 파라미터가 정의되지 않은 경우 원장은 암호화에 AWS 소유 KMS 키를 사용합니다.  
유형: [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md)객체

 ** [Name](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Name"></a>
원장의 명칭입니다.  
타입: 문자열  
길이 제약: 최소 길이 1. 최대 길이 32.  
패턴: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-PermissionsMode"></a>
원장의 권한 모드입니다.  
타입: 문자열  
유효 값: `ALLOW_ALL | STANDARD` 

 ** [State](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-State"></a>
원장의 현재 상태입니다.  
타입: 문자열  
유효 값: `CREATING | ACTIVE | DELETING | DELETED` 

## 오류
<a name="API_DescribeLedger_Errors"></a>

모든 작업에서 발생하는 흔한 오류에 대한 자세한 내용은 [일반적인 오류](CommonErrors.md) 섹션을 참조하세요.

 ** InvalidParameterException **   
요청에서 하나 이상의 파라미터가 유효하지 않습니다.  
HTTP 상태 코드: 400

 ** ResourceNotFoundException **   
지정된 리소스가 존재하지 않습니다.  
HTTP 상태 코드: 404

## 참고
<a name="API_DescribeLedger_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS Command Line Interface](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 Go v2용 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeLedger) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS Python용 SDK](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)