인덱스 삭제 API
인덱스 삭제 API (Delete Index API)
1.0에서 도입되었어요. delete index API 작업은 클러스터에서 하나 이상의 인덱스를 삭제해요.
경고: 인덱스 삭제는 영구적인 작업이에요. 인덱스의 모든 데이터가 사라지고 복구할 수 없어요. 인덱스를 삭제하기 전에 항상 백업이 있는지, 또는 데이터가 더 이상 필요 없는지 확인하세요.
출처: 문서
본문
엔드포인트 (Endpoints)
DELETE /{index}
경로 파라미터 (Path parameters)
다음 표는 사용 가능한 경로 파라미터를 보여줘요.
| 파라미터 | 필수 | 데이터 타입 | 설명 |
|---|---|---|---|
| index | 필수 | String | 삭제할 인덱스의 이름이에요. 단일 인덱스 이름, 쉼표로 구분된 인덱스 이름 목록, 와일드카드 표현을 지정할 수 있어요. 와일드카드 표현(*)은 열린 구체적인 인덱스와만 일치해요. 별칭으로 인덱스를 삭제할 수는 없어요. 모든 인덱스를 삭제하려면 _all 또는 *를 사용해요. _all이나 와일드카드 표현으로 모든 인덱스를 실수로 삭제하는 것을 막으려면 action.destructive_requires_name 클러스터 설정을 true로 설정해요. |
쿼리 파라미터 (Query parameters)
다음 표는 사용 가능한 쿼리 파라미터를 보여줘요. 모든 쿼리 파라미터는 선택 사항이에요.
| 파라미터 | 데이터 타입 | 설명 | 기본값 |
|---|---|---|---|
| allow_no_indices | Boolean | 어떤 인덱스와도 일치하지 않는 와일드카드를 무시할지 여부예요. false이면 와일드카드가 인덱스와 일치하지 않을 때 요청이 오류를 반환해요. |
true |
| expand_wildcards | String | 와일드카드 표현이 확장될 수 있는 인덱스 유형을 지정해요. 쉼표로 구분된 값을 지원해요. 유효한 값은 다음과 같아요. - all : 숨겨진 인덱스를 포함한 모든 인덱스와 일치해요. - open : 열린 인덱스와 일치해요. - closed : 닫힌 인덱스와 일치해요. - hidden : 숨겨진 인덱스와 일치해요. open, closed, 또는 둘 다와 함께 사용해야 해요. - none : 와일드카드 표현을 허용하지 않아요. |
open |
| ignore_unavailable | Boolean | 사용할 수 없는(없거나 닫힌) 인덱스를 무시할지 여부예요. true이면 없거나 닫힌 인덱스가 응답에 포함되지 않아요. |
false |
| cluster_manager_timeout | String | 클러스터 매니저 노드에 연결하기 위해 기다리는 시간이에요. | 30s |
| timeout | String | 응답을 기다리는 시간이에요. 제한 시간이 지나기 전에 응답이 없으면 요청이 실패하고 오류를 반환해요. | 30s |
예제: 단일 인덱스 삭제 (Example: Deleting a single index)
다음 예제 요청은 sample-index라는 단일 인덱스를 삭제해요.
예제: 여러 인덱스 삭제 (Example: Deleting multiple indexes)
다음 예제 요청은 쉼표로 구분된 목록으로 여러 인덱스를 삭제해요.
예제: 와일드카드 패턴으로 인덱스 삭제 (Example: Deleting indexes using wildcard patterns)
다음 예제 요청은 logs-2024-* 패턴과 일치하는 모든 인덱스를 삭제해요.
예제: 모든 인덱스 삭제 (Example: Deleting all indexes)
경고: 다음 작업은 굉장히 파괴적이며 클러스터의 모든 인덱스를 삭제해요. 아주 주의해서, 개발이나 테스트 환경에서만 사용하세요.
다음 예제 요청은 클러스터의 모든 인덱스를 삭제해요.
모든 인덱스를 실수로 삭제하지 않으려면 action.destructive_requires_name 클러스터 설정을 true로 설정할 수 있어요. 이 설정을 활성화하면 명시적인 인덱스 이름을 지정해야 하고, _all이나 와일드카드 패턴으로 모든 인덱스를 삭제할 수 없어요. 자세한 내용은 Index settings를 참고하세요.
예제 응답 (Example response)
delete 작업이 성공하면 OpenSearch는 다음 응답을 반환해요.
{
"acknowledged": true
}
응답 본문 필드 (Response body fields)
다음 표는 모든 응답 본문 필드를 보여줘요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
| acknowledged | Boolean | 클러스터가 delete 요청을 받았는지 여부예요. true는 인덱스가 성공적으로 삭제되었다는 뜻이에요. |
필요한 권한 (Required permissions)
Security plugin을 사용한다면 indices:admin/delete 권한이 있는지 확인하세요.