목록 조회¶
POST /api/v1/incidents/list
개요¶
본문 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pageSize | integer | 페이지당 반환 개수 비어 있음 허용: 아니요 예시: 10 |
|
| pageIndex | integer | 페이지 번호 비어 있음 허용: 아니요 예시: 1 |
|
| timeRange | array | 시간 범위 목록(밀리초 타임스탬프) 비어 있음 허용: 아니요 예시: [1765076432000, 1766554821000] |
|
| search | string | 검색 키워드 비어 있음 허용: 아니요 예시: test |
|
| filters | array | 필터 조건 비어 있음 허용: 아니요 예시: [{'op': '=', 'field': 'level', 'value': ['system_level_1', 'system_level_0']}] |
|
| incidentsStatus | array | 인시던트 상태 필터 목록 비어 있음 허용: 아니요 예시: ['open'] |
|
| level | array | 인시던트 수준 필터 목록 비어 있음 허용: 아니요 예시: ['system_level_1', 'system_level_0'] |
|
| assigner | array | 인시던트 담당자 필터 목록, UUID 전달 비어 있음 허용: 아니요 예시: ['acnt_xxxx32'] |
|
| tags | array | 태그 필터 목록, 태그 UUID 전달 비어 있음 허용: 아니요 예시: ['tag_xxxx32'] |
|
| schedule | array | 온콜 일정 목록, 온콜 일정 UUID 전달 비어 있음 허용: 아니요 예시: ['incsch_xxxx'] |
매개변수 추가 설명¶
filters 상세 설명 리스트 filter 매개변수의 각 쿼리 조건은 세 개의 요소로 구성됩니다:
| 매개변수명 | 매개변수 유형 | 매개변수 설명 |
|---|---|---|
| filters.field | string | 필터 조건 필드 |
| filters.value | array | 필터 조건 값 목록 |
| filters.op | string | 비교 연산자 (= 같음; != 같지 않음) |
filters.field에서 현재 지원하는 필드
| 매개변수명 | 설명 |
|---|---|
| tags | 태그 |
| incidentsStatus | 인시던트 상태 ["open", "working", "resolved", "closed"] |
| level | 인시던트 수준에 해당하는 UUID |
| assigner | 담당자에 해당하는 UUID |
| schedule | 온콜 일정에 해당하는 UUID |
| host | 호스트 |
| service | 서비스 |
| resource | 리소스 |
| pod_name | Pod 이름 |
| app_name | 애플리케이션 이름 |
| env | 환경 |
| url | URL |
filters 예시
요청 예시¶
curl 'https://openapi.guance.com/api/v1/incidents/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"pageSize":10,"pageIndex":1,"filters":[{"op":"=","field":"level","value":["system_level_1","system_level_0"]}]}' \
--compressed
응답¶
{
"code": 200,
"content": {
"data": [
{
"workspaceUUID": "wksp_xxxxx",
"name": "서비스 xxxxx에서 지난 10분 동안 로그 수가 1회 비정상적으로 급증했습니다",
"level": "system_level_3",
"description": "xxxxxx",
"source": "internal",
"resourceCategory": "Monitor",
"resourceType": "checker",
"resourceUUID": "",
"resourceUrl": "",
"resourceIdentity": "xxxxxxx",
"assigner": [
"acnt_xxxxxx"
],
"incidentsStatus": "working",
"statusTime": {
"open": 1768926015,
"working": 1768973255
},
"statusChangeTime": 1768973255,
"cumulativeTime": 53474,
"eventCount": 0,
"eventUpdateAt": 1768926015,
"dimensionTag": {
"service": "xxxxxxx"
},
"extend": {},
"dtHost": "",
"dtService": "xxxxxxx",
"dtResource": "",
"dtPodName": "",
"dtAppName": "",
"dtAppId": "",
"dtEnv": "",
"dtUrl": "",
"id": 199,
"uuid": "incident_xxxxxx",
"status": 0,
"creator": "Obsy",
"updator": "acnt_xxxxxx",
"createAt": 1768926000,
"deleteAt": -1,
"updateAt": 1768973256,
"assignerInfo": [
{
"uuid": "acnt_xxxxxx",
"status": 0,
"wsAccountStatus": 0,
"username": "xxxxx",
"name": "xxxx",
"iconUrl": "",
"email": "xxxxx",
"mobile": "",
"acntWsNickname": ""
}
],
"operateRecord": {
"uuid": "incop_xxxx",
"incidentsUUID": "incident_xxxx",
"workspaceUUID": "wksp_xxxx",
"content": "담당자 변경: -> xxxx",
"extend": {
"after": [
"acnt_xxxxx"
],
"before": [],
"after_info": [
{
"name": "xxx",
"uuid": "acnt_xxxxx",
"email": "xxxx",
"mobile": "",
"status": 0,
"iconUrl": "",
"username": "xxxx",
"acntWsNickname": "",
"wsAccountStatus": 0
}
],
"before_info": []
},
"operator": "acnt_xxxx",
"operateType": "assigner_update",
"createAt": 1768973255
},
"scheduleInfo": [
{
"workspaceUUID": "wksp_xxxx",
"name": "default",
"timezone": "Asia/Shanghai",
"start": "00:00",
"end": "23:59",
"tagFilter": [],
"dimensionFilter": "",
"notifyTargets": [],
"strategyConfig": [],
"extend": {
"rotationCycle": "day",
"enableRotateNotification": false
},
"isDefault": true,
"rotationUpdateAt": 1768803347,
"id": 6952,
"uuid": "incsch_xxxx",
"status": 0,
"creator": "SYS",
"updator": "acnt_xxxx",
"createAt": 1768803072,
"deleteAt": -1,
"updateAt": 1768803347
}
]
}
],
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "xxxxx"
}