기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeLedger
상태, 권한 모드, 저장 시 암호화 설정, 생성 날짜 등 원장에 대한 정보를 반환합니다.
Request Syntax
GET /ledgers/name HTTP/1.1
URI 요청 파라미터
요청은 다음 URI 파라미터를 사용합니다.
- name
-
설명할 원장의 이름입니다.
길이 제약: 최소 길이 1. 최대 길이 32.
패턴:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$필수 사항 여부: Yes
Request Body
해당 요청에는 본문이 없습니다.
Response Syntax
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"
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- Arn
-
원장의 Amazon 리소스 이름(ARN)입니다.
타입: 문자열
길이 제약 조건: 최소 길이는 20입니다. 최대 길이는 1,600입니다.
- CreationDateTime
-
원장이 생성된 날짜와 시간(epoch 시간 형식)입니다. (epoch 시간 형식은 UTC 기준으로 1970년 1월 1일 자정 12:00:00부터 경과된 초 단위의 시간입니다.)
유형: 타임스탬프
- DeletionProtection
-
사용자에 의해 삭제되지 않도록 원장을 보호할지 여부를 지정합니다. 원장 생성 중 정의하지 않을 경우 이 기능이 기본적으로 활성화됩니다(
true).삭제 방지가 활성화된 경우 원장을 삭제하려면 먼저 이 기능을 비활성화해야 합니다.
UpdateLedger작업을 호출하여 이 파라미터를false로 설정하면 비활성화할 수 있습니다.타입: 부울
- EncryptionDescription
-
원장의 저장 데이터 암호화에 대한 정보. 여기에는 현재 상태, AWS KMS 키, 키에 액세스할 수 없게 된 시점 (오류 발생 시) 이 포함됩니다. 이 매개변수가 정의되지 않은 경우 원장은 AWS 소유한 KMS 키를 암호화에 사용합니다.
- Name
-
원장의 명칭입니다.
타입: 문자열
길이 제약: 최소 길이 1. 최대 길이 32.
패턴:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$ - PermissionsMode
-
원장의 권한 모드입니다.
타입: 문자열
유효 값:
ALLOW_ALL | STANDARD - State
-
원장의 현재 상태입니다.
타입: 문자열
유효 값:
CREATING | ACTIVE | DELETING | DELETED
Errors
모든 작업에서 발생하는 흔한 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하십시오.
- InvalidParameterException
-
요청에서 하나 이상의 파라미터가 유효하지 않습니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
지정된 리소스가 존재하지 않습니다.
HTTP 상태 코드: 404
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
