인덱스 삭제¶
POST /api/v1/log_index_cfg/delete
개요¶
지정한 로그 인덱스를 삭제하고 소스 및 클론 관계를 처리합니다.
호출 전과 사용 단계¶
삭제는 실제 스토리지 삭제 API 또는 외부 인덱스 삭제 알림을 호출한 후 구성과 필드 매핑을 소프트 삭제합니다. 소스 A를 삭제하고 deleteCloneIndex=false인 경우, B는 UUID, 이름, 자체 구성을 유지하고 일반 인덱스로 승격되며, A/B 조건은 고급 조건으로 변환된 후 AND로 병합됩니다. 상태는 A/B의 기존 시작/중지 상태를 종합해 결정되며, 원래 일치 범위가 변경되지 않음을 보장하지 않습니다. deleteCloneIndex=true이면 캐스케이드로 B를 먼저 삭제한 다음 A를 삭제하며, 어느 단계든 실패하면 즉시 중지합니다. B를 직접 삭제하거나 B가 없으면 대상만 처리합니다.
기본 인덱스는 지원하지 않습니다. 현재 워크스페이스에서 원래 UUID가 이미 삭제된 경우 멱등적으로 성공하며, 이후 동일한 이름의 새 인덱스를 이름으로 삭제하지 않습니다. 성공 시 content=true이며 내부 승격/삭제 요약은 반환하지 않습니다. 목록/상세에서 확인하세요. 실패 시 ft.LogIndexDeleteFailed의 content에는 완료된 객체와 실패 단계가 포함됩니다. 스토리지가 삭제되었지만 구성에 실패한 경우 원래 UUID로 재시도하며, configurationState=unknown이면 먼저 구성을 확인합니다. 이미 완료된 일부 성공 객체도 감사에 기록됩니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| cfgUUID | string | Y | 이 워크스페이스 구성의 UUID로 필수이며, 이름이 아니고 default가 될 수 없습니다. null 허용: False 예시: lgim_example가져오기 또는 입력 방법: 로그 인덱스 목록에서 대상 uuid를 복사합니다. |
| deleteCloneIndex | boolean | 선택 사항, 기본값 false, JSON 불리언만 허용, 삭제 작업은 이름으로 재시도할 수 없습니다. null 허용: False 예시: false가져오기 또는 입력 방법: 소스 A와 해당 클론 B를 함께 삭제해야 하면 true, B를 유지하고 승격하려면 false입니다. |
파라미터 추가 설명¶
A/B의 일치 조건은 고급 조건으로 변환되어 AND로 B에 병합됩니다. B는 UUID, 이름 및 자체 구성을 유지하고 소스 관계를 제거합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"cfgUUID":"lgim_example","deleteCloneIndex":false}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 모두 완료되었거나 현재 워크스페이스에서 원래 UUID가 이미 삭제되어 멱등적으로 성공한 경우 true입니다. 내부 promotedClone 요약은 반환하지 않습니다. |
| 오류 content.deletedIndexes | array<object> |
스토리지와 구성이 모두 완료된 객체만 포함합니다. |
| 오류 content.deletedIndexes[].uuid | string | 완료된 구성 UUID입니다. |
| 오류 content.deletedIndexes[].name | string | 완료된 인덱스 이름입니다. |
| 오류 content.failedIndex | object | 이번에 실패한 객체입니다. |
| 오류 content.failedIndex.uuid | string | 실패한 UUID입니다. |
| 오류 content.failedIndex.name | string | 실패한 인덱스 이름입니다. |
| 오류 content.failureStage | string | storage/configuration입니다. |
| 오류 content.storageDeleted | boolean | 이번 대상의 스토리지 삭제 완료 표시입니다. |
| 오류 content.retryable | boolean | true이면 확인 후 원래 UUID로 재시도할 수 있습니다. |
| 오류 content.configurationState | string | not_attempted/not_committed/unknown. unknown인 경우 전체 구성을 확인해야 하며 status만으로 추론할 수 없습니다. |
| 오류 content.reason | string | 해당 단계의 중국어 설명입니다. |
| 오류 content.causeErrorCode | string | 업스트림 APIException의 원본 code 또는 빈 문자열이며, 위치 파악을 돕는 값으로 최상위 오류와 동일하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 타입 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아니거나 정책이 객체가 아님 | 일부 json 파일 형식 오류 | 파라미터 표에 따라 객체를 제출하고 storagePolicy는 JSON 객체를 사용합니다. |
| 400 | ft.DefaultIndexUnsupportAction | 대상이 default임 | 기본 인덱스는 이 작업을 지원하지 않습니다. | 기본 인덱스는 삭제할 수 없습니다. |
| 404 | ft.LogIndexCfgNoExists | 현재 워크스페이스에 현재 또는 삭제된 해당 UUID가 없음 | 지정한 로그 인덱스 구성이 존재하지 않습니다. | 목록에서 유효한 대상을 확인합니다. |
| 400 | ft.LogIndexCloneRelationInvalid | A/B 관계가 유효하지 않거나 동시 변경됨 | 로그 인덱스 클론 관계가 유효하지 않습니다. | 관계를 다시 읽은 후 원래 UUID로 작업합니다. |
| 429 | ft.OperationTooFrequently | 관계 잠금이 점유되었거나 만료됨 | 작업이 너무 빈번합니다. 잠시 후 다시 시도하세요. | 백오프 후 현재 관계를 확인합니다. |
| 400 | ft.LogIndexDeleteFailed | 스토리지 또는 구성 단계가 완료되지 않았으며 일부 성공 포함 | 로그 인덱스 삭제가 완료되지 않았습니다. 다시 시도하세요. | 오류 content의 completed/failed 객체와 단계를 확인하고 failedIndex.uuid로 재시도하며 traceId를 보관합니다. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 다운스트림 연결/일반 5xx 또는 필드 형태 이상 | 내부 오류 | 먼저 구성을 읽고 실제 스토리지의 현재 상태를 확인하며, 계속 실패하면 traceId를 제공합니다. 오류를 미저장 또는 즉시 반복 추가 가능으로 간주하지 않습니다. |
| 403 | ft.Forbidden | 권한이 부족하거나 현재 버전에서 해당 API를 허용하지 않음 | 작업 권한이 없습니다. | 해당 인덱스 권한이 있는 API Key와 지원 버전을 사용합니다. |