인덱스 닫기 API

인덱스 닫기 API (Close Index API)

1.0에서 도입되었어요. close index API 작업은 인덱스를 닫아요. 인덱스가 닫히면 그 인덱스에 데이터를 추가하거나 인덱스 안의 데이터를 검색할 수 없게 돼요.

출처: 문서

본문

엔드포인트 (Endpoints)

POST /{index}/_close

경로 파라미터 (Path parameters)

파라미터 타입 설명
<index> String 닫을 인덱스예요. 여러 인덱스 이름을 쉼표로 구분한 목록을 쓸 수 있어요. _all 또는 *를 사용하면 모든 인덱스를 닫아요.

쿼리 파라미터 (Query parameters)

모든 파라미터는 선택 사항이에요.

파라미터 타입 설명
allow_no_indices Boolean 어떤 인덱스와도 일치하지 않는 와일드카드를 무시할지 여부예요. 기본값은 true예요.
expand_wildcards String 와일드카드 표현을 서로 다른 인덱스로 확장해요. 여러 값을 쉼표로 조합할 수 있어요. 사용 가능한 값은 all(모든 인덱스 일치), open(열린 인덱스 일치), closed(닫힌 인덱스 일치), hidden(숨겨진 인덱스 일치), none(와일드카드 표현 허용 안 함)이에요. 기본값은 open이에요.
ignore_unavailable Boolean true이면 OpenSearch가 없거나 닫힌 인덱스를 찾지 않아요. 기본값은 false예요.
wait_for_active_shards String OpenSearch가 요청을 처리하기 전에 사용 가능해야 하는 활성 샤드 수를 지정해요. 기본값은 1(프라이머리 샤드만)이에요. all 또는 양의 정수로 설정할 수 있어요. 1보다 큰 값은 복제본이 필요해요. 예를 들어 값 3을 지정하면 요청이 성공하려면 인덱스에 두 개의 복제본이 두 개의 추가 노드에 분산되어 있어야 해요.
cluster_manager_timeout Time 클러스터 매니저 노드에 연결하기 위해 얼마나 기다릴지예요. 기본값은 30s예요.
timeout Time 클러스터의 응답을 얼마나 기다릴지예요. 기본값은 30s예요.

예제 요청 (Example requests)

예제 응답 (Example response)

{
  "acknowledged": true,
  "shards_acknowledged": true,
  "indices": {
    "sample-index1": {
      "closed": true
    }
  }
}

필요한 권한 (Required permissions)

Security plugin을 사용한다면 indices:admin/close 및 indices:admin/close* 권한이 있는지 확인하세요.

더 알아보기 (Learn more)