콘텐츠로 이동

이벤트 콘텐츠 가져오기



GET /api/v1/events/{doc_id}/get

개요

이벤트 문서 ID로 현재 워크스페이스의 이벤트 원본 콘텐츠 한 건을 가져옵니다.

호출 전 및 사용 단계

미복구 이벤트 목록의 content.data[].__docid에서 doc_id를 가져오며, df_event_id 또는 df_monitor_checker_event_ref로 대체해서는 안 됩니다. 과거 이벤트의 경우 timeRange로 이벤트 시간을 포함하는 기간을 지정하는 것이 좋습니다. 성공하면 content 객체를 반환하며, 레코드를 찾지 못하면 {}이며 이벤트 ID에 따라 자동으로 404를 반환하지 않습니다. timeRange를 생략하거나 빈 문자열을 전달하면 쿼리 서비스의 기본 기간을 사용하므로 고정된 과거 범위에 의존하지 마십시오. 이 API는 현재 API Key가 속한 워크스페이스를 사용하며, 워크스페이스 간 또는 사이트 간 파라미터를 선언하지 않습니다. 다른 워크스페이스나 사이트는 해당 사이트의 Endpoint와 해당 워크스페이스의 API Key를 사용하여 각각 호출하십시오.

경로 파라미터

파라미터명 유형 필수 설명
doc_id string Y 단일 이벤트 문서 ID, 경로 파라미터입니다.
예시: DOC-EXAMPLE
가져오기 또는 입력 방법: 미복구 이벤트 목록 반환 항목의 __docid에서 복사합니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터명 유형 필수 설명
timeRange string 선택적 시간 범위이며, [시작 밀리초,종료 밀리초] 형식의 JSON 배열 문자열입니다.
null 허용: False
예시: [1785427200000, 1785430800000]
가져오기 또는 입력 방법: 대상 이벤트의 time 또는 date 밀리초 값을 기준으로 해당 시점을 포함하는 시작 및 종료 시각을 선택하고, 두 항목 배열을 문자열로 직렬화한 뒤 URL 인코딩합니다.

파라미터 추가 설명

원본 필드의 의미는 이벤트 필드 참조를 참조하십시오. timeRange는 문자열로 선언되며 서버에서 내부 JSON을 파싱합니다. 반드시 두 항목의 밀리초 배열을 전달해야 하며, 잘못된 JSON 또는 잘못된 구조는 일반 내부 오류를 반환할 수 있습니다. 목록에 추가된 isRecover, alert_time_ranges, Issue 및 인시던트 연관 필드는 상세 API의 고정 출력이 아닙니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/events/DOC-EXAMPLE/get' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'timeRange=[1785427200000,1785430800000]'

응답

HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content object 쿼리에서 반환된 이벤트 원본 필드 객체이며, 레코드가 없으면 {}입니다.
content.__docid string 이벤트 문서 ID입니다. 이벤트 상세의 경로 doc_id에 입력합니다. df_event_id 및 이벤트 연관 식별자와 다릅니다.
content.time integer 이벤트 쿼리에서 반환된 시간이며 Unix 밀리초입니다.
content.date integer 호환 시간 필드이며, 목록에서는 time과 동일한 Unix 밀리초입니다.
content.df_title string 이벤트 제목입니다.
content.df_message string 이벤트 상세 설명입니다.
content.df_status string 이벤트 상태입니다. 미복구 목록에서는 fatal, critical, error, warning, nodata이며, 상세에서는 ok, info 또는 기타 소스에서 정의한 복구 상태일 수도 있습니다.
content.df_source string 이벤트 소스입니다. 예를 들어 monitor는 모니터링 이벤트, custom은 이 모듈에서 생성한 사용자 정의 이벤트입니다.
content.df_event_id string 이벤트 고유 ID이며, 상세 경로 doc_id에는 사용하지 않습니다.
content.df_monitor_checker_event_ref string 동일한 트리거 대상의 이벤트 연관 식별자입니다. 그룹화 및 복구에 사용되며 단일 이벤트 ID로 간주할 수 없습니다.
content.df_dimension_tags string 또는 null 감지 차원 태그이며, 일반적으로 JSON 객체를 직렬화한 문자열입니다. 값이 있으면 파싱한 후 service, host 등 실제 차원을 읽을 수 있습니다.
content.df_check_range_start integer 감지 범위 시작 시간이며 Unix 초입니다. 목록에서 누락되면 0으로 보완합니다.
content.df_check_range_end integer 감지 범위 종료 시간이며 Unix 초입니다. 목록에서 누락되면 0으로 보완합니다.
content.df_fault_start_time integer 또는 null 이번 인시던트 시작 시간이며 Unix 초입니다. 소스에서 제공하는 경우에만 반환됩니다.
content.df_fault_id string 또는 null 이번 인시던트 ID이며, 일반적으로 최초 인시던트 이벤트의 df_event_id입니다.
content.df_monitor_checker string 또는 null 감지 함수 이름입니다(예: custom_metric).
content.df_monitor_checker_name string 또는 null 모니터 이름입니다.
content.df_monitor_checker_value number, string 또는 null 이벤트 발생 시의 감지 값입니다. 단위는 모니터의 메트릭 설정에 따라 결정되며 일괄적으로 밀리초로 간주할 수 없습니다.
content.df_monitor_type string 또는 null 모니터링 유형입니다(예: custom, slo, bot_obs). 통합 수집 integration_collection은 이 미복구 목록에 포함되지 않습니다.
content.df_workspace_uuid string 또는 null 이벤트 레코드의 워크스페이스 식별자입니다.
content.df_meta string, object 또는 null 소스에서 제공한 확장 메타데이터이며, 문자열은 JSON 직렬화 값일 수 있습니다. 구조는 이벤트 소스에 따라 다릅니다.
content.df_bot_obs_detail string, object 또는 null 지능형 점검 이벤트의 추가 상세 정보이며, 해당 소스가 아니면 누락될 수 있습니다.
content.df_event_detail string, object 또는 null 이벤트 소스에서 제공한 확장 상세 정보이며, 필드는 해당 모니터링 유형에 따라 제공됩니다.
content.df_is_silent boolean, number 또는 null 소스에 기록된 음소거 플래그입니다. 목록에서는 이 원시 값을 일괄적으로 boolean으로 변환하지 않습니다.
content.df_sent_target_types array, string 또는 null 소스에 기록된 알림 대상 유형이며, 소스 및 이전 레코드 형식에 따라 달라질 수 있습니다.
content.df_alert_info string, object 또는 null 소스에 기록된 알림 정보이며, 구조는 이벤트 유형에 따라 달라집니다.
content.df_monitor_checker_id string 소스에서 제공한 모니터 UUID이며, 모니터 설정을 찾는 데 사용할 수 있습니다.
content.df_monitor_id string 소스에서 제공한 알림 정책 UUID입니다.
content.df_monitor_name string 소스에서 제공한 알림 정책 이름입니다.
content.사용자 정의 필드 string, number, boolean, array, object 또는 null 이벤트에 저장된 기타 원본 필드(사용자 정의 필드 포함)입니다. 필드 이름, 구조 및 단위는 수집 소스에 따라 다르며 모든 이벤트에서 동일함을 보장하지 않습니다.
content.declaration object 또는 null 비어 있지 않은 결과에 추가되는 워크스페이스 공통 선언입니다. 빈 객체 결과에는 추가되지 않습니다.
{
  "code": 200,
  "content": {
    "__docid": "DOC-EXAMPLE",
    "time": 1785430800000,
    "date": 1785430800000,
    "df_title": "checkout-api 响应时间超过阈值",
    "df_message": "最近 5 分钟平均响应时间超过 500 ms。",
    "df_status": "critical",
    "df_source": "monitor",
    "df_event_id": "event-example",
    "df_monitor_checker_event_ref": "checkout-prod-latency",
    "df_dimension_tags": "{\"service\":\"checkout-api\",\"env\":\"production\"}",
    "df_check_range_start": 1785430500,
    "df_check_range_end": 1785430800,
    "df_fault_start_time": 1785430500,
    "df_fault_id": "event-fault-example",
    "df_monitor_checker": "custom_metric",
    "df_monitor_checker_name": "checkout-api 平均响应时间",
    "df_monitor_checker_value": 800,
    "df_monitor_type": "custom",
    "df_workspace_uuid": "wksp_example",
    "df_is_silent": false,
    "df_sent_target_types": [
      "dingtalk"
    ],
    "df_meta": "{}",
    "df_bot_obs_detail": null,
    "df_event_detail": null,
    "df_alert_info": null,
    "df_monitor_checker_id": "rul_example",
    "df_monitor_id": "monitor_example",
    "df_monitor_name": "生产服务告警",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

이벤트를 찾지 못한 경우

{
  "code": 200,
  "content": {},
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

이벤트를 찾지 못한 경우는 성공한 빈 객체입니다. 워크스페이스, 사이트, __docid 및 이벤트 시점을 포함하는 timeRange를 확인하십시오.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하십시오.
503 ft.QueryServiceUnavailable 쿼리 서비스가 일시적으로 사용할 수 없으며, 실제 업스트림이 503을 반환했습니다 쿼리 서비스를 일시적으로 사용할 수 없습니다. 나중에 다시 시도하십시오 content.retryable=true를 확인한 후 백오프하여 재시도하십시오. 계속 실패하면 traceId를 제공하십시오.
406 ft.KodoRequestDeadlineExceeded 이벤트 쿼리가 백엔드에서 허용된 실행 시간을 초과했습니다 데이터 쿼리가 시간 초과되었습니다. 다음과 같은 이유로 발생할 수 있습니다: 데이터 양이 너무 많음, 네트워크 지연, 서버 부하가 너무 높음. 다음 방법으로 이 문제를 해결할 수 있습니다:
1. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 쿼리하십시오.
2. 잠시 기다린 후 다시 쿼리하십시오.
timeRange를 줄이고 doc_id를 확인하십시오. 계속 실패하면 traceId를 제공하십시오.
406 ft.KodoTooManyRows 쿼리 데이터 양이 백엔드 제한을 초과했습니다 쿼리한 데이터 양이 최대 개수 제한을 초과했습니다. 필터 조건을 추가하거나 시간 범위를 줄인 후 다시 쿼리하십시오. timeRange를 줄이고 doc_id를 확인하십시오. 계속 실패하면 traceId를 제공하십시오.
429 ft.KodoServerOverloaded 쿼리 서비스가 혼잡하거나 과부하 상태입니다 현재 요청이 너무 빈번합니다. 나중에 다시 시도하십시오. 백오프 후 재시도하고 동시에 발생하는 요청 수를 줄이십시오.
500 ft.InternalServerError 쿼리 연결 실패, 업스트림 서비스 이상 또는 기타 내부 오류 내부 오류 나중에 다시 시도하십시오. 계속 실패하면 traceId와 마스킹된 요청을 제공하십시오.

문서 평가

이 페이지가 도움이 되었나요?