조회¶
GET /api/v1/issue/{issue_uuid}/get
개요¶
현재 워크스페이스의 단일 Issue에 대한 상세 정보, 담당자, 등급, 채널 및 첨부 파일 정보를 조회합니다.
호출 전 및 사용 단계¶
Issue 목록 또는 생성 결과에서 uuid를 가져와 경로에 넣습니다. 응답에는 저장된 설명과 extend, 표시 정보 및 첨부 파일 식별자가 포함됩니다. 반환된 uuid를 사용하여 계속 업데이트하거나 답글을 작성할 수 있습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용하므로, 동일한 워크스페이스에서 리소스 식별자를 가져와야 합니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_uuid | string | Y | 현재 워크스페이스의 Issue UUID입니다. 예: issue_example가져오기 또는 입력 방법: Issue 목록의 content.data[].uuid 또는 Issue 생성 응답의 content.uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
반환된 extend를 읽은 후 수정을 수행하면 계속 사용해야 하는 담당자, 링크 및 표시 정보를 유지할 수 있습니다. 첨부 파일 다운로드에는 Issue UUID가 아닌 첨부 파일 UUID를 사용합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/issue/issue_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 레코드 번호입니다. Issue/답글 생성 응답은 영속화 전에 구성되는 경우 null일 수 있으므로, 리소스 작업에는 uuid를 사용합니다. |
| content.uuid | string | 리소스 UUID입니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.status | integer | 레코드 상태입니다. 0은 정상, 3은 삭제됨입니다. Issue 비즈니스 상태인 statusType과 구분합니다. |
| content.creator | string | 생성 호출 주체입니다. API Key 식별자, 계정 또는 시스템 주체일 수 있습니다. |
| content.updator | string | 최근 업데이트 주체입니다. 설정되지 않은 경우 빈 문자열입니다. |
| 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 | 확장 내용입니다. 요청 시 null이 아닌 객체 {}를 전달해야 하며, 멤버, 채널 및 담당자 등의 구조는 파라미터 표를 참고하십시오. |
| 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 | 반환 시 해당 계정이 존재하는지 여부입니다. |
| 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 | 생성자 표시 정보입니다. 서드파티 extend.extra.creator에 값이 있는 경우 일부 조회 API는 해당 표시 정보를 우선 사용합니다. |
| content.creatorInfo.name | string | 표시 이름이며 생략할 수 있습니다. |
| content.creatorInfo.email | string | 이메일이며 생략할 수 있습니다. |
| content.creatorInfo.uuid | string | 계정 UUID이며 생략할 수 있습니다. |
| content.updatorInfo | object | 업데이트자 표시 정보이며 빈 객체일 수 있습니다. |
| 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.declaration | object 또는 null | 워크스페이스 공통 선언입니다. content의 이 계층에만 추가됩니다. |
| 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 객체이며, 등급 수정 API는 현재 이 필드를 수정하지 않습니다. |
| content.levelInfo.isManage | boolean 또는 number | 이전 등급 표시 정보의 선택 필드입니다. 플랫폼 관리 등급인지 여부이며, 워크스페이스 자체 생성 등급은 일반적으로 false입니다. |
| content.levelInfo.isDefault | boolean | 시스템 기본 등급 표시 플래그이며 생략할 수 있습니다. |
{
"code": 200,
"content": {
"id": 101,
"uuid": "issue_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430800,
"deleteAt": -1,
"name": "checkout-api 延迟异常",
"level": "system_level_1",
"statusType": 10,
"statusTypeUpdateRecord": [],
"description": "定位生产接口延迟,记录处理过程。",
"resourceType": "",
"resourceUUID": "",
"resource": "",
"repeatType": "",
"subIdentify": "",
"extend": {},
"resolveAt": -1,
"eventCount": 0,
"eventCountUpdateAt": -1,
"triggerRecord": {},
"creatorInfo": {},
"updatorInfo": {},
"levelInfo": {
"uuid": "system_level_1",
"name": "P1",
"description": "业务重要功能不可用,但影响用户有限。",
"color": "#FF7931",
"isDefault": true
},
"managerInfos": [],
"bindChannels": [
{
"uuid": "chan_example",
"name": "生产异常"
}
],
"attachments": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 404 | ft.NotFoundIsuue | Issue가 존재하지 않거나, 삭제되었거나, 현재 공간에 속하지 않음 | 지정된 Issue를 찾을 수 없음 | Issue 목록을 사용하여 유효한 uuid를 다시 가져오십시오. 오류 코드 철자가 Isuue로 유지됨에 유의하십시오. |