이벤트 수동 복구¶
GET /api/v1/keyevent/restore
개요¶
이벤트 연관 식별자를 기준으로 현재 워크스페이스의 모니터링 이벤트를 수동 복구하도록 요청합니다.
호출 전 및 사용 단계¶
먼저 미복구 이벤트 목록에서 df_source=monitor인 대상 이벤트와 해당 df_monitor_checker_event_ref를 가져와 monitorCheckerEventRef로 사용합니다. 이 API는 GET이지만 복구 작업을 시작하고 감사 로그를 기록하므로, 운영자가 명시적으로 트리거해야 하며 페이지 프리페치, 링크 검사 또는 자동 재시도에 포함하지 마세요. 동일한 연관 식별자 아래에서 조회된 모니터링 이벤트가 미복구 상태이면 복구 이벤트 생성을 요청합니다. content=true는 처리 흐름이 반환되었을 뿐, 대상을 조회했거나 최종적으로 복구되어 저장까지 성공했음을 의미하지 않습니다. 일치하는 레코드가 없거나 이미 복구된 경우에도 true가 반환될 수 있습니다. 이후 미복구 이벤트 목록 또는 이벤트 레코드를 다시 조회하여 최종 상태를 확인하고, 복구 중인 경우 잠시 기다린 후 다시 조회합니다. df_source=custom인 비즈니스 이벤트는 이벤트 생성을 사용하여 동일한 연관 식별자와 status=ok인 이벤트를 기록하세요. 이 API는 현재 API Key가 속한 워크스페이스를 사용하며, 워크스페이스 간 또는 사이트 간 파라미터를 선언하지 않습니다. 다른 워크스페이스나 사이트는 해당 사이트 Endpoint와 해당 워크스페이스의 API Key를 사용하여 각각 호출하세요.
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| monitorCheckerEventRef | string | Y | 트리거 대상의 이벤트 연관 식별자이며 __docid, df_event_id 또는 모니터 UUID가 아닙니다. null 허용: False 예: checkout-prod-latency획득 또는 입력 방법: 미복구 이벤트 목록에서 df_source=monitor인 레코드를 선택하고 df_monitor_checker_event_ref를 그대로 복사합니다. |
추가 파라미터 설명¶
공개 API는 monitorCheckerEventRef만 선언하며, 추가 timeRange, needRecoverIssue 또는 워크스페이스 간 파라미터를 지원하지 않습니다. 복구 조회는 쿼리 서비스의 기본 시간 범위를 사용하므로, true만으로 과거 이벤트가 복구되었다고 단정할 수 없습니다. 과거 대상은 먼저 원본 이벤트와 현재 조회 결과를 대조하세요.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/keyevent/restore' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode monitorCheckerEventRef=checkout-prod-latency
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | true는 이번 복구 처리가 반환되었음을 나타냅니다. 일치하는 이벤트를 찾지 못한 경우에도 true일 수 있으므로 최종 이벤트 상태를 계속 확인해야 합니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
알 수 없는 연관 식별자에 대해 404 반환을 보장하지 않으며, 복구 작업 ID도 반환하지 않습니다. 다운스트림이 완료되지 않은 경우 true가 먼저 반환될 수 있으므로 이벤트 상태 변화를 확인 기준으로 삼으세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 구문 분석 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인합니다. |
| 406 | ft.EventRepeatRecover | 동일한 인시던트에 이미 복구 요청이 있거나 일괄 복구 처리 중임 | 이벤트가 복구 중이므로 반복 실행하지 마세요 | 즉시 다시 제출하지 말고, 먼저 대기한 후 이미 복구되었는지 조회합니다. |
| 503 | ft.QueryServiceUnavailable | 쿼리 서비스가 일시적으로 사용할 수 없으며 실제 업스트림이 503을 반환함 | 쿼리 서비스가 일시적으로 사용할 수 없습니다. 잠시 후 다시 시도하세요 | content.retryable=true를 확인한 후 백오프하여 재시도하고, 계속 실패하면 traceId를 제공합니다. |
| 406 | ft.KodoRequestDeadlineExceeded | 이벤트 조회가 백엔드에서 허용된 실행 시간을 초과함 | 데이터 조회 시간이 초과되었습니다. 원인은 데이터 양이 너무 많거나, 네트워크 지연, 서버 부하 과다 등일 수 있습니다. 다음 방법으로 해결할 수 있습니다: 1. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 조회합니다. 2. 잠시 기다린 후 다시 조회합니다. |
현재 워크스페이스와 monitorCheckerEventRef를 확인하고 잠시 후 재시도합니다. 계속 실패하면 traceId를 제공합니다. |
| 406 | ft.KodoTooManyRows | 조회 데이터 양이 백엔드 제한을 초과함 | 조회한 데이터 양이 최대 개수 제한을 초과했습니다. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 조회하세요. | 현재 워크스페이스와 monitorCheckerEventRef를 확인하고 잠시 후 재시도합니다. 계속 실패하면 traceId를 제공합니다. |
| 429 | ft.KodoServerOverloaded | 쿼리 서비스가 혼잡하거나 과부하됨 | 현재 요청이 너무 많습니다. 잠시 후 다시 시도하세요. | 백오프 후 재시도하고 동시에 보내는 요청 수를 줄입니다. |
| 500 | ft.InternalServerError | 쿼리 연결 실패, 업스트림 서비스 이상 또는 기타 내부 오류 | 내부 오류 | 잠시 후 재시도합니다. 계속 실패하면 traceId와 마스킹된 요청을 제공합니다. |