상세¶
GET /api/v1/error_track/{issue_id}/get
개요¶
오류 처리 메타데이터를 조회하고 최초 액세스 시 초기화합니다.
호출 전 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackQuery 권한이 필요합니다. 경로에는 목록의 issue_id를 사용해야 하며, 반환값은 로컬 처리 메타데이터로 원본 error_stack 등의 텔레메트리 레코드는 포함하지 않습니다.
로컬 메타데이터를 찾지 못하면 최근 30일 EH를 조회하고 Triage, 빈 담당자로 초기화한 뒤 제출합니다. 텔레메트리가 일치하지 않거나 해당 조회가 실패하더라도 기본 객체가 생성될 수 있으며, firstTime은 현재 밀리초로 반환되고 errorType은 비어 있습니다. 이 진입점으로 실제 오류 존재 여부를 탐지할 수 없으며, 초기화 시간을 전체 이력의 최초 시각으로 간주해서도 안 됩니다.
GET이지만 최초 조회 시 로컬 메타데이터를 기록합니다. 반복/동시 요청에는 이 페이지에 공개된 멱등 키가 없습니다. duration은 주기 기반으로 계산된 호환용 초 단위 값이며 Resolved/Ignored 상태에서도 증가할 수 있습니다. statusDuration은 상태 진입 Unix 초 시각 매핑입니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_id | string | Y | 오류 집계 비즈니스 식별자로, 그대로 전달합니다. refData.uuid(isset_)나 코멘트 UUID가 아닙니다. 경로는 URL 인코딩으로 처리됩니다. 상세 인터페이스로 텔레메트리 존재 여부를 검증하지 마세요. 예: err_payment_timeout획득 또는 입력 방법: 오류 추적 목록에서 content.data[].issue_id를 가져오거나, 현재 워크스페이스 오류 센터 텔레메트리 레코드의 issue_id를 사용합니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받습니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/error_track/err_payment_timeout/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 로컬 메타데이터 및 계산/신원 요약입니다. |
| content.id | integer 또는 null | 데이터베이스 행 ID로 경로 지정에 사용하지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.uuid | string | 로컬 리소스 UUID입니다. 상세 메타데이터는 isset_, 작업 기록은 issetoper_, 코멘트는 issetcomment_입니다. |
| content.status | integer | 리소스 상태로 일반적으로 0이며, 소프트 삭제된 3은 조회에서 제외됩니다. |
| content.creator | string | 생성 주체입니다. 자동 초기화 메타데이터는 sys, Key로 기록된 주체는 wsak_입니다. |
| content.updator | string | 최근 업데이트 주체이며 업데이트가 없으면 비어 있을 수 있습니다. |
| content.createAt | integer | Unix 초 단위 생성 시각입니다. |
| content.updateAt | integer | Unix 초 단위 업데이트 시각으로, 업데이트가 없으면 -1일 수 있습니다. 값이 동일한 상태/담당자 업데이트는 갱신되지 않을 수 있습니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시각으로, 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.issueID | string | 텔레메트리 issue_id 비즈니스 식별자로 로컬 uuid와 다릅니다. |
| content.assigner | array<string> |
담당자 계정 acnt_ 또는 팀 group_입니다. 현재 저장 순서를 따르며, 빈 배열은 미할당입니다. |
| content.assigner[] | string | 개별 담당자 식별자입니다. 저장 성공만으로 계정 존재 여부나 알림 가능 여부를 판단할 수 없습니다. |
| content.issueStatus | string | Triage/Assigned/Working/Resolved/Ignored입니다. |
| content.extend | object 또는 null | 로컬 메타데이터 확장입니다. 과거의 비정상 값에 대한 내성이 필요합니다. |
| content.extend.errorType | string | 초기화 시 조회된 오류 유형입니다. 조회 실패/데이터 없음이면 비어 있을 수 있습니다. |
| content.extend.firstTime | integer | 초기화 시 최근 30일을 조회한 create_time(Unix 밀리초)입니다. 조회 실패/데이터 없음이면 현재 밀리초를 반환하며, 전체 이력의 최초 시각임을 보장하지 않습니다. |
| content.extend.statusChangeRecords | array<object> |
상태 변경 기록입니다. 각 항목은 저장 이력 순서를 따릅니다. |
| content.extend.statusChangeRecords[].status | string | 위 상태 중 하나입니다. |
| content.extend.statusChangeRecords[].time | integer | 상태 진입 시각이며 Unix 초입니다. |
| content.extend.statusChangeRecords[].operator | string | 작업 주체 UUID/시스템 식별자입니다. |
| content.extend.기타 키 | JSON | 과거에 저장된 기타 확장 키이며 고정된 실행 파라미터가 아닙니다. |
| content.duration | integer | 초 단위입니다. 과거 전체 주기의 시간 차이 합에 현재 시각에서 마지막 Triage 주기 시작점을 뺀 값을 더합니다. Resolved/Ignored에서도 계속 증가할 수 있으며 엄격한 MTTR이 아닙니다. 계산 이상 시 누락될 수 있습니다. |
| content.statusDuration | object | 최근 Triage 주기의 상태 진입 시각 매핑이며, 각 상태의 지속 초가 아닙니다. 계산 이상 시 생략될 수 있습니다. |
| content.statusDuration.상태 | integer | Triage/Assigned/Working/Resolved/Ignored 중 실제로 나타나며 증가 조건을 만족하는 Unix 초 시각입니다. |
| content.creatorInfo | object | 생성 주체 요약이며 일치 항목이 없으면 {}입니다. 시스템 주체는 필드가 계정보다 적을 수 있습니다. |
| content.updatorInfo | object | 업데이트 주체 요약이며 일치 항목이 없으면 {}입니다. |
| content.assignerInfo | array<object> |
해석 가능한 담당자 요약입니다. 유효하지 않은 계정은 나타나지 않을 수 있으며 assigner와 길이가 같음을 보장하지 않습니다. |
| content.assignerInfo[].uuid | string | 계정 또는 팀 UUID입니다. |
| content.assignerInfo[].name | string | 표시 이름입니다. 팀 요약은 uuid/name만 포함합니다. |
| content.creatorInfo.uuid | string | 주체 UUID로 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.creatorInfo.status | integer | 주체 상태입니다. |
| content.creatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. |
| content.creatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.creatorInfo.name | string | 표시 이름입니다. |
| content.creatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.creatorInfo.email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 발송 가능 여부를 보장하지 않습니다. |
| content.creatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.creatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.creatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| content.updatorInfo.uuid | string | 주체 UUID로 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.updatorInfo.status | integer | 주체 상태입니다. |
| content.updatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. |
| content.updatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.updatorInfo.name | string | 표시 이름입니다. |
| content.updatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.updatorInfo.email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 발송 가능 여부를 보장하지 않습니다. |
| content.updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.updatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.updatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| content.assignerInfo[].status | integer | 주체 상태입니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].username | string | 로그인 이름 또는 Key 이름입니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 발송 가능 여부를 보장하지 않습니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.assignerInfo[].acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. 계정 요약에만 해당하며 팀에는 이 키가 없습니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공개 선언입니다. |
{
"code": 200,
"content": {
"id": 7,
"uuid": "isset_example",
"status": 0,
"creator": "sys",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"issueID": "err_payment_timeout",
"assigner": [],
"issueStatus": "Triage",
"extend": {
"errorType": "js_error",
"firstTime": 1785427200000,
"statusChangeRecords": [
{
"status": "Triage",
"time": 1785427200,
"operator": "wsak_example"
}
]
},
"duration": 60,
"statusDuration": {
"Triage": 1785427200
},
"creatorInfo": {
"uuid": "",
"name": "SYS",
"username": "SYS",
"email": "SYS",
"status": 0,
"wsAccountStatus": 0,
"mobile": ""
},
"updatorInfo": {},
"assignerInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
공통 인증/선언 검증 외에, 자동 초기화 시 EH 조회 예외는 기본 메타데이터로 허용 처리됩니다. 200 응답만으로 텔레메트리 존재를 판단할 수 없습니다. 조회 초기화는 제출을 수행하므로 500 발생 후에는 먼저 다시 읽어 확인하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 데이터베이스 조회, 최초 메타데이터 초기화 쓰기/제출, 과거 JSON 또는 연관 요약 구성에서 처리되지 않은 예외가 발생한 경우 | 내부 오류 | 최초 GET에서 이미 메타데이터가 생성되었을 수 있습니다. 먼저 상세를 다시 읽어 확인한 뒤 백오프 재시도하고, traceId를 보관하여 관리자에게 기록 확인을 요청하세요. |