목록 조회¶
POST /api/v1/incidents/list
개요¶
현재 워크스페이스의 인시던트 및 최근 작업/온콜 매칭 요약을 페이지 단위로 조회합니다.
호출 전 및 사용 단계¶
Key는 routine.defaultAccess 또는 incidents.incidentsQuery 중 하나를 충족해야 합니다. 현재 API Key가 속한 워크스페이스만 조작합니다. 이 모듈의 인시던트 UUID는 인시던트 목록의 content.data[].uuid에서 가져오며, 일반적으로 incident_ 접두사를 사용합니다. 공개 엔드포인트는 workspaceUUID/workspaceUUIDs를 허용하지 않으므로, 프런트엔드/내부 인터페이스의 교차 워크스페이스 파라미터를 그대로 사용해서는 안 됩니다.
POST로 JSON 객체를 제출하며, {}는 생성 시간과 id 내림차순으로 나열합니다. 기본값은 pageIndex=1/pageSize=10입니다. 페이지네이션은 최상위 pageInfo에 있고, content는 객체를 유지하며, 인시던트 배열은 content.data, 공통 선언은 content.declaration에 있습니다. data 각 항목에 재귀적으로 삽입하지 않습니다. 조회 중 추가/수정은 오프셋 페이지네이션을 이동시킬 수 있으므로 uuid 기준으로 중복 제거하고, 필요하면 timeRange를 고정하십시오.
filters 트리플릿은 권장하는 필터링 방식입니다. 여러 조건은 AND로 결합되며, 일반 필드에서 동일 조건의 배열은 OR, assigner의 다중 값은 AND, tags는 연관된 항목 중 하나라도 일치하면 매칭됩니다. 최상위 incidentsStatus는 현재 데이터베이스 status에 잘못 연결되어 있고, 최상위 assigner는 이전 JSON.manager 경로를 조회하므로 비즈니스 기대와 다를 수 있습니다. 따라서 이를 생략하고 filters를 사용하십시오. 선언에 채울 수 있다고 해서 호환 필드가 신뢰할 수 있는 것은 아닙니다. project와 같은 알 수 없는 filters.field는 명확히 406을 반환하며, 알 수 없는 op는 조용히 무시될 수 있습니다. timeRange는 인시던트 활동을 포괄하는 조건이며 생성 또는 업데이트 시간만 기준으로 하지 않습니다.
목록 응답에서는 resourceContent가 제거되며 첨부 파일/metrics/upgradeInfo는 포함되지 않습니다. 이러한 항목이 필요하면 상세 인터페이스를 사용하십시오. scheduleInfo는 매칭된 구성만 나타내며 현재 근무 중이거나 알림이 전달되었음을 보장하지 않습니다. 태그만 있는 일정은 이 목록에서 임의 태그 일치로 처리되어, 상세의 모든 태그 일치와 호환성 차이가 있습니다. 일치하는 항목이 없으면 content.data=[] 및 전체 pageInfo를 반환합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| timeRange[*] | integer | 시작/종료 두 숫자 중 하나입니다. 예: 1785427200000가져오기 또는 입력 방법: 시간 선택기에서 생성된 Unix 밀리초입니다. |
|
| filters[*] | object | 하나의 필터 트리플릿입니다. field가 누락되면 지원되지 않음 오류가 발생하며, 잘못된 객체/유형은 500이 발생할 수 있습니다. 예: {"field": "incidentsStatus", "op": "=", "value": ["open", "working"]}가져오기 또는 입력 방법: filters와 동일한 출처를 사용합니다. |
|
| filters[*].field | string | 권장: tags/incidentsStatus/level/assigner/schedule/resourceType/aggregationRuleUUID 및 host/service/resource/pod_name/app_name/app_id/env/url. 앞 8개 차원은 인덱스 열에 매핑되며 project와 같은 알 수 없는 필드는 406입니다. 구현은 실제 엔터티 열도 호환하지만, 내부 열에 의존하여 고객 쿼리를 수행하지 마십시오. 예: incidentsStatus가져오기 또는 입력 방법: 비즈니스에서 필터링 가능한 필드를 선택합니다. |
|
| filters[*].op | string | 선택 가능: = 또는 !=, 생략 시 =; 다른 연산자는 사용하지 않습니다. 예: =가져오기 또는 입력 방법: 포함/제외 여부에 따라 선택합니다. |
|
| filters[*].value | array | 일반 필드의 다중 값은 OR; assigner의 여러 값은 항목별 AND(모두 포함/모두 제외); tags의 다중 값은 연관된 항목 중 하나라도 일치하면 매칭; schedule은 일정 매칭 집합 기준; 집계 규칙은 extend.aggregationRuleUUID에 해당하는 UUID를 입력합니다. 빈 배열은 작업 없음을 의미하지 않으므로 전체 조건을 생략하는 것이 좋습니다. 예: ["open", "working"]가져오기 또는 입력 방법: field에 따라 동일한 유형의 값을 입력하며, 일반적으로 문자열 배열입니다. |
|
| filters[*].value[*] | string | 하나의 문자열 값입니다. 비즈니스 상태는 open/working/resolved/closed, level은 등급 UUID, tags는 태그 UUID입니다. 예: open가져오기 또는 입력 방법: field에 따라 유효한 식별자/차원 값을 선택합니다. |
|
| incidentsStatus[*] | string | 단일 조건 문자열입니다. 의미는 상위 필드와 동일합니다. 예: open가져오기 또는 입력 방법: 비즈니스 상태가 필요한 경우 filters에서 field=incidentsStatus를 우선 사용하십시오. |
|
| level[*] | string | 단일 조건 문자열입니다. 의미는 상위 필드와 동일합니다. 예: system_level_1가져오기 또는 입력 방법: 인시던트 등급 목록에서 uuid를 가져옵니다. 백엔드에서 전역 등급을 활성화한 경우 관리자에게 실제 적용 등급을 확인해야 합니다. |
|
| assigner[*] | string | 단일 조건 문자열입니다. 의미는 상위 필드와 동일합니다. 예: acnt_example가져오기 또는 입력 방법: 멤버 목록에서 계정 UUID를 가져옵니다. 그룹/알림 대상은 해당 목록에서 가져올 수 있으며, 동일 워크스페이스 소속이고 사용 가능한지 확인하십시오. |
|
| tags[*] | string | 단일 조건 문자열입니다. 의미는 상위 필드와 동일합니다. 예: tag_example가져오기 또는 입력 방법: 태그 목록에서 uuid를 가져옵니다. tags 작성 시 이름을 사용하는 것과 구분하십시오. |
|
| schedule[*] | string | 단일 조건 문자열입니다. 의미는 상위 필드와 동일합니다. 예: incsch_example가져오기 또는 입력 방법: 온콜 일정 관리에서 일정 UUID를 가져옵니다. |
|
| assigner | array | 호환 최상위 파라미터입니다. 현재 과거 JSON 경로 $.manager를 조회하지만, 인시던트는 일반적으로 배열로 저장됩니다. 생략하고 filters.assigner로 필터링하는 것이 좋습니다. null 허용: False 예: ["acnt_example"]가져오기 또는 입력 방법: 멤버 목록에서 계정 UUID를 가져옵니다. 그룹/알림 대상은 해당 목록에서 가져올 수 있으며, 동일 워크스페이스 소속이고 사용 가능한지 확인하십시오. |
|
| filters | array | 선택적 조건 객체 배열이며, 여러 조건은 AND입니다. 동일한 일반 필드의 value 배열은 일반적으로 IN/NOT IN입니다. =와 !=만 실제 효과가 있으며 다른 op는 무시될 수 있으므로 오류 반환에 의존하지 마십시오. 최상위 incidentsStatus/assigner 호환 필드 대신 filters를 사용하는 것이 좋습니다. null 허용: False 예: [{"field": "incidentsStatus", "op": "=", "value": ["open", "working"]}]가져오기 또는 입력 방법: 이 문서에서 지원하는 필드를 기준으로 비즈니스 상태, 등급, 멤버, 태그, 온콜 또는 인시던트 차원에서 구성합니다. |
|
| incidentsStatus | array | 호환 최상위 파라미터입니다. 현재 구현에서는 비즈니스 incidentsStatus가 아닌 데이터베이스 status 열에 잘못 사용되므로 open/working 기준 필터링에 의존할 수 없습니다. 생략하고 filters를 사용하는 것이 좋습니다. null 허용: False 예: ["open"]가져오기 또는 입력 방법: 비즈니스 상태가 필요한 경우 filters에서 field=incidentsStatus를 우선 사용하십시오. |
|
| level | array | 선택적 등급 UUID 배열입니다. 여러 개는 OR이며, 생략/[]는 제한 없음입니다. null 허용: False 예: ["system_level_1"]가져오기 또는 입력 방법: 인시던트 등급 목록에서 uuid를 가져옵니다. 백엔드에서 전역 등급을 활성화한 경우 관리자에게 실제 적용 등급을 확인해야 합니다. |
|
| pageIndex | integer | 선택적 정수이며 기본값은 1입니다. >=1을 권장합니다. 현재 선언에서는 양수를 제한하지 않으므로 음수 오류에 의존할 수 없습니다. 추가/변경 중에는 오프셋 페이지네이션이 이동할 수 있습니다. null 허용: False 예: 1가져오기 또는 입력 방법: 첫 페이지부터 시작하여 최상위 pageInfo에 따라 다음 페이지를 조회합니다. |
|
| pageSize | integer | 선택적 정수이며 기본값은 10입니다. 현재 구현에는 선언된 최대값이 없으므로 호출자는 합리적인 양수를 제한해야 하며, 0/음수는 안정적인 페이지네이션 계약으로 사용하지 않습니다. null 허용: False 예: 10가져오기 또는 입력 방법: 조회량에 따라 선택하며 10~100을 권장합니다. |
|
| schedule | array | 선택적 일정 UUID 배열입니다. 일정 태그/차원 조건으로 매칭되는 인시던트를 조회한 뒤 결과를 병합합니다. 현재 교대 멤버나 알림 발송 여부로 필터링하는 것이 아니며, 일치하지 않으면 빈 목록입니다. null 허용: False 예: ["incsch_example"]가져오기 또는 입력 방법: 온콜 일정 관리에서 일정 UUID를 가져옵니다. |
|
| search | string | 선택적 이름 LIKE 포함 매칭입니다. 생략/빈 문자열은 필터링하지 않습니다. %/_는 현재 SQL 와일드카드 효과를 낼 수 있으며 전문 검색은 아닙니다. null 허용: False 예: 支付가져오기 또는 입력 방법: 인시던트 이름에 따라 키워드를 입력합니다. |
|
| tags | array | 선택적 태그 UUID 배열입니다. 연관된 태그 중 하나라도 일치하면 매칭됩니다. 생략/[]는 제한 없음이며, 일치하지 않으면 빈 목록을 반환합니다. null 허용: False 예: ["tag_example"]가져오기 또는 입력 방법: 태그 목록에서 uuid를 가져옵니다. tags 작성 시 이름을 사용하는 것과 구분하십시오. |
|
| timeRange | array | 선택적이며 길이가 정확히 2인 숫자 배열입니다. 생략/[]는 시간 필터링을 하지 않습니다. createAt<=종료 및 max(eventUpdateAt,createAt)>=시작 조건으로 필터링하며, 생성 시간만 조회하거나 updateAt으로 필터링하지 않습니다. 현재 라우트는 array만 검증하므로 길이/요소 오류 시 500이 발생할 수 있으므로 시작/종료를 먼저 검증해야 합니다. null 허용: False 예: [1785340800000, 1785427200000]가져오기 또는 입력 방법: 호출자가 인시던트 활동이 포함되는 시간 범위를 Unix 밀리초로 선택합니다. |
파라미터 추가 설명¶
filters는 =와 !=를 지원하며 여러 조건은 AND입니다. 의미가 비정상적인 최상위 호환 필드 대신 filters.incidentsStatus/assigner를 사용하십시오. 차원 host/service/resource/pod_name/app_name/app_id/env/url은 인덱스 열에 매핑되며, 집계 인시던트는 resourceType=incident_aggregation과 aggregationRuleUUID로 필터링할 수 있습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"pageIndex":1,"pageSize":10,"filters":[{"field":"incidentsStatus","op":"=","value":["open","working"]}]}'
응답¶
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[].workspaceUUID | string | 인시던트가 속한 워크스페이스입니다. |
| content.data[].name | string | 인시던트 이름입니다. |
| content.data[].level | string | 인시던트 등급 UUID이며 system_level_0 등 또는 issl_/isslm_ 과거 식별자입니다. 등급 표시 이름과 같지 않습니다. |
| content.data[].description | string 또는 null | 인시던트 설명입니다. |
| content.data[].source | string | 인시던트 소스입니다. 이 공개 API에서 수동 생성한 경우 현재 external이며, External API 인증을 사용했다는 의미는 아닙니다. |
| content.data[].resourceCategory | string | 소스 리소스 클래스입니다. 자동 인시던트는 소스에 따라 채워지며, 수동 생성 공개 엔드포인트에서는 일반적으로 비어 있습니다. |
| content.data[].resourceType | string | 소스 리소스 유형입니다. 집계 인시던트는 incident_aggregation이며, 수동 생성은 일반적으로 비어 있습니다. |
| content.data[].resourceUUID | string | 소스 리소스 UUID이며, 수동 생성은 일반적으로 비어 있습니다. |
| content.data[].resourceUrl | string | 저장된 소스 URL입니다. 응답 필드는 소문자 l로 시작하는 resourceUrl이며, 요청의 resourceURL과 다릅니다. |
| content.data[].eventRelations | array<object> |
현재 인시던트 수명 주기에 연관된 이벤트 스냅샷입니다. 다시 열어 새 라운드를 시작하면 비워질 수 있습니다. |
| content.data[].eventRelations[] | object | 소스 이벤트 연관 설명입니다. 이벤트 유형에 따라 동적 필드를 반환하며, 이 인터페이스로 인시던트를 생성할 때 구성 가능한 객체가 아닙니다. |
| content.data[].eventRelations[].사용자 정의 필드 | JSON | 이벤트 생산자가 저장한 연관 키-값입니다. 실제 유형에 따라 먼저 읽으십시오. |
| content.data[].resourceIdentity | string | 소스 집계/하위 식별자이며, 수동 생성은 비어 있을 수 있습니다. |
| content.data[].assigner | array<string> |
담당자 식별자 목록이며 acnt_/group_/notify_를 포함할 수 있습니다. 모든 식별자가 여전히 유효하다고 보장하지 않습니다. |
| content.data[].assigner[] | string | 저장된 담당자/그룹/알림 대상 식별자 하나입니다. |
| content.data[].incidentsStatus | string | 비즈니스 상태 open/working/resolved/closed입니다. |
| content.data[].statusTime | object | 현재 수명 주기에 기록된 상태 시간이며 Unix 초입니다. 모든 상태가 존재하는 것은 아닙니다. |
| content.data[].statusTime.open | integer | 이번 라운드의 오픈 시간입니다. |
| content.data[].statusTime.working | integer | 이번 라운드의 처리 시작 시간이며 생략될 수 있습니다. |
| content.data[].statusTime.resolved | integer | 이번 라운드의 복구 시간이며 생략될 수 있습니다. |
| content.data[].statusTime.closed | integer | 이번 라운드의 종료 시간이며 생략될 수 있습니다. |
| content.data[].statusChangeTime | integer | 현재 수명 주기의 트리거 시간이며, 다시 열 때 업데이트됩니다. 매 필드 수정 시간과 동일하지 않습니다. |
| content.data[].cumulativeTime | integer | 누적 인시던트 지속 시간(초)입니다. 상세/목록에서는 현재 상태와 결합해 실시간 계산하며, 응답에 기록될 때는 저장값일 수 있습니다. |
| content.data[].eventCount | integer | 연관 이벤트 수이며, 수동 생성은 일반적으로 0입니다. |
| content.data[].eventUpdateAt | integer | 소스 최근 이벤트 업데이트 시간(Unix 초)이며, 수동 생성은 일반적으로 0입니다. |
| content.data[].dimensionTag | object | 차원 이름에서 값으로의 JSON 매핑입니다. |
| content.data[].dimensionTag.사용자 정의 키 | JSON | 호출자 또는 소스가 저장한 차원 값이며 문자열을 권장합니다. host/service 등은 별도의 인덱스 필드가 있습니다. |
| content.data[].extend | object 또는 JSON | 인시던트 확장 데이터입니다. 자동 소스는 집계/이벤트 등 설정을 포함할 수 있습니다. 생성 공개 엔드포인트는 현재 전달된 extend를 저장하지 않으며, 수정 시에만 전체 교체할 수 있습니다. |
| content.data[].extend.linkList | array<object> |
비즈니스 링크 배열입니다. 저장 후 표시 용도이며, 이 인터페이스가 외부 URL에 접근하는 것은 아닙니다. |
| content.data[].extend.linkList[].name | string | 링크 표시 이름입니다. |
| content.data[].extend.linkList[].link | string | 링크 주소입니다. |
| content.data[].extend.aggregationRuleUUID | string | 집계 소스 규칙 UUID입니다. 존재하는 경우 filters.aggregationRuleUUID에 사용할 수 있습니다. |
| content.data[].extend.사용자 정의 필드 | JSON | 기타 저장된 소스 확장 필드입니다. 고정 구조를 보장하지 않으므로 전체 교체 전에 기존 객체 전체를 복사하십시오. |
| content.data[].dtHost | string 또는 null | host 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtService | string 또는 null | service 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtResource | string 또는 null | resource 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtPodName | string 또는 null | pod_name 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtAppName | string 또는 null | app_name 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtAppId | string 또는 null | app_id 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtEnv | string 또는 null | env 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].dtUrl | string 또는 null | url 인덱스 차원이며, 생성 시 dimensionTag에서 유래합니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.data[].eventRelations[].df_fault_id | string | 이벤트 수명 주기 ID이며, 이벤트 df_fault_id 또는 호환 df_status_fault_id에서 생성됩니다. 인시던트 uuid가 아닙니다. |
| content.data[].eventRelations[].status | string | 해당 연관 이벤트 스냅샷의 df_status 상태입니다. 예: critical/ok. 인시던트 incidentsStatus와 다릅니다. |
| content.data[].eventRelations[].aggregationValues | object | 집계 규칙으로만 연관된 경우 존재할 수 있으며, 집계 키에서 해당 이벤트 차원 값으로의 매핑입니다. |
| content.data[].eventRelations[].aggregationValues.집계 키 | JSON | 집계 규칙이 지정한 차원의 이벤트 내 값이며, 실제 저장 유형에 따라 읽습니다. |
| content.data[].assignerInfo | array<object> |
실제로 확인된 담당자 요약입니다. 계정은 전체 신원 필드를 포함하고, 그룹/알림 대상은 uuid/name만 포함하며, 알 수 없는 식별자는 무시될 수 있습니다. |
| content.data[].assignerInfo[].uuid | string | 주체 UUID입니다. 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다. |
| content.data[].assignerInfo[].status | integer | 주체 상태입니다. |
| content.data[].assignerInfo[].wsAccountStatus | integer | 워크스페이스 멤버 상태입니다. Key의 경우 Key 상태를 사용하며 인시던트 상태가 아닙니다. |
| content.data[].assignerInfo[].username | string | 로그인 이름/Key 이름/시스템 이름입니다. |
| content.data[].assignerInfo[].name | string | 표시 이름입니다. 시스템 AI 표시 이름은 사이트 구성을 사용합니다. |
| content.data[].assignerInfo[].iconUrl | string | 아바타 URL이며, 시스템 요약에서는 생략될 수 있습니다. |
| content.data[].assignerInfo[].email | string | 연락 이메일입니다. Key 요약에서는 Key UUID일 수 있으며 실제 발송 가능한 이메일이 아닙니다. |
| content.data[].assignerInfo[].mobile | string | 연락 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].assignerInfo[].countryCode | string | 국가 코드이며, 시스템 요약에서는 생략될 수 있습니다. |
| content.data[].assignerInfo[].acntWsNickname | string | 워크스페이스 닉네임이며, 시스템 요약에서는 생략될 수 있습니다. |
| content.data[].workspaceInfo | object | 인시던트가 속한 워크스페이스 요약입니다. |
| content.data[].workspaceInfo.uuid | string | 소속 워크스페이스 UUID입니다. |
| content.data[].workspaceInfo.name | string | 워크스페이스 이름이며, 확인할 수 없으면 비어 있을 수 있습니다. |
| content.data[].regionCode | string | 현재 사이트 코드입니다. |
| content.data[].isExternalWorkspace | boolean | 다른 워크스페이스에서 온 것인지 여부입니다. 이 OpenAPI 공개 엔드포인트는 교차 워크스페이스 대상을 받지 않으므로 일반적으로 false입니다. |
| content.data[].aggregationRuleInfo | object 또는 null | 집계 인시던트에만 부가되며, 유효한 규칙 요약 또는 null입니다. |
| content.data[].aggregationRuleInfo.uuid | string | 집계 규칙 UUID입니다. |
| content.data[].aggregationRuleInfo.name | string | 집계 규칙 이름입니다. |
| content.data[].aggregationRuleInfo.status | integer | 규칙 데이터베이스 상태입니다. |
| content.data[].scheduleInfo | array<object> |
현재 매칭된 온콜 구성 원본 요약입니다. 현재 시점에 근무자가 있거나 알림이 실제 발송되었음을 의미하지 않습니다. 상세와 목록의 태그 매칭 호환 규칙에는 차이가 있습니다. |
| content.data[].scheduleInfo[].id | integer 또는 null | 데이터베이스 행 ID입니다. 비즈니스 식별에는 uuid를 사용하며, 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.data[].scheduleInfo[].uuid | string | 해당 리소스 UUID입니다. |
| content.data[].scheduleInfo[].status | integer | 데이터베이스 상태이며 0은 활성/3은 삭제입니다. 인시던트 비즈니스 상태 incidentsStatus와 다릅니다. |
| content.data[].scheduleInfo[].creator | string | 생성 주체이며, API Key는 일반적으로 wsak_리소스UUID입니다. |
| content.data[].scheduleInfo[].updator | string | 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있을 수 있습니다. |
| content.data[].scheduleInfo[].createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.data[].scheduleInfo[].updateAt | integer | Unix 초 단위 최근 업데이트 시간입니다. |
| content.data[].scheduleInfo[].deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].scheduleInfo[].workspaceUUID | string | 소속 워크스페이스입니다. |
| content.data[].scheduleInfo[].name | string | 온콜 이름입니다. |
| content.data[].scheduleInfo[].timezone | string | IANA 시간대입니다. |
| content.data[].scheduleInfo[].start | string | 호환되는 일일 근무 시작 시각 HH:MM이며, 일정 timezone에 따라 해석됩니다. 날짜나 Unix 시간이 아닙니다. |
| content.data[].scheduleInfo[].end | string | 호환되는 일일 근무 종료 시각 HH:MM입니다. 유효 날짜 경계는 extend.effectiveTime을 참조하십시오. |
| content.data[].scheduleInfo[].tagFilter | array<string> |
매칭 태그 UUID 배열입니다. |
| content.data[].scheduleInfo[].tagFilter[] | string | 태그 UUID입니다. |
| content.data[].scheduleInfo[].dimensionFilter | string | 차원 매칭 조회 표현식입니다. |
| content.data[].scheduleInfo[].notifyTargets | array<string> |
알림 대상 식별자 목록입니다. |
| content.data[].scheduleInfo[].notifyTargets[] | string | 계정/그룹/알림 대상 등 대상 식별자입니다. |
| content.data[].scheduleInfo[].strategyConfig | array<object> |
에스컬레이션 정책 구성이며, 워크스페이스에 저장된 버전에 따라 읽습니다. |
| content.data[].scheduleInfo[].strategyConfig[] | object | 구성 정책 하나입니다. 인시던트 조회 인터페이스는 실행 미리보기를 펼치지 않습니다. |
| content.data[].scheduleInfo[].strategyConfig[].사용자 정의 필드 | JSON | 저장된 정책 레벨/대기/알림 구성입니다. 전체 비즈니스 구성은 온콜 관리에서 읽으십시오. |
| content.data[].scheduleInfo[].extend | object | 교대/순환 등 확장 구성입니다. |
| content.data[].scheduleInfo[].extend.사용자 정의 필드 | JSON | 저장된 온콜 확장 키-값이며, 이 인터페이스로 수정할 수 없습니다. |
| content.data[].scheduleInfo[].isDefault | boolean | 기본 온콜 여부입니다. |
| content.data[].scheduleInfo[].rotationUpdateAt | integer | 순환 변경 Unix 초 시간이며, 과거 데이터는 -1일 수 있습니다. |
| content.data[].scheduleInfo[].agentUUIDs | array<string> |
확장의 연관 Agent UUID 배열입니다. |
| content.data[].scheduleInfo[].agentUUIDs[] | string | Agent UUID 하나입니다. |
| content.data[].scheduleInfo[].strategyConfig[].uuid | string | 정책 UUID입니다. |
| content.data[].scheduleInfo[].strategyConfig[].name | string | 정책 이름입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy | array<object> |
해당 정책의 에스컬레이션 레벨 구성 배열입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].level | integer | 레벨 순번이며 일반적으로 0부터 시작합니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].levelUpTime | integer | 인시던트 상태 트리거 시간부터의 에스컬레이션 대기 초입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsLevel | array<string> |
적용되는 인시던트 등급 UUID 목록입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsLevel[] | string | 등급 UUID 하나입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsStatus | array<string> |
적용되는 인시던트 상태 목록입니다. 예: open/working. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsStatus[] | string | 인시던트 상태 하나입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].ifRepeatNotify | boolean | 반복 알림 여부입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].repeatNotifyInterval | integer | 반복 알림 간격(초)입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig | array<object> |
해당 레벨의 알림 구성 배열입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObjectType | string | 알림 대상 분류입니다. 예: member/object/group. 저장된 버전에 따라 읽습니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObject | array<string> |
알림 대상 식별자입니다. watchkeeper는 런타임 현재 온콜 담당자를 의미하며 고정 계정 UUID가 아닙니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObject[] | string | 대상 계정/그룹/알림 대상 식별자 또는 watchkeeper 하나입니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyMethod | array<string> |
알림 방식입니다. 일반적으로 mobile 전화/message SMS/email 이메일이며, 객체 채널은 객체 구성에 따라 실행됩니다. |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyMethod[] | string | 알림 방식 하나입니다. |
| content.data[].scheduleInfo[].extend.enableRotateNotification | boolean | 알림 대상 순환 여부입니다. |
| content.data[].scheduleInfo[].extend.rotationCycle | string | day/week/month/workDay/weekend/customDay/customWeek 중 하나이며, 과거 데이터에서는 생략될 수 있습니다. |
| content.data[].scheduleInfo[].extend.rotationInterval | integer | customDay 순환 간격 일수 1~31, customWeek 주 수 1~4입니다. |
| content.data[].scheduleInfo[].extend.effectiveTime | object | 일정 유효 기간 구성입니다. |
| content.data[].scheduleInfo[].extend.effectiveTime.start | integer | 저장된 유효 시작 Unix 초이며, 기본값은 시작 제한 없음입니다. |
| content.data[].scheduleInfo[].extend.effectiveTime.end | integer | 저장된 유효 종료 Unix 초이며, 기본값은 종료 제한 없음입니다. |
| content.data[].scheduleInfo[].extend.workTime | object | 근무 시간 구성입니다. 기본값이 없으면 호환 start/end와 순환 주기에서 유도합니다. |
| content.data[].scheduleInfo[].extend.workTime.mode | string | allDay 종일 또는 specificTimes 지정 시간입니다. |
| content.data[].scheduleInfo[].extend.workTime.periods | array<object> |
지정 근무 시간대 배열입니다. |
| content.data[].scheduleInfo[].extend.workTime.periods[].weekdays | array<integer> |
적용 요일 1 월요일~7 일요일입니다. |
| content.data[].scheduleInfo[].extend.workTime.periods[].weekdays[] | integer | 1~7 중 하나입니다. |
| content.data[].scheduleInfo[].extend.workTime.periods[].start | string | 현지 일자 시작 HH:MM입니다. |
| content.data[].scheduleInfo[].extend.workTime.periods[].end | string | 현지 일자 종료 HH:MM입니다. |
| content.data[].scheduleInfo[].extend.agentUUIDs | array<string> |
연관 Agent UUID입니다. 엔터티에는 별도 최상위 agentUUIDs 투영이 있습니다. |
| content.data[].scheduleInfo[].extend.agentUUIDs[] | string | Agent UUID 하나입니다. |
| content.data[].operateRecord | object | 최근 작업 기록 요약입니다. 기록이 없어도 operatorInfo={}가 있을 수 있습니다. |
| content.data[].operateRecord.uuid | string | 작업 기록 UUID입니다. |
| content.data[].operateRecord.createAt | integer | 기록 Unix 초 시간입니다. |
| content.data[].operateRecord.incidentsUUID | string | 소속 인시던트 UUID입니다. |
| content.data[].operateRecord.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.data[].operateRecord.content | string | 현지화된 작업 설명입니다. 기계 파싱 가능성을 보장하지 않으므로 operateType/extend로 판단하십시오. |
| content.data[].operateRecord.extend | object | 작업 확장이며 operateType에 따라 달라집니다. |
| content.data[].operateRecord.extend.before | JSON | 상태/등급/담당자 변경 전 값입니다. 작업 유형에 따라 문자열 또는 배열일 수 있습니다. |
| content.data[].operateRecord.extend.after | JSON | 상태/등급/담당자 변경 후 값입니다. |
| content.data[].operateRecord.extend.source | string | 작업 소스입니다. 기본 studio 진입점에는 이 키가 없을 수 있습니다. |
| content.data[].operateRecord.extend.사용자 정의 필드 | JSON | 에스컬레이션 정책 등의 작업이 함께 전달하는 확장 메타데이터이며, 원래 값을 유지하고 요청 파라미터로 사용하지 않습니다. |
| content.data[].operateRecord.operator | string | 실제 작업자 계정/Key/시스템 식별자입니다. |
| content.data[].operateRecord.operateType | string | create/status_update/level_update/assigner_update/notify_level_update 등이며, 클라이언트는 확장을 호환해야 합니다. |
| content.data[].operateRecord.operatorInfo | object | 주체 요약이며, 해당 정보가 없으면 {}입니다. |
| content.data[].operateRecord.operatorInfo.uuid | string | 주체 UUID입니다. 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다. |
| content.data[].operateRecord.operatorInfo.status | integer | 주체 상태입니다. |
| content.data[].operateRecord.operatorInfo.wsAccountStatus | integer | 워크스페이스 멤버 상태입니다. Key의 경우 Key 상태를 사용하며 인시던트 상태가 아닙니다. |
| content.data[].operateRecord.operatorInfo.username | string | 로그인 이름/Key 이름/시스템 이름입니다. |
| content.data[].operateRecord.operatorInfo.name | string | 표시 이름입니다. 시스템 AI 표시 이름은 사이트 구성을 사용합니다. |
| content.data[].operateRecord.operatorInfo.iconUrl | string | 아바타 URL이며, 시스템 요약에서는 생략될 수 있습니다. |
| content.data[].operateRecord.operatorInfo.email | string | 연락 이메일입니다. Key 요약에서는 Key UUID일 수 있으며 실제 발송 가능한 이메일이 아닙니다. |
| content.data[].operateRecord.operatorInfo.mobile | string | 연락 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].operateRecord.operatorInfo.countryCode | string | 국가 코드이며, 시스템 요약에서는 생략될 수 있습니다. |
| content.data[].operateRecord.operatorInfo.acntWsNickname | string | 워크스페이스 닉네임이며, 시스템 요약에서는 생략될 수 있습니다. |
| content.data[].operateRecord.extend.before_info | object 또는 array | 변경 전 등급 요약 또는 담당자 요약 배열입니다. 상태 변경은 일반적으로 {}이며, 등급 before 자체는 표시 이름입니다. |
| content.data[].operateRecord.extend.after_info | object 또는 array | 변경 후 등급/담당자 요약입니다. 실제 operateType과 유형에 따라 읽습니다. |
| content.data[].operateRecord.extend.schedule_name | string | 알림 에스컬레이션 작업의 온콜/정책 이름 요약입니다. |
| content.data[].operateRecord.extend.incidents_status | string | 알림 에스컬레이션 시 인시던트 비즈니스 상태입니다. |
| content.data[].operateRecord.extend.strategy_info | object | 알림 에스컬레이션 정책 스냅샷입니다. |
| content.data[].operateRecord.extend.strategy_info.name | string | 소속 일정 이름입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy | object | 이번에 선택된 레벨 및 알림 구성 스냅샷입니다. |
| content.data[].operateRecord.extend.notify_info | object | 알림 대상 식별자에서 당시 대상 정보로의 매핑입니다. 계정/그룹/알림 대상의 형태가 다릅니다. |
| content.data[].operateRecord.extend.notify_info.대상 식별자 | object 또는 string | 해당 대상의 당시 이름/이메일/멤버 등 정보이며 실제 유형에 따라 읽습니다. 성공적 전달을 의미하지 않습니다. |
| content.data[].operateRecord.extend.is_muted | boolean | 인시던트 알림 음소거에 해당하면 true이며, 에스컬레이션 기록이 있어도 실제로는 전송되지 않았습니다. |
| content.data[].operateRecord.extend.mute_rule_info | object | 일치한 음소거 규칙 요약입니다. |
| content.data[].operateRecord.extend.mute_rule_info.uuid | string | 음소거 규칙 UUID입니다. |
| content.data[].operateRecord.extend.mute_rule_info.name | string | 음소거 규칙 이름입니다. |
| content.data[].operateRecord.extend.muted_notify_info | object | 원래 발송 예정이었으나 음소거된 대상 정보 매핑입니다. |
| content.data[].operateRecord.extend.muted_notify_info.대상 식별자 | object 또는 string | 음소거된 대상 정보입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.level | integer | 레벨 순번이며 일반적으로 0부터 시작합니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.levelUpTime | integer | 인시던트 상태 트리거 시간부터의 에스컬레이션 대기 초입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsLevel | array<string> |
적용되는 인시던트 등급 UUID 목록입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsLevel[] | string | 등급 UUID 하나입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsStatus | array<string> |
적용되는 인시던트 상태 목록입니다. 예: open/working. |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsStatus[] | string | 인시던트 상태 하나입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.ifRepeatNotify | boolean | 반복 알림 여부입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.repeatNotifyInterval | integer | 반복 알림 간격(초)입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig | array<object> |
해당 레벨의 알림 구성 배열입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObjectType | string | 알림 대상 분류입니다. 예: member/object/group. 저장된 버전에 따라 읽습니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObject | array<string> |
알림 대상 식별자입니다. watchkeeper는 런타임 현재 온콜 담당자를 의미하며 고정 계정 UUID가 아닙니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObject[] | string | 대상 계정/그룹/알림 대상 식별자 또는 watchkeeper 하나입니다. |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyMethod | array<string> |
알림 방식입니다. 일반적으로 mobile 전화/message SMS/email 이메일이며, 객체 채널은 객체 구성에 따라 실행됩니다. |
| content.data[].operateRecord.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": [
{
"id": 123,
"uuid": "incident_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支付服务异常",
"level": "system_level_1",
"description": "部分请求失败",
"source": "external",
"resourceCategory": "",
"resourceType": "",
"resourceUUID": "",
"resourceUrl": "https://example.com/runbook",
"eventRelations": [],
"resourceIdentity": "",
"assigner": [],
"incidentsStatus": "open",
"statusTime": {
"open": 1785427200
},
"statusChangeTime": 1785427200,
"cumulativeTime": 0,
"eventCount": 0,
"eventUpdateAt": 0,
"dimensionTag": {
"service": "payment"
},
"extend": {},
"dtHost": "",
"dtResource": "",
"dtPodName": "",
"dtAppName": "",
"dtAppId": "",
"dtEnv": "",
"dtUrl": "",
"dtService": "payment",
"assignerInfo": [],
"operateRecord": {
"operatorInfo": {}
},
"scheduleInfo": [],
"workspaceInfo": {
"uuid": "wksp_example",
"name": "生产空间"
},
"regionCode": "site_example",
"isExternalWorkspace": false
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 객체를 제출합니다. |
| 406 | ft.IncidentsFilterFieldNotSupported | filters.field가 지원되는 특수 필드/차원 또는 모델 열이 아님. 예: project | project 필드로 인시던트 목록 조회를 아직 지원하지 않음 | 이 문서에서 지원하는 필드로 변경합니다. |
| 500 | ft.InternalServerError | 데이터베이스 읽기, 과거 객체/구성 형식 또는 연관 요약 구성 등에서 처리되지 않은 예외 | 내부 오류 | 조회 파라미터를 확인하고 traceId를 보존합니다. 백오프 후 재시도할 수 있으며, 계속 실패하면 관리자에게 관련 과거 기록과 서비스 로그 점검을 요청하십시오. |