콘텐츠로 이동

인시던트 작업 기록 조회



GET /api/v1/incidents/operate/{incident_uuid}/list

개요

인시던트 작업 기록을 페이지 단위로 읽습니다.

호출 전 및 사용 단계

Key는 routine.defaultAccess 또는 incidents.incidentsQuery 중 하나와 일치해야 합니다. 현재 워크스페이스에서 읽습니다. 경로의 incident_uuid는 인시던트 목록의 content.data[].uuid에서 가져옵니다. createAt 내림차순, 동일한 경우 id 내림차순으로 페이지네이션하며, 기본값은 pageIndex=1/pageSize=10입니다. 페이지네이션 정보는 최상위 pageInfo에 있고, content는 data 배열과 declaration을 포함하는 객체입니다. 빈 목록은 인시던트 존재를 증명하지 않으며, 이 진입점은 상위 인시던트를 먼저 검증하지 않습니다.

인시던트 작업 이력을 반환하며, operateType은 생성/상태/등급/담당자/알림 에스컬레이션 등을 구분합니다. content는 현지화된 설명이며 기계적 판단 근거로 사용하지 않습니다. 구조화된 before/after 및 에스컬레이션 정보는 extend에 있습니다. 작업 기록 쓰기는 기본적으로 내결함성을 가지므로, 목록에 기록이 없다고 해서 이전에 인시던트 변경이나 알림이 발생하지 않았음을 증명해서는 안 됩니다. 조회 중 새로 추가된 기록은 오프셋 페이지네이션을 이동시키므로 uuid를 기준으로 중복을 제거하면서 계속 읽어야 하며, 고정 스냅샷으로 간주하지 않습니다.

경로 파라미터

파라미터명 유형 필수 설명
incident_uuid string Y 현재 워크스페이스 인시던트 UUID이며, 알림 이벤트 ID, SLO UUID 또는 댓글 UUID가 아닙니다.
null 허용: False
예시: incident_example
가져오기 또는 입력 방법: 인시던트 목록에서 content.data[].uuid를 가져옵니다.

요청 헤더

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

Query 요청 파라미터

파라미터명 유형 필수 설명
pageIndex integer 선택적 정수이며 기본값은 1입니다. 1 이상을 권장합니다. 현재 선언에서는 양수를 제한하지 않으므로 음수 입력 시 오류가 발생한다고 기대할 수 없습니다. 신규/변경 중에는 오프셋 페이지네이션이 이동할 수 있습니다.
null 허용: False
예시: 1
가져오기 또는 입력 방법: 첫 페이지부터 시작하여 최상위 pageInfo에 따라 다음 페이지를 이어갑니다.
pageSize integer 선택적 정수이며 기본값은 10입니다. 현재 구현에서는 최댓값을 선언하지 않았으므로 호출자는 합리적인 양수로 제한해야 하며, 0/음수는 안정적인 페이지네이션 계약으로 간주하지 않습니다.
null 허용: False
예시: 10
가져오기 또는 입력 방법: 조회량에 따라 선택하며 10~100을 권장합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/incidents/operate/incident_example/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=10

응답

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

