조회¶
GET /api/v1/issue/{issue_uuid}/get
개요¶
Issue UUID로 이슈 상세, 담당자, 등급, 바인딩된 첨부 파일 및 채널을 조회합니다.
호출 전 및 사용 단계¶
사이트 수준 External 자격 증명을 사용하며(인증은 External API 서명 인증 참고), Issue UUID로 전체 사이트에서 소속 워크스페이스를 조회합니다. 워크스페이스 OpenAPI Key 범위의 인터페이스가 아닙니다. 해당 데이터 범위 권한이 있는 External 자격 증명만 신뢰할 수 있는 통합에 제공하세요. 먼저 Issue 페이지/생성 응답에서 uuid를 확보합니다. content.levelInfo와 managerInfos는 표시 정보로 해석합니다. 과거 등급은 현재 쓰기 가능한 유효 목록에 없을 수 있으므로, 이후 등급을 수정할 때는 반드시 유효 등급 목록을 다시 조회해야 합니다. extend.channels/members.exists는 전체 사이트의 삭제되지 않은 레코드만 확인하며, 대상 워크스페이스의 유효 권한과 같지 않습니다. 조회는 Issue를 수정하지 않으며 이번 수정 알림을 트리거하지 않습니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_uuid | string | Y | 필수 Issue UUID로, 일반적으로 issue_ 접두사를 가지며 이벤트 UUID나 채널 UUID가 아닙니다. 이 External 진입점은 workspaceUUID가 필요하지 않으며 Issue 자체에서 소속 워크스페이스를 가져옵니다. 예시: issue_example001확인 또는 입력 방법: 대상 사이트의 기존 Issue 상세 URL, 생성 결과 content.uuid 또는 읽기 권한이 있는 Issue 목록에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 원본 경로 및 요청 본문 서명 버전입니다. 생략한 후 이 페이지의 알고리즘을 계속 사용할 수 없습니다. 예시: v20240417확인 또는 입력 방법: 이 페이지의 예시는 이 고정 버전을 사용하며 예시 서명 알고리즘과 함께 구성됩니다. |
|
| X-Df-Access-Key | string | Y | 읽기 인터페이스는 r 또는 w 자격 증명을 사용할 수 있고, 쓰기 인터페이스는 w 자격 증명이 필요합니다. 예시: <external-access-key>확인 또는 입력 방법: 사이트 관리자가 할당한 External API AK를 사용하며, 워크스페이스 OpenAPI Key는 사용할 수 없습니다. |
| X-Df-Nonce | string | Y | 임시 일련번호입니다. 실패 후 재전송할 때도 새 값을 생성하고 서명을 다시 계산합니다. 예시: 97d275ee9f774315a7885ba7347acbd9확인 또는 입력 방법: 요청마다 uuid.uuid4().hex를 새로 생성합니다. |
| X-Df-Signature | string | Y | 대문자 메서드, nonce, 원본 전체 경로, timestamp 및 원본 UTF-8 요청 본문을 공백으로 연결한 뒤 HMAC-SHA256을 수행하고 hex 다이제스트를 취합니다. 예시: <hmac-sha256-hex>확인 또는 입력 방법: External API 서명 인증에 따라 함께 제공된 SK로 계산하며, 전체 실행 가능한 템플릿은 아래를 참고하세요. |
| X-Df-Timestamp | string | Y | 사이트에 구성된 서명 유효 시간 범위 내에 있어야 하며 예시 시간을 재사용할 수 없습니다. 예시: 1785427200확인 또는 입력 방법: 전송 시 str(int(time.time()))으로 현재 Unix 초 문자열을 생성합니다. |
파라미터 추가 설명¶
수정은 Issue 수정을 참고하고, 쓰기 가능한 등급은 유효 등급 목록에서 가져옵니다(query.workspaceUUID는 본 응답의 content.workspaceUUID 사용). 본 경로에서 존재하지 않거나 삭제된 Issue는 현재 500을 반환할 수 있으며, 다른 진입점의 404 계약으로 추론하지 않습니다.
요청 예시¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 대상 사이트 주소 및 관리자가 할당한 External API AK/SK로 교체합니다.
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'GET'
path = '/api/v1/issue/issue_example001/get'
query = {}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
응답¶
HTTP200, application/json 표준 External 외부 셸이며, content는 Issue 및 해당 부가 자료이고 OpenAPI declaration에 자동으로 포함되지 않습니다. 필드는 이력 출처/확장 설정에 따라 동적으로 나타납니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 저장된 Issue 레코드 일련번호이며, 작업에는 uuid를 사용합니다. |
| content.uuid | string | 리소스 UUID. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID. |
| content.status | integer | 레코드 상태. 0 정상, 3 삭제됨. Issue 비즈니스 상태 statusType과 구분합니다. |
| content.creator | string | Issue의 실제 생성 주체이며 extend.extra 표시 정보에 따라 변경되지 않습니다. |
| content.updator | string | 최근 갱신 주체. External 수정은 SYS이며, 갱신되지 않은 경우 비어 있을 수 있습니다. |
| content.createAt | integer | 생성 시간, Unix 초. |
| content.updateAt | integer | 최근 갱신 시간, Unix 초. 갱신되지 않은 경우 -1일 수 있습니다. |
| content.deleteAt | integer | 삭제 시간, Unix 초. 삭제되지 않은 경우 -1. |
| content.name | string | Issue 제목. |
| content.level | string | 등급 UUID로, 빈 문자열은 미지정을 의미할 수 있습니다. 등급 이름이 아닙니다. |
| content.statusType | integer | 상태: 10 Open, 15 Working, 20 Resolved, 25 Closed, 30 Pending. |
| content.statusTypeUpdateRecord | array<string> |
상태 변경 이력으로, 각 항목은 Unix초&&상태 이름 형식입니다. |
| content.statusTypeUpdateRecord[] | string | 단일 상태 변경 기록. |
| content.description | string | Issue 설명. |
| content.resourceType | string | 출처 유형(예: event, dashboard, viewer)이며, 자동 생성 시 checker, keyeventAutoDiscovery 등일 수도 있습니다. |
| content.resourceUUID | string | 연관 출처 식별자로, 구체적 의미는 출처 유형에 따라 달라집니다. |
| content.resource | string | 출처 모듈 또는 이름(예: LOG, TRACING, EVENTS, RUM). |
| content.repeatType | string | 자동 발견 문제의 반복 유형으로 new, repeat, regression일 수 있으며, 수동 생성 시 비어 있을 수 있습니다. |
| content.subIdentify | string | 출처에서 정의한 연관 하위 식별자이며, 수동 생성 시 일반적으로 비어 있습니다. |
| content.resolveAt | integer | 최근 Resolved 또는 Closed로 설정된 시간, Unix 초. 복구된 적이 없으면 -1. 다시 열어도 이 이력 시간이 자동으로 지워지지 않습니다. |
| content.eventCount | integer | 기록된 연관 이벤트 수. |
| content.eventCountUpdateAt | integer | 연관 이벤트 수의 최근 갱신 시간, Unix 초. 아직 기록되지 않은 경우 -1. |
| content.triggerRecord | object | 이전 호환 필드로, 더 이상 알림 트리거 제어 파라미터로 사용되지 않습니다. |
| content.extend | object | 저장된 확장 내용이며, 수정 전에 전체 객체를 복사해야 합니다. 수정 시 생략하면 유지되고, {}는 일부 원본 내용을 지울 수 있습니다(이전 생성자 표시 정보는 조건부로 유지). 동적 필드 설명은 수정 페이지를 참고하세요. |
| content.extend.text | string | 길이 검사에 사용되는 일반 텍스트로, 최대 3000자입니다. |
| content.extend.channels | array<object> |
설명에서 참조된 채널로 uuid, name, type, exists를 포함합니다. 반환 시 exists는 현재 리소스 존재 여부에 따라 갱신됩니다. |
| content.extend.channels[].uuid | string | 채널 UUID. |
| content.extend.channels[].name | string 또는 null | 표시 이름. |
| content.extend.channels[].type | string | 채널 참조 표시 #. |
| content.extend.channels[].exists | boolean | 전체 사이트의 삭제되지 않은 채널 레코드로 존재 여부를 확인하며, 소속 워크스페이스/활성 상태를 완전히 검증하지 않습니다. 이를 근거로 본 워크스페이스의 유효한 참조임을 증명할 수 없습니다. |
| content.extend.members | array<object> |
설명에서 @로 참조된 멤버로 uuid, name, type, exists를 포함합니다. |
| content.extend.members[].uuid | string | 멤버 계정 UUID. |
| content.extend.members[].name | string 또는 null | 표시 이름. |
| content.extend.members[].type | string | 멤버 참조 표시 @. |
| content.extend.members[].exists | boolean | 전체 사이트의 삭제되지 않은 계정으로 존재 여부를 확인하며, 비활성화된 계정도 true일 수 있습니다. 본 워크스페이스의 활성 멤버임을 의미하지 않습니다. |
| content.extend.manager | array<string> |
담당자 식별자 배열로 Issue에서만 사용합니다. 멤버/팀/알림 대상/이메일 등은 유효성에 따라 정규화됩니다. |
| content.extend.manager[] | string | 단일 담당자 식별자. |
| content.extend.linkList | array<object> |
비즈니스 참고 링크. |
| content.extend.linkList[].name | string | 링크 표시 이름. |
| content.extend.linkList[].link | string | 비즈니스 URL. |
| content.extend.sourceLink | string | 클라이언트가 저장한 출처 링크로, 알림 점프에 사용되는지는 출처 유형과 알림 템플릿에 따르며, 본 인터페이스의 조회 범위를 변경하지 않습니다. |
| content.extend.extra | object | 서드파티 연동 표시 정보로, API의 실제 인증 주체를 변경하지 않습니다. |
| content.extend.extra.creator | object | 서드파티 생성자 표시 정보로 name, email을 포함할 수 있습니다. |
| content.extend.extra.creator.name | string | 생성자 표시 이름. |
| content.extend.extra.creator.email | string | 생성자 표시 이메일. |
| content.extend.extra.updator | object | 서드파티 갱신자 표시 정보로 name, email을 포함할 수 있습니다. |
| content.extend.extra.updator.name | string | 갱신자 표시 이름. |
| content.extend.extra.updator.email | string | 갱신자 표시 이메일. |
| content.extend.extra.managerInfos | object | 담당자 이메일을 키로 하는 표시 정보 매핑으로, Issue에서만 사용합니다. |
| content.extend.extra.managerInfos.이메일.name | string | 해당 이메일 담당자의 표시 이름. |
| content.extend.기타 필드 | JSON | 클라이언트가 저장한 기타 확장 정보로, 모두 비즈니스 동작을 트리거한다는 의미는 아닙니다. |
| content.creatorInfo | object | 생성자 표시 객체. GET은 extend.extra.creator를 우선 사용하며 클라이언트 정의 JSON일 수 있습니다. 수정 응답은 실제 생성 주체 요약을 사용하며 이 표시 오버라이드를 적용하지 않습니다. |
| content.creatorInfo.name | string | 표시 이름, 생략 가능. |
| content.creatorInfo.email | string | 이메일, 생략 가능. |
| content.creatorInfo.uuid | string | 계정 UUID, 생략 가능. |
| content.updatorInfo | object | 갱신자 표시 객체. GET은 extend.extra.updator를 우선 사용하며, 수정 응답은 실제 SYS 주체 요약을 사용합니다. |
| content.updatorInfo.name | string | 표시 이름, 생략 가능. |
| content.updatorInfo.email | string | 이메일, 생략 가능. |
| content.updatorInfo.uuid | string | 계정 UUID, 생략 가능. |
| content.levelInfo | object | 과거 등급 표시 정보로, 삭제되었거나 현재 유효 목록에 없는 이전 등급을 여전히 포함할 수 있습니다. 해당 설정이 없으면 {}일 수 있습니다. 새 쓰기에 사용 가능한지는 유효 등급 목록을 기준으로 합니다. |
| content.levelInfo.uuid | string | 등급 UUID. Issue.level에 여전히 사용 가능한지는 현재 유효 등급 목록을 기준으로 해야 합니다. |
| content.levelInfo.name | string | 등급 이름으로, 워크스페이스 언어 또는 등급 설정에 따라 표시됩니다. |
| content.levelInfo.color | string | 색상 문자열, 일반적으로 #RRGGBB. |
| content.levelInfo.description | string | 등급 설명. |
| content.managerInfos | array<object> |
파싱된 담당자 표시 정보입니다. 계정 정보는 실제 노출 필드에 따라 반환되며, 팀/알림 대상은 일반적으로 uuid와 name을, 이메일은 uuid/email/name을 포함합니다. |
| content.managerInfos[].uuid | string | 담당자 식별자. |
| content.managerInfos[].name | string | 표시 이름. |
| content.managerInfos[].email | string | 이메일 담당자 또는 계정 이메일로, 값이 있을 때 제공됩니다. |
| content.ruleType | string | 출처가 checker이고 모니터 설정이 조회된 경우 제공되는 유형입니다. |
| content.eventTimeRange | array<integer> |
연관 이벤트 수가 존재할 때 제공되는 시작/종료 시간, Unix 밀리초. |
| content.eventTimeRange[] | integer | Unix 밀리초 타임스탬프. |
| content.eventConditions | string | 자동 발견 출처에 유효한 규칙이 있을 때 제공되는 이벤트 조회 조건. |
| content.eventConditionsFilters | JSON | 자동 발견 출처의 필터 편집 데이터로, 설정이 있을 때 제공됩니다. |
| content.attachments | array<object> |
Issue에 바인딩된 첨부 파일 목록이며, 다운로드는 첨부 파일 다운로드를 사용합니다. |
| content.attachments[].uuid | string | 첨부 파일 UUID. |
| content.attachments[].fileName | string | 원본 파일 이름. |
| content.attachments[].fileSuffix | string | 파일 확장자. |
| content.bindChannels | array<object> |
Issue 바인딩 채널. |
| content.bindChannels[].uuid | string | 채널 UUID. |
| content.bindChannels[].name | string | 채널 이름. |
| content.creatorInfo.status | integer | 계정 레코드 상태, 생략 가능. |
| content.creatorInfo.wsAccountStatus | integer | 현재 워크스페이스에서의 계정 상태, 생략 가능. |
| content.creatorInfo.username | string | 로그인 이름, 생략 가능. |
| content.creatorInfo.iconUrl | string | 계정 아바타 URL, 생략 가능. |
| content.creatorInfo.mobile | string | 계정 휴대폰 번호로, 비어 있거나 생략될 수 있습니다. |
| content.creatorInfo.countryCode | string | 휴대폰 번호 국가/지역 코드, 생략 가능. |
| content.creatorInfo.acntWsNickname | string | 워크스페이스 닉네임, 생략 가능. |
| content.updatorInfo.status | integer | 계정 레코드 상태, 생략 가능. |
| content.updatorInfo.wsAccountStatus | integer | 현재 워크스페이스에서의 계정 상태, 생략 가능. |
| content.updatorInfo.username | string | 로그인 이름, 생략 가능. |
| content.updatorInfo.iconUrl | string | 계정 아바타 URL, 생략 가능. |
| content.updatorInfo.mobile | string | 계정 휴대폰 번호로, 비어 있거나 생략될 수 있습니다. |
| content.updatorInfo.countryCode | string | 휴대폰 번호 국가/지역 코드, 생략 가능. |
| content.updatorInfo.acntWsNickname | string | 워크스페이스 닉네임, 생략 가능. |
| content.managerInfos[].status | integer | 계정 레코드 상태, 생략 가능. |
| content.managerInfos[].wsAccountStatus | integer | 현재 워크스페이스에서의 계정 상태, 생략 가능. |
| content.managerInfos[].username | string | 로그인 이름, 생략 가능. |
| content.managerInfos[].iconUrl | string | 계정 아바타 URL, 생략 가능. |
| content.managerInfos[].mobile | string | 계정 휴대폰 번호로, 비어 있거나 생략될 수 있습니다. |
| content.managerInfos[].countryCode | string | 휴대폰 번호 국가/지역 코드, 생략 가능. |
| content.managerInfos[].acntWsNickname | string | 워크스페이스 닉네임, 생략 가능. |
| content.levelInfo.id | integer 또는 null | 등급 레코드 번호. 시스템 기본 등급은 이 필드를 제공하지 않습니다. |
| content.levelInfo.workspaceUUID | string | 과거 등급 표시 정보의 선택 필드입니다. 소속 워크스페이스 UUID. |
| content.levelInfo.status | integer | 과거 등급 표시 정보의 선택 필드입니다. 레코드 상태. 0 정상, 3 삭제됨. Issue 비즈니스 상태 statusType과 구분합니다. |
| content.levelInfo.creator | string | 과거 등급 표시 정보의 선택 필드입니다. 생성 호출 주체로, API Key 식별자, 계정 또는 시스템 주체일 수 있습니다. |
| content.levelInfo.updator | string | 과거 등급 표시 정보의 선택 필드입니다. 최근 갱신 주체. 설정되지 않은 경우 빈 문자열입니다. |
| content.levelInfo.createAt | integer | 과거 등급 표시 정보의 선택 필드입니다. 생성 시간, Unix 초. |
| content.levelInfo.updateAt | integer | 과거 등급 표시 정보의 선택 필드입니다. 최근 갱신 시간, Unix 초. 갱신되지 않은 경우 -1일 수 있습니다. |
| content.levelInfo.deleteAt | integer | 과거 등급 표시 정보의 선택 필드입니다. 삭제 시간, Unix 초. 삭제되지 않은 경우 -1. |
| content.levelInfo.extend | object 또는 null | 과거 등급 표시 정보의 선택 필드입니다. 생성 시 저장된 추가 JSON 객체이며, 등급 수정 인터페이스는 현재 이 필드를 수정하지 않습니다. |
| content.levelInfo.isManage | boolean 또는 number | 과거 등급 표시 정보의 선택 필드입니다. 플랫폼 관리 등급인지 여부이며, 워크스페이스 자체 생성은 일반적으로 false입니다. |
| content.levelInfo.isDefault | boolean | 시스템 기본 등급 표시 플래그로, 생략 가능합니다. |
| content.creatorInfo.기타 필드 | JSON 값 | GET 외부 표시 객체는 다른 키를 저장할 수 있으며 실제 데이터에 따라 해석합니다. 시스템 요약은 일반적으로 아래 공개 필드만 반환합니다. |
| content.updatorInfo.기타 필드 | JSON 값 | 외부 표시 객체는 다른 키를 저장할 수 있으며 실제 인증 주체를 의미하지 않습니다. |
{
"code": 200,
"content": {
"id": 1001,
"uuid": "issue_example001",
"status": 0,
"creator": "acnt_example",
"updator": "SYS",
"createAt": 1785427200,
"updateAt": 1785427260,
"deleteAt": -1,
"workspaceUUID": "wksp_example001",
"name": "생산 API 지연",
"level": "system_level_1",
"statusType": 15,
"statusTypeUpdateRecord": [
"1785427260&&Working"
],
"description": "지연 원인을 확인 중입니다.",
"resourceType": "event",
"resourceUUID": "",
"subIdentify": "",
"resource": "LOG",
"repeatType": "",
"extend": {
"text": "지연 원인을 확인 중입니다.",
"manager": [],
"linkList": []
},
"resolveAt": -1,
"eventCount": 0,
"eventCountUpdateAt": -1,
"triggerRecord": {},
"creatorInfo": {},
"updatorInfo": {
"uuid": "",
"status": 0,
"wsAccountStatus": 0,
"name": "SYS",
"username": "SYS",
"email": "SYS",
"mobile": ""
},
"managerInfos": [],
"attachments": [],
"levelInfo": {
"uuid": "system_level_1",
"name": "P1",
"color": "#FF7931",
"description": "<현재 언어 및 등급 설정의 설명>",
"isDefault": true
},
"bindChannels": []
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | Issue UUID가 존재하지 않거나 삭제된 경우 경로가 먼저 빈 객체 workspaceUUID를 읽거나, 상세/연관 자료 조회 중 예외 발생 | 내부 오류 | 먼저 Issue가 실제로 존재하고 삭제되지 않았으며 UUID가 정확한지 확인하세요. 이 External 경로는 현재 존재하지 않음을 고정 404로 처리할 수 없습니다. traceId를 보관하고 관리자에게 확인을 요청하세요. |