생성¶
POST /api/v1/incidents/add
개요¶
현재 워크스페이스에 인시던트를 수동으로 생성하고 연관 작업을 비동기로 발송합니다.
호출 전 및 사용 단계¶
Key에는 incidents.incidentsManage 권한이 필요합니다. 현재 API Key가 속한 워크스페이스만 조작합니다. 이 모듈의 인시던트 UUID는 인시던트 목록의 content.data[].uuid에서 가져오며, 일반적으로 incident_ 접두사를 사용합니다. 공개 엔드포인트는 workspaceUUID/workspaceUUIDs를 허용하지 않으므로, 프런트엔드/내부 인터페이스의 크로스 워크스페이스 파라미터를 그대로 적용해서는 안 됩니다.
초기 비즈니스 상태는 open으로 고정되며, 공개 요청은 assigner/incidentsStatus/resourceType을 허용하지 않습니다. 생성 후에는 수정 인터페이스로 담당자/상태를 지정해야 합니다. 이름은 중복될 수 있으며, level은 UUID만 저장하고 유효성을 검증하지 않으므로 먼저 등급을 확인해야 합니다. 현재 extend로 제출한 내용은 저장되지 않으며, dimensionTag는 객체로 전달해야 합니다.
인시던트, 첨부 파일, 태그, 작업 기록, 비동기 발송은 하나의 트랜잭션이 아니며, 첨부 파일 바인딩은 자체적으로 커밋됩니다. 500/타임아웃 시에도 본문이나 일부 첨부 파일/태그가 이미 저장되었을 수 있고, 생성 시 알림이 이미 큐에 등록되었을 수도 있습니다. 먼저 상세/목록을 다시 읽어 확인한 후 재시도 여부를 결정하세요. 생성에는 멱등 키나 이름 중복 제거가 없으므로 반복 요청 시 중복 인시던트가 생성될 수 있습니다. HTTP 성공은 인터페이스 처리가 완료되었음만 의미하며, Webhook/Agent/온콜 알림이 실제로 실행되거나 전달되었음을 보장하지 않습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| tags[*] | string | monitor/all 스코프 태그 이름 하나입니다. 예시: production가져오기 또는 입력 방법: 태그 목록에서 scope에 monitor/all이 포함된 이름을 선택하거나, 새 태그 이름을 생성할 수도 있습니다. |
|
| attachmentUUIDs[*] | string | 확인이 완료된 첨부 파일 UUID 문자열 하나입니다. 예시: att_example가져오기 또는 입력 방법: 먼저 첨부 파일 업로드로 content.attachmentUuid를 가져오고, 해당 파일이 이번 작업에서 사용할 수 있는 첨부 파일인지 확인합니다. |
|
| dimensionTag.사용자 정의 키 | string | 동적 차원 값이며 문자열을 권장합니다. 생성 시 사용자 정의 키를 지원하지만 수정 시에는 현재 적용되지 않습니다. 예시: payment가져오기 또는 입력 방법: 원본 이벤트/리소스의 차원 키와 값입니다. |
|
| extend.linkList | array | 링크 객체 배열입니다. 생성 시 extend는 무시되고, 수정 시에만 저장됩니다. 예시: [{"name": "排查手册", "link": "https://example.com/runbook"}]가져오기 또는 입력 방법: 호출자와 관련된 비즈니스 링크입니다. |
|
| extend.linkList[*].name | string | 링크 표시 이름 문자열입니다. 예시: 排查手册가져오기 또는 입력 방법: 비즈니스 링크의 표시 이름입니다. |
|
| extend.linkList[*].link | string | 링크 URL 문자열입니다. 이 인터페이스는 접근 가능 여부를 검증하지 않습니다. 예시: https://example.com/runbook가져오기 또는 입력 방법: 고객이 접근할 수 있는 링크입니다. |
|
| attachmentUUIDs | array | 배열 항목은 URL이 아닌 첨부 파일 UUID입니다. 생략하면 바인딩하지 않으며, 값이 있으면 대상에 하나씩 추가/재바인딩합니다. []는 기존 첨부 파일을 지우지 않으며 전체 교체도 아닙니다. 유효하지 않거나 삭제된 첨부 파일은 500을 유발할 수 있습니다. 이 바인딩 체인은 원본 워크스페이스/기존 연관을 안정적으로 검증하지 못하므로, 호출자는 자신이 확인한 첨부 파일만 사용하고 다른 리소스의 첨부 파일을 빌려 사용하려 해서는 안 됩니다. null 허용: False 예시: ["att_example"]가져오기 또는 입력 방법: 먼저 첨부 파일 업로드로 content.attachmentUuid를 가져오고, 해당 파일이 이번 작업에서 사용할 수 있는 첨부 파일인지 확인합니다. |
|
| description | string | 선택적 문자열 또는 null입니다. 생성 시 빈 문자열은 생략되고, 수정 시 생략하면 유지되며, 빈 문자열은 비우고, 명시적 null은 null로 저장됩니다. null 허용: True 예시: 部分请求失败가져오기 또는 입력 방법: 인시던트 현상과 조사 단서를 작성합니다. |
|
| dimensionTag | json | 생성 시 반드시 JSON 객체여야 하며 기본값은 {}입니다. host/service/resource/pod_name/app_name/app_id/env/url은 해당 인덱스 컬럼에도 함께 기록되며, 그 외 키도 저장할 수 있습니다. 루트 파라미터가 null/배열/문자열이면 공개 라우트에서 먼저 406으로 거부됩니다. 차원 값은 문자열을 권장하며, 하위 값 타입 오류를 펼치지 않으면 여전히 데이터베이스 실패가 발생할 수 있습니다. 수정 시 현재 컨트롤러가 이 파라미터를 처리하지 않으므로 제출해도 차원이나 인덱스 컬럼이 갱신되지 않습니다. null 허용: False 예시: {"service": "payment"}가져오기 또는 입력 방법: 이벤트의 차원 정보를 작성하며, 원본 서비스/리소스 데이터에서 동일한 필드 값을 우선 읽어옵니다. |
|
| extend | json | 반드시 JSON 객체여야 하며, 루트 파라미터가 null/배열/문자열이면 먼저 406으로 거부됩니다. 생성 시 현재 읽기만 하고 엔터티로 전달하지 않으므로 제출한 내용은 저장되지 않으며 응답은 보통 {}입니다. 수정 시 값이 있으면 전체 교체되고, {}는 비우며, 생략하면 유지되고, 재귀 병합되지 않습니다. 내부에 선언되지 않은 하위 필드도 이후 읽기에 영향을 주지 않도록 유효한 구조를 유지해야 합니다. null 허용: False 예시: {"linkList": [{"name": "排查手册", "link": "https://example.com/runbook"}]}가져오기 또는 입력 방법: 저장해야 할 비즈니스 확장을 호출자가 작성하며, 수정 전에 전체 상세 extend를 먼저 복사해 두세요. |
|
| level | string | Y | 생성 시 필수이며 수정 시 생략할 수 있습니다. P1 이름이 아닌 등급 UUID를 사용합니다. 현재 생성/수정 시 등급 유효성을 강제로 검증하지 않으며, 목록에 비활성화된 기본 항목이 포함될 수 있으므로 저장 성공만으로 등급이 사용 가능하다고 판단해서는 안 됩니다. null 허용: False 예시: system_level_1가져오기 또는 입력 방법: 인시던트 등급 목록에서 uuid를 가져옵니다. 백그라운드에서 전역 등급을 활성화한 경우 관리자에게 실제 적용 등급을 확인해야 합니다. |
| name | string | Y | 생성 시 필수이며 수정 시 선택 사항입니다. 선언상 최대 256자이지만 데이터베이스 컬럼은 128자이므로 1~128자 사용을 권장합니다. 현재 비어 있지 않음을 강제하지 않습니다. 수정 시 생략하면 유지되며, 빈 문자열은 비울 수 있습니다. null 허용: False 최대 길이: 256 예시: 支付服务异常가져오기 또는 입력 방법: 호출자가 식별 가능한 인시던트 제목을 제공합니다. |
| resourceURL | string | 생성 시 선택 사항이며, 생략하면 빈 문자열이고 서버가 해당 주소에 자동으로 접근하지 않습니다. 응답 필드는 resourceUrl입니다. 수정 라우트가 이 파라미터를 공개하더라도 현재 컨트롤러가 값을 할당하지 않으므로 제출해도 기존 URL이 변경되지 않습니다. null 허용: False 예시: https://example.com/runbook가져오기 또는 입력 방법: 고객이 접근할 수 있는 원본 페이지 또는 조사 매뉴얼 URL을 작성합니다. |
|
| tags | array | 기록 시 이름 배열을 사용하며, 이름 하나는 최대 128자이고 대소문자를 구분합니다. 생성 시 생략하면 태그가 없고, 수정 시 생략하면 유지되며, []는 연관을 지우고, 값을 전달하면 전체 교체됩니다. 새 태그는 monitor 스코프를 따르며, 동일한 이름의 기존 scope가 일치하지 않으면 400이 발생합니다. null 허용: False 예시: ["production"]가져오기 또는 입력 방법: 태그 목록에서 scope에 monitor/all이 포함된 이름을 선택하거나, 새 태그 이름을 생성할 수도 있습니다. |
파라미터 추가 설명¶
등급 UUID는 인시던트 등급 목록에서 가져와 활성화 여부를 확인해야 하며, 생성 시 담당자와 상태는 받지 않습니다. 현재 extend는 데이터베이스에 저장되지 않으므로, 비즈니스 링크는 생성 성공 후 수정 인터페이스로 전체 저장할 수 있습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"支付服务异常","level":"system_level_1","description":"部分请求失败","resourceURL":"https://example.com/runbook","dimensionTag":{"service":"payment"},"tags":["production"]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 데이터베이스 행 ID입니다. 비즈니스 식별에는 uuid를 사용하며, 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.uuid | string | 해당 리소스 UUID입니다. |
| content.status | integer | 데이터베이스 상태이며 0은 활성/3은 삭제입니다. 인시던트 비즈니스 상태인 incidentsStatus와 다릅니다. |
| content.creator | string | 생성 주체이며, API Key는 일반적으로 wsak_리소스UUID입니다. |
| content.updator | string | 최근 갱신 주체이며, 갱신되지 않은 경우 비어 있을 수 있습니다. |
| content.createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.updateAt | integer | Unix 초 단위 최근 갱신 시간입니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 -1입니다. |
| content.workspaceUUID | string | 인시던트가 속한 워크스페이스입니다. |
| content.name | string | 인시던트 이름입니다. |
| content.level | string | 인시던트 등급 UUID이며 system_level_0 등 또는 issl_/isslm_ 레거시 식별자입니다. 등급 표시 이름과 같지 않습니다. |
| content.description | string 또는 null | 인시던트 설명입니다. |
| content.source | string | 인시던트 소스입니다. 이 공개 수동 생성은 현재 external이며, External API 인증을 사용했다는 의미는 아닙니다. |
| content.resourceCategory | string | 원본 리소스 클래스입니다. 자동 인시던트는 소스에 따라 채워지며, 수동 생성 공개 엔드포인트는 보통 비어 있습니다. |
| content.resourceType | string | 원본 리소스 타입입니다. 집계 인시던트는 incident_aggregation이며, 수동 생성은 보통 비어 있습니다. |
| content.resourceUUID | string | 원본 리소스 UUID이며, 수동 생성은 보통 비어 있습니다. |
| content.resourceUrl | string | 저장된 원본 URL입니다. 응답 필드는 첫 글자 l이 소문자이며, 요청의 resourceURL과 다릅니다. |
| content.resourceContent | object 또는 JSON | 원본 원시 내용이며, 타입은 모니터/이벤트/집계 소스에 따라 달라집니다. 목록에서는 이 필드가 제거됩니다. |
| content.eventRelations | array<object> |
현재 인시던트 수명 주기에 연관된 이벤트 스냅샷입니다. 다시 열어 새 라운드가 시작되면 비워질 수 있습니다. |
| content.eventRelations[] | object | 원본 이벤트 연관 설명이며, 이벤트 타입에 따라 동적 필드가 반환됩니다. 이 인터페이스로 인시던트를 생성할 때 설정 가능한 객체가 아닙니다. |
| content.eventRelations[].사용자 정의 필드 | JSON | 이벤트 생산자가 저장한 연관 키-값이며, 실제 타입에 따라 먼저 읽어야 합니다. |
| content.resourceIdentity | string | 원본 집계/하위 식별자이며, 수동 생성 시 비어 있을 수 있습니다. |
| content.assigner | array<string> |
담당자 식별자 목록이며 acnt_/group_/notify_를 포함할 수 있습니다. 모든 식별자가 여전히 유효하다고 보장하지 않습니다. |
| content.assigner[] | string | 저장된 담당자/그룹/알림 대상 식별자 하나입니다. |
| content.incidentsStatus | string | 비즈니스 상태이며 open/working/resolved/closed입니다. |
| content.statusTime | object | 현재 수명 주기에 기록된 상태 시간(Unix 초)입니다. 모든 상태가 존재하는 것은 아닙니다. |
| content.statusTime.open | integer | 이번 라운드의 오픈 시간입니다. |
| content.statusTime.working | integer | 이번 라운드의 처리 진입 시간이며 생략될 수 있습니다. |
| content.statusTime.resolved | integer | 이번 라운드의 복구 시간이며 생략될 수 있습니다. |
| content.statusTime.closed | integer | 이번 라운드의 종료 시간이며 생략될 수 있습니다. |
| content.statusChangeTime | integer | 현재 수명 주기의 트리거 시간이며 재오픈 시 갱신됩니다. 매 필드 수정 시간과 동일하지 않습니다. |
| content.cumulativeTime | integer | 누적 인시던트 지속 시간(초)입니다. 상세/목록에서는 현재 상태와 결합하여 실시간 계산하며, 기록 응답은 저장된 값일 수 있습니다. |
| content.eventCount | integer | 연관 이벤트 수이며, 수동 생성은 보통 0입니다. |
| content.eventUpdateAt | integer | 원본 최근 이벤트 갱신 시간(Unix 초)이며, 수동 생성은 보통 0입니다. |
| content.dimensionTag | object | 차원 이름에서 값으로의 JSON 매핑입니다. |
| content.dimensionTag.사용자 정의 키 | JSON | 호출자 또는 원본이 저장한 차원 값이며 문자열을 권장합니다. host/service 등은 별도의 인덱스 필드가 있습니다. |
| content.extend | object 또는 JSON | 인시던트 확장 데이터입니다. 자동 소스는 집계/이벤트 등 설정을 포함할 수 있습니다. 생성 공개 엔드포인트는 현재 전달된 extend를 저장하지 않으며, 수정 시에만 전체 교체할 수 있습니다. |
| content.extend.linkList | array<object> |
비즈니스 링크 배열이며, 저장 후 표시 용도로 사용되고 이 인터페이스가 외부 URL에 접근하지는 않습니다. |
| content.extend.linkList[].name | string | 링크 표시 이름입니다. |
| content.extend.linkList[].link | string | 링크 주소입니다. |
| content.extend.aggregationRuleUUID | string | 집계 소스 규칙 UUID이며, 존재하는 경우 filters.aggregationRuleUUID에 사용할 수 있습니다. |
| content.extend.사용자 정의 필드 | JSON | 기타 저장된 소스 확장 필드이며 고정 구조를 보장하지 않습니다. 전체 교체 전에 기존 객체 전체를 복사하세요. |
| content.dtHost | string 또는 null | host 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtService | string 또는 null | service 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtResource | string 또는 null | resource 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtPodName | string 또는 null | pod_name 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtAppName | string 또는 null | app_name 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtAppId | string 또는 null | app_id 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtEnv | string 또는 null | env 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.dtUrl | string 또는 null | url 인덱스 차원이며 생성 시 dimensionTag에서 비롯됩니다. 수정 공개 엔드포인트의 dimensionTag는 현재 적용되지 않습니다. |
| content.eventRelations[].df_fault_id | string | 이벤트 수명 주기 ID이며, 이벤트의 df_fault_id 또는 호환 df_status_fault_id에서 생성됩니다. 인시던트 uuid가 아닙니다. |
| content.eventRelations[].status | string | 해당 연관 이벤트 스냅샷의 df_status 상태이며, 예를 들어 critical/ok이고 인시던트 incidentsStatus와 다릅니다. |
| content.eventRelations[].aggregationValues | object | 집계 규칙으로만 연관된 경우 존재할 수 있으며, 집계 키에서 해당 이벤트 차원 값으로의 매핑입니다. |
| content.eventRelations[].aggregationValues.집계 키 | JSON | 집계 규칙이 지정한 차원의 이벤트 내 값이며, 실제 저장 타입에 따라 읽습니다. |
| content.tagInfo | array<object> |
이번 제출 태그를 파싱한 요약입니다. 실제로 이 필드를 구성하는 응답 분기에서만 나타납니다. |
| content.tagInfo[].id | string | 호환 태그 ID이며 uuid와 같습니다. |
| content.tagInfo[].uuid | string | 태그 UUID이며, 목록 필터의 tags에 사용됩니다. 기록 시에는 name을 사용합니다. |
| content.tagInfo[].name | string | 태그 이름입니다. |
| content.tagInfo[].scope | array<string> |
유효 스코프이며, 현재 신규 생성은 monitor이고 레거시 전역은 all일 수 있습니다. |
| content.tagInfo[].scope[] | string | all/scene/monitor/dialing/security/infrastructure/catalog 중 하나입니다. |
| content.declaration | object | 현재 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"id": null,
"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",
"resourceContent": {},
"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",
"tagInfo": [
{
"id": "tag_example",
"uuid": "tag_example",
"name": "production",
"scope": [
"monitor"
]
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한, 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 타입, 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 문법이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 JSON 파일 형식 오류 | 객체를 제출합니다. |
| 400 | ft.TagScopeMismatch | 기록할 태그에 동일한 이름이 있으나 scope에 monitor/all이 포함되지 않음 | production: ['scene'] -> monitor | 모니터링 스코프 또는 전역 태그를 선택합니다. |
| 406 | ft.ExceedMaxCharacterLimit | 태그 이름이 128자를 초과함 | {} 최대 문자 길이 제한 초과 | 태그 이름을 줄입니다. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시/큐, 유효하지 않은 첨부 파일, 펼치지 않은 하위 필드 타입/레거시 비정상 구조 또는 다운스트림 미처리 예외 | 내부 오류 | 읽기 전용 요청은 백오프 후 재시도할 수 있습니다. 쓰기 요청은 인시던트/코멘트 현재 상태와 알림 기록을 먼저 읽어보세요. 이미 제출되었을 수 있으므로 중복 생성이나 중복 알림을 피해야 합니다. |