필드 유형 설명
content object 페이지네이션 콘텐츠 객체이며, 레코드 배열은 data에, 선언은 declaration에 있습니다.
content.data array<object> 현재 페이지 레코드 배열이며, 일치하는 항목이 없으면 []입니다.
content.data[].id integer 또는 null 데이터베이스 행 ID입니다. 비즈니스 식별에는 uuid를 사용하며, 제출 전 스냅샷에서는 null일 수 있습니다.
content.data[].uuid string 해당 리소스 UUID입니다.
content.data[].status integer 데이터베이스 상태이며 0은 활성, 3은 삭제입니다. 인시던트 비즈니스 상태인 incidentsStatus와 다릅니다.
content.data[].creator string 생성 주체입니다. API Key는 일반적으로 wsak_리소스UUID입니다.
content.data[].updator string 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있을 수 있습니다.
content.data[].createAt integer Unix 초 단위 생성 시간입니다.
content.data[].updateAt integer Unix 초 단위 최근 업데이트 시간입니다.
content.data[].deleteAt integer Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 -1입니다.
content.data[].incidentsUUID string 소속 인시던트 UUID입니다.
content.data[].workspaceUUID string 소속 워크스페이스입니다.
content.data[].content string 현지화된 작업 설명입니다. 기계적 파싱을 보장하지 않으며 operateType/extend에 따라 판단합니다.
content.data[].extend object 작업 확장 정보이며 operateType에 따라 달라집니다.
content.data[].extend.before JSON 상태/등급/처리자 변경 전 값이며, 작업 유형에 따라 문자열 또는 배열일 수 있습니다.
content.data[].extend.after JSON 상태/등급/처리자 변경 후 값입니다.
content.data[].extend.source string 작업 출처이며, 기본 studio 진입점에는 이 키가 없을 수 있습니다.
content.data[].extend.사용자 정의 필드 JSON 에스컬레이션 정책 등 작업에서 전달되는 확장 메타데이터이며, 원래 값을 유지하고 요청 파라미터로 사용하지 않습니다.
content.data[].operator string 실제 작업자 계정/Key/시스템 식별자입니다.
content.data[].operateType string create/status_update/level_update/assigner_update/notify_level_update 등이며, 클라이언트는 확장 값을 호환해야 합니다.
content.data[].creatorInfo object 주체 요약이며, 해당 정보가 없으면 {}입니다.
content.data[].creatorInfo.uuid string 주체 UUID이며, 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content.data[].creatorInfo.status integer 주체 상태입니다.
content.data[].creatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태입니다. Key의 경우 Key 상태를 사용하며, 인시던트 상태가 아닙니다.
content.data[].creatorInfo.username string 로그인 이름/Key 이름/시스템 이름입니다.
content.data[].creatorInfo.name string 표시 이름이며, 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content.data[].creatorInfo.iconUrl string 아바타 URL이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].creatorInfo.email string 연락처 이메일입니다. Key 요약에서는 Key UUID일 수 있으며, 실제 수신 가능한 이메일이 아닙니다.
content.data[].creatorInfo.mobile string 연락처 휴대폰 번호이며 비어 있을 수 있습니다.
content.data[].creatorInfo.countryCode string 국가 코드이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].updatorInfo object 주체 요약이며, 해당 정보가 없으면 {}입니다.
content.data[].updatorInfo.uuid string 주체 UUID이며, 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content.data[].updatorInfo.status integer 주체 상태입니다.
content.data[].updatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태입니다. Key의 경우 Key 상태를 사용하며, 인시던트 상태가 아닙니다.
content.data[].updatorInfo.username string 로그인 이름/Key 이름/시스템 이름입니다.
content.data[].updatorInfo.name string 표시 이름이며, 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content.data[].updatorInfo.iconUrl string 아바타 URL이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].updatorInfo.email string 연락처 이메일입니다. Key 요약에서는 Key UUID일 수 있으며, 실제 수신 가능한 이메일이 아닙니다.
content.data[].updatorInfo.mobile string 연락처 휴대폰 번호이며 비어 있을 수 있습니다.
content.data[].updatorInfo.countryCode string 국가 코드이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].operatorInfo object 주체 요약이며, 해당 정보가 없으면 {}입니다.
content.data[].operatorInfo.uuid string 주체 UUID이며, 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content.data[].operatorInfo.status integer 주체 상태입니다.
content.data[].operatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태입니다. Key의 경우 Key 상태를 사용하며, 인시던트 상태가 아닙니다.
content.data[].operatorInfo.username string 로그인 이름/Key 이름/시스템 이름입니다.
content.data[].operatorInfo.name string 표시 이름이며, 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content.data[].operatorInfo.iconUrl string 아바타 URL이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].operatorInfo.email string 연락처 이메일입니다. Key 요약에서는 Key UUID일 수 있으며, 실제 수신 가능한 이메일이 아닙니다.
content.data[].operatorInfo.mobile string 연락처 휴대폰 번호이며 비어 있을 수 있습니다.
content.data[].operatorInfo.countryCode string 국가 코드이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].operatorInfo.acntWsNickname string 워크스페이스 닉네임이며, 시스템 요약에서는 생략될 수 있습니다.
content.data[].extend.before_info object 또는 array 변경 전 등급 요약 또는 처리자 요약 배열입니다. 상태 변경 시 일반적으로 {}이며, 등급 before 자체는 표시 이름입니다.
content.data[].extend.after_info object 또는 array 변경 후 등급/처리자 요약입니다. 실제 operateType과 유형에 따라 읽습니다.
content.data[].extend.schedule_name string 알림 에스컬레이션 작업의 온콜/정책 이름 요약입니다.
content.data[].extend.incidents_status string 알림 에스컬레이션 시 인시던트 비즈니스 상태입니다.
content.data[].extend.strategy_info object 알림 에스컬레이션 정책 스냅샷입니다.
content.data[].extend.strategy_info.name string 소속 일정 이름입니다.
content.data[].extend.strategy_info.strategy object 이번에 선택된 레벨 및 알림 설정 스냅샷입니다.
content.data[].extend.notify_info object 알림 대상 식별자에서 당시 대상 정보로의 매핑이며, 계정/그룹/알림 대상에 따라 형태가 다릅니다.
content.data[].extend.notify_info.대상 식별자 object 또는 string 해당 대상의 당시 이름/이메일/멤버 등 정보이며, 실제 유형에 따라 읽습니다. 성공적인 전송을 의미하지 않습니다.
content.data[].extend.is_muted boolean 인시던트 알림 음소거에 해당하면 true이며, 에스컬레이션 기록이 있더라도 실제로 전송되지 않았음을 나타냅니다.
content.data[].extend.mute_rule_info object 일치한 음소거 규칙 요약입니다.
content.data[].extend.mute_rule_info.uuid string 음소거 규칙 UUID입니다.
content.data[].extend.mute_rule_info.name string 음소거 규칙 이름입니다.
content.data[].extend.muted_notify_info object 원래 전송할 예정이었으나 음소거된 대상 정보 매핑입니다.
content.data[].extend.muted_notify_info.대상 식별자 object 또는 string 음소거된 대상 정보입니다.
content.data[].extend.strategy_info.strategy.level integer 레벨 순번이며 일반적으로 0부터 시작합니다.
content.data[].extend.strategy_info.strategy.levelUpTime integer 인시던트 상태 트리거 시간부터의 에스컬레이션 대기 시간(초)입니다.
content.data[].extend.strategy_info.strategy.incidentsLevel array<string> 적용되는 인시던트 등급 UUID 목록입니다.
content.data[].extend.strategy_info.strategy.incidentsLevel[] string 하나의 등급 UUID입니다.
content.data[].extend.strategy_info.strategy.incidentsStatus array<string> 적용되는 인시던트 상태 목록이며, 예: open/working.
content.data[].extend.strategy_info.strategy.incidentsStatus[] string 하나의 인시던트 상태입니다.
content.data[].extend.strategy_info.strategy.ifRepeatNotify boolean 반복 알림 여부입니다.
content.data[].extend.strategy_info.strategy.repeatNotifyInterval integer 반복 알림 간격(초)입니다.
content.data[].extend.strategy_info.strategy.notifyConfig array<object> 해당 레벨의 알림 설정 배열입니다.
content.data[].extend.strategy_info.strategy.notifyConfig[].notifyObjectType string 알림 대상 분류입니다. 예: member/object/group. 저장된 버전에 따라 읽습니다.
content.data[].extend.strategy_info.strategy.notifyConfig[].notifyObject array<string> 알림 대상 식별자입니다. watchkeeper는 런타임 시 현재 온콜 담당자를 의미하며, 고정 계정 UUID가 아닙니다.
content.data[].extend.strategy_info.strategy.notifyConfig[].notifyObject[] string 하나의 대상 계정/그룹/알림 대상 식별자 또는 watchkeeper입니다.
content.data[].extend.strategy_info.strategy.notifyConfig[].notifyMethod array<string> 알림 방식이며, 일반적으로 mobile 전화/message SMS/email 이메일입니다. 대상 채널은 대상 설정에 따라 실행됩니다.
content.data[].extend.strategy_info.strategy.notifyConfig[].notifyMethod[] string 하나의 알림 방식입니다.
content.declaration object 현재 워크스페이스의 공통 선언이며, data의 각 항목에 재귀적으로 삽입되지 않습니다.
pageInfo.pageIndex integer 현재 페이지이며 기본값은 1입니다.
pageInfo.pageSize integer 현재 페이지 크기이며 기본값은 10입니다.
pageInfo.count integer 현재 페이지의 항목 수입니다.
pageInfo.totalCount integer 일치하는 전체 항목 수이며, 변경 중에는 달라질 수 있습니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "uuid": "incop_example",
        "incidentsUUID": "incident_example",
        "workspaceUUID": "wksp_example",
        "content": "触发了新的故障",
        "extend": {},
        "operator": "wsak_example",
        "operateType": "create",
        "id": 123,
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "creatorInfo": {},
        "updatorInfo": {},
        "operatorInfo": {}
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반한 경우 파라미터 파싱 실패 Query 파라미터 표와 예시를 확인하십시오.
500 ft.InternalServerError 데이터베이스 읽기, 과거 객체/설정 형식 또는 연관 요약 구성 등에서 처리되지 않은 예외가 발생한 경우 내부 오류 조회 파라미터를 확인하고 traceId를 보관하십시오. 백오프 후 재시도할 수 있으며, 계속 실패하면 관리자에게 관련 이력 기록과 서비스 로그를 확인하도록 요청하십시오.

문서 평가

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