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

# Neptune 데이터플레인 엔진, 빠른 재설정 및 일반 구조 API
<a name="data-api-dp-environment-APIs"></a>

**엔진 작동:**
+ [GetEngineStatus(동작)](#GetEngineStatus)
+ [ExecuteFastReset(동작)](#ExecuteFastReset)

**엔진 작동 구조:**
+ [QueryLanguageVersion(구조)](#QueryLanguageVersion)
+ [FastResetToken(구조)](#FastResetToken)

## GetEngineStatus(동작)
<a name="GetEngineStatus"></a>

         이 API의 AWS CLI 이름은 `get-engine-status`입니다.

호스트의 그래프 데이터베이스 상태를 검색합니다.

IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:GetEngineStatus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

**요청**
+ 요청 파라미터가 없습니다.**

**응답**:
+ **dbEngineVersion** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  DB 클러스터에서 실행되는 Neptune 엔진 버전으로 설정합니다. 이 엔진 버전이 릴리스된 이후 수동으로 패치 적용된 경우 버전 번호에 `Patch-` 접두사가 붙습니다.
+ **dfeQueryEngine** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  DFE 엔진이 완전히 활성화된 경우 `enabled`로 설정하거나, `useDFE` 쿼리 힌트가 `true`로 설정된 쿼리에만 DFE 엔진을 사용하는 경우 `viaQueryHint`(기본값)로 설정합니다.
+ **features** – 다음에 해당할 때 키-값 페어의 맵 배열입니다.

      각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

      각 값은 `document`(JSON과 유사한 데이터 모델로 표현되는 프로토콜에 구애받지 않는 개방형 콘텐츠) 유형의 문서입니다.

  DB 클러스터에서 활성화된 기능에 대한 상태 정보가 들어 있습니다.
+ **gremlin** – [QueryLanguageVersion](#QueryLanguageVersion) 객체입니다.

  클러스터에서 사용할 수 있는 Gremlin 쿼리 언어에 대한 정보가 들어 있습니다. 특히 엔진에서 사용하는 현재 TinkerPop 버전을 지정하는 버전 필드가 포함되어 있습니다.
+ **labMode** – 다음에 해당할 때 키-값 페어의 맵 배열입니다.

      각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

      각 값은 String이며, 유형은`string` (UTF-8 인코딩 문자열)입니다.

  엔진에서 사용 중인 랩 모드 설정을 포함합니다.
+ **opencypher** – [QueryLanguageVersion](#QueryLanguageVersion) 객체입니다.

  클러스터에서 사용할 수 있는 openCypher 쿼리 언어에 대한 정보가 들어 있습니다. 특히 엔진에서 사용하는 현재 openCypher 버전을 지정하는 버전 필드가 포함되어 있습니다.
+ **role** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  인스턴스가 읽기 전용 복제본인 경우 `reader`로 설정하고 인스턴스가 기본 인스턴스인 경우 `writer`로 설정합니다.
+ **rollingBackTrxCount** - Integer이며, 유형은 `integer`(32비트 부호 있는 정수)입니다.

  롤백되는 트랜잭션이 있는 경우 이 필드는 해당 트랜잭션 수로 설정됩니다. 없으면 필드가 나타나지 않습니다.
+ **rollingBackTrxEarliestStartTime** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  롤백되고 있는 트랜잭션 중 최초 트랜잭션의 시작 시간으로 설정합니다. 트랜잭션이 롤백되지 않으면 필드가 나타나지 않습니다.
+ **settings** – 다음에 해당할 때 키-값 페어의 맵 배열입니다.

      각 키는 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

      각 값은 String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  DB 클러스터의 현재 설정에 대한 정보를 포함합니다. 예를 들어, 현재 클러스터 쿼리 제한 시간 설정(`clusterQueryTimeoutInMs`)을 포함합니다.
+ **sparql** – [QueryLanguageVersion](#QueryLanguageVersion) 객체입니다.

  클러스터에서 사용할 수 있는 SPARQL 쿼리 언어에 대한 정보가 들어 있습니다. 특히 엔진에서 사용하는 현재 SPARQL 버전을 지정하는 버전 필드가 포함되어 있습니다.
+ **startTime** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  현재 서버 프로세스가 시작한 UTC 시간으로 설정합니다.
+ **status** - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  인스턴스에 문제가 발생하지 않는 경우 `healthy`로 설정합니다. 인스턴스가 충돌로부터 복구 중이거나 재부팅 중이며 최근 서버 중단으로부터 실행 중인 활성 트랜잭션이 있으면 상태가 `recovery`로 설정됩니다.

**오류**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [InternalFailureException](data-api-dp-errors.md#InternalFailureException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## ExecuteFastReset(동작)
<a name="ExecuteFastReset"></a>

         이 API의 AWS CLI 이름은 `execute-fast-reset`입니다.

빠른 재설정 REST API를 사용하면 Neptune 그래프를 빠르고 쉽게 재설정하여 모든 데이터를 제거할 수 있습니다.

Neptune 빠른 재설정은 두 단계로 이루어져 있습니다. 먼저 `action`을 통해 `ExecuteFastReset`을 `initiateDatabaseReset`으로 설정하여 호출합니다. 그러면 UUID 토큰이 반환되며, 이 토큰은 `performDatabaseReset`으로 설정된 `action`을 통해 `ExecuteFastReset`을 다시 호출할 때 포함시킵니다. [빠른 재설정 API를 사용하여 Amazon Neptune DB 클러스터 비우기](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html)를 참조하세요.

IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 [neptune-db:ResetDatabase](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

**요청**
+ **action**(CLI의 경우: `--action`) - 필수: String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**

  빠른 재설정 작업입니다. 다음 값 중 하나입니다.
  + **`initiateDatabaseReset`** - 이 작업은 빠른 재설정을 실제로 수행하는 데 필요한 고유한 토큰을 생성합니다.
  + **`performDatabaseReset`** - 이 작업은 `initiateDatabaseReset` 작업으로 생성된 토큰을 사용하여 실제로 빠른 리셋을 수행합니다.

    
+ **token**(CLI의 경우: `--token`) - String, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  재설정을 시작하기 위한 빠른 재설정 토큰입니다.

**응답**:
+ **payload** – [FastResetToken](#FastResetToken) 객체입니다.

  `payload`는 `initiateDatabaseReset` 작업에 의해서만 반환되며, 재설정을 수행하기 위해 `performDatabaseReset` 작업에 사용할 고유 토큰을 포함합니다.
+ **status** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**

  `status`는 `performDatabaseReset` 작업에 대해서만 반환되며 빠른 재설정 요청의 수락 여부를 나타냅니다.

**오류**
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [AccessDeniedException](data-api-dp-errors.md#AccessDeniedException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [ServerShutdownException](data-api-dp-errors.md#ServerShutdownException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [MethodNotAllowedException](data-api-dp-errors.md#MethodNotAllowedException)
+ [ReadOnlyViolationException](data-api-dp-errors.md#ReadOnlyViolationException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [MissingParameterException](data-api-dp-errors.md#MissingParameterException)

## *엔진 작동 구조:*
<a name="data-api-dp-environment-APIs-engine-operation-structures-spacer"></a>

## QueryLanguageVersion(구조)
<a name="QueryLanguageVersion"></a>

쿼리 언어 버전을 표현하기 위한 구조입니다.

**Fields**
+ **version** - 필수: String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.**

  쿼리 언어의 버전입니다.

## FastResetToken(구조)
<a name="FastResetToken"></a>

빠른 재설정을 시작하는 데 사용되는 빠른 재설정 토큰을 포함하는 구조입니다.

**Fields**
+ **token** - String이며, 유형은 `string`(UTF-8 인코딩 문자열)입니다.

  `initiateDatabaseReset` 작업 시 데이터베이스에서 생성한 UUID로, `performDatabaseReset`에서 데이터베이스를 재설정하는 데 사용합니다.