콘텐츠로 이동

목록 조회



POST /api/v1/issue/list

개요

현재 워크스페이스의 Issue를 페이지 단위로 나열하며, 채널, 생성 시간, 상태, 등급 및 키워드 필터를 지원합니다.

호출 전 및 사용 단계

기본적으로 생성 시간 내림차순으로 정렬되며 pageIndex=1, pageSize=10입니다. startTime/endTime은 Unix 초를 사용하며, 양쪽 끝에 모두 0이 아닌 값을 전달한 경우에만 적용됩니다. 이벤트 API의 밀리초 시간 파라미터와 구분하세요. 이후 최상위 pageInfo.totalCount를 기준으로 페이지를 넘기며, Issue 배열은 content.data에서 읽습니다. pageInfo는 content 내부에 있지 않습니다. 데이터가 업데이트되는 동안 페이지를 넘기는 과정에서 결과가 달라질 수 있습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용합니다. 동일한 워크스페이스에서 리소스 식별자를 가져오세요.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 유형 필수 설명
filters[*] json 단일 필터 객체입니다. 이벤트 API의 name/operation 구조를 사용하지 않습니다.
예: {"key": "statusType", "value": 10, "equal": true}
가져오기 또는 입력 방법: 각 조건에 key, value 및 boolean 유형의 equal을 입력합니다.
filters[*].key json 다음 키만 이 API의 필터링에 참여합니다.
예: statusType
가져오기 또는 입력 방법: 필터 대상에 따라 level, statusType, resource, creator, updator 중에서 선택합니다.
filters[*].value json 단일 필터 값입니다. 상태는 정수를 사용하고, 나머지는 문자열을 사용합니다.
예: 10
가져오기 또는 입력 방법: level은 등급 UUID를 사용하고, statusType은 10/15/20/25/30을 사용하며, resource는 소스 값 또는 현재 언어의 표시 이름을 사용합니다. creator/updator는 계정 UUID 또는 멤버 이름을 사용하며 SYS도 사용할 수 있습니다.
filters[*].equal json 비교 방식입니다. 명시적으로 전달하는 것을 권장합니다. 생략하면 같지 않음 분기로 처리됩니다.
예: true
가져오기 또는 입력 방법: boolean true는 같음, false는 같지 않음입니다. 문자열 "false"를 사용하지 마세요.
channelUUID string 선택적 단일 채널 필터입니다. 이 채널에 바인딩된 Issue를 반환합니다.
null 허용: False
예: chan_example
가져오기 또는 입력 방법: 채널 목록의 content[].uuid에서 가져옵니다. 생략하면 현재 워크스페이스의 모든 채널 Issue를 조회합니다.
endTime integer 생성 시간 상한이며 Unix 초 단위입니다. startTime과 함께 폐구간을 구성합니다.
null 허용: False
예: 1785430800
가져오기 또는 입력 방법: 클라이언트 시간 선택기에서 종료 시각을 Unix 초로 가져옵니다. startTime과 함께 전달해야 합니다.
filters array Issue 필드 필터입니다. 동일 필드의 여러 같음 조건은 OR로 결합되고, 여러 같지 않음 조건 및 같음/같지 않음 혼합 조건은 AND로 결합됩니다. 서로 다른 필드는 AND로 결합됩니다.
null 허용: False
예: [{"key": "statusType", "value": 10, "equal": true}]
가져오기 또는 입력 방법: Issue 상세, 유효 등급 목록 또는 현재 워크스페이스의 멤버 관리에서 필터 값을 가져옵니다. 생략하거나 []를 사용하면 이러한 조건을 추가하지 않습니다.
pageIndex integer 페이지 번호이며 기본값은 1입니다. 양의 정수를 사용하세요.
null 허용: False
예: 1
가져오기 또는 입력 방법: 첫 페이지는 1을 입력하고 이후 증가시키며, 필터 조건은 동일하게 유지합니다.
pageSize integer 페이지당 항목 수이며 기본값은 10입니다. 0이나 음수를 전달하지 마세요.
null 허용: False
예: 10
가져오기 또는 입력 방법: 필요에 따라 양의 정수를 입력합니다. 적절한 항목 수를 사용하여 응답 크기를 줄이는 것을 권장합니다.
search string 제목 및 설명에 대한 포함 검색입니다.
빈 문자열 허용: True
null 허용: False
예: checkout
가져오기 또는 입력 방법: 제목 또는 설명의 일부 텍스트를 입력합니다. 생략하거나 빈 문자열이면 필터링하지 않습니다.
startTime integer 생성 시간 하한이며 Unix 초 단위입니다. 양쪽 끝이 모두 0이 아닌 값일 때만 시간 필터가 활성화됩니다.
null 허용: False
예: 1785427200
가져오기 또는 입력 방법: 클라이언트에서 Issue 생성 시간을 선택하여 Unix 초로 변환합니다. endTime과 함께 전달해야 합니다.

파라미터 추가 설명

이 API는 manager, channelUUIDs 및 워크스페이스 간 파라미터를 선언하지 않으므로 파라미터 표의 공개 필드를 사용하세요. filters 중첩 객체는 필드별로 검증되지 않으며, 잘못된 유형은 내부 오류를 발생시킬 수 있습니다. 전송 전에 예시에 따라 확인하세요.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/issue/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filters":[{"key":"statusType","value":10,"equal":true}],"pageIndex":1,"pageSize":10}'

응답

HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.data array<object> 현재 페이지의 Issue 배열이며, 결과가 없으면 []입니다.
content.data[].id integer 또는 null 레코드 번호입니다. Issue 생성/답글 응답이 영속화 전에 구성되는 경우 null일 수 있으므로, 리소스 작업에는 uuid를 사용하세요.
content.data[].uuid string 리소스 UUID입니다.
content.data[].workspaceUUID string 소속 워크스페이스 UUID입니다.
content.data[].status integer 레코드 상태입니다. 0은 정상, 3은 삭제됨입니다. Issue 비즈니스 상태인 statusType과 구분합니다.
content.data[].creator string 생성 호출 주체이며 API Key 식별자, 계정 또는 시스템 주체일 수 있습니다.
content.data[].updator string 최근 업데이트 주체입니다. 설정되지 않은 경우 빈 문자열입니다.
content.data[].createAt integer 생성 시간, Unix 초입니다.
content.data[].updateAt integer 최근 업데이트 시간, Unix 초입니다. 업데이트되지 않은 경우 -1일 수 있습니다.
content.data[].deleteAt integer 삭제 시간, Unix 초입니다. 삭제되지 않은 경우 -1입니다.
content.data[].name string Issue 제목입니다.
content.data[].level string 등급 UUID이며 빈 문자열은 미지정을 의미합니다. 등급 이름이 아닙니다.
content.data[].statusType integer 상태: 10 Open, 15 Working, 20 Resolved, 25 Closed, 30 Pending.
content.data[].statusTypeUpdateRecord array<string> 상태 변경 이력이며, 각 항목은 Unix 초&&상태 이름 형식입니다.
content.data[].statusTypeUpdateRecord[] string 단일 상태 변경 레코드입니다.
content.data[].description string Issue 설명입니다.
content.data[].resourceType string 소스 유형입니다. 예: event, dashboard, viewer. 자동 생성 시 checker, keyeventAutoDiscovery 등일 수 있습니다.
content.data[].resourceUUID string 연관 소스 식별자이며, 구체적인 의미는 소스 유형에 따라 달라집니다.
content.data[].resource string 소스 모듈 또는 이름입니다. 예: LOG, TRACING, EVENTS, RUM.
content.data[].repeatType string 자동 감지 문제의 반복 유형이며 new, repeat, regression일 수 있습니다. 수동 생성 시 비어 있을 수 있습니다.
content.data[].subIdentify string 소스에서 정의한 연관 하위 식별자이며, 수동 생성 시 일반적으로 비어 있습니다.
content.data[].resolveAt integer 최근에 Resolved 또는 Closed로 설정된 시간(Unix 초)입니다. 한 번도 복구되지 않은 경우 -1입니다. 다시 열어도 이 이력 시간은 자동으로 지워지지 않습니다.
content.data[].eventCount integer 기록된 연관 이벤트 수입니다.
content.data[].eventCountUpdateAt integer 연관 이벤트 수의 최근 업데이트 시간(Unix 초)입니다. 아직 기록되지 않은 경우 -1입니다.
content.data[].triggerRecord object 이전 버전 호환 필드이며, 더 이상 알림 트리거 제어 파라미터로 사용되지 않습니다.
content.data[].extend object 확장 내용입니다. 요청 시 객체 {}를 전달하고 null을 전달하지 마세요. 멤버, 채널 및 담당자 등의 구조는 파라미터 표를 참조하세요.
content.data[].extend.text string 길이 검사에 사용되는 일반 텍스트이며 최대 3000자입니다.
content.data[].extend.channels array<object> 설명에서 참조된 채널이며 uuid, name, type, exists를 포함합니다. 반환 시 exists는 현재 리소스 존재 여부에 따라 갱신됩니다.
content.data[].extend.channels[].uuid string 채널 UUID입니다.
content.data[].extend.channels[].name string 또는 null 표시 이름입니다.
content.data[].extend.channels[].type string 채널 참조 표시 #입니다.
content.data[].extend.channels[].exists boolean 반환 시 해당 채널의 존재 여부입니다.
content.data[].extend.members array<object> 설명에서 @로 참조된 멤버이며 uuid, name, type, exists를 포함합니다.
content.data[].extend.members[].uuid string 멤버 계정 UUID입니다.
content.data[].extend.members[].name string 또는 null 표시 이름입니다.
content.data[].extend.members[].type string 멤버 참조 표시 @입니다.
content.data[].extend.members[].exists boolean 반환 시 해당 계정의 존재 여부입니다.
content.data[].extend.manager array<string> 담당자 식별자 배열이며 Issue에서만 사용됩니다. 멤버/팀/알림 대상/이메일 등은 유효성에 따라 정규화됩니다.
content.data[].extend.manager[] string 단일 담당자 식별자입니다.
content.data[].extend.linkList array<object> 업무 참고 링크입니다.
content.data[].extend.linkList[].name string 링크 표시 이름입니다.
content.data[].extend.linkList[].link string 업무 URL입니다.
content.data[].extend.sourceLink string 소스 페이지 링크이며, 존재하는 경우 클라이언트에서 입력합니다.
content.data[].extend.extra object 서드파티 연동 표시 정보이며 API의 실제 인증 주체를 변경하지 않습니다.
content.data[].extend.extra.creator object 서드파티 생성자 표시 정보이며 name, email을 포함할 수 있습니다.
content.data[].extend.extra.creator.name string 생성자 표시 이름입니다.
content.data[].extend.extra.creator.email string 생성자 표시 이메일입니다.
content.data[].extend.extra.updator object 서드파티 업데이트 사용자 표시 정보이며 name, email을 포함할 수 있습니다.
content.data[].extend.extra.updator.name string 업데이트 사용자 표시 이름입니다.
content.data[].extend.extra.updator.email string 업데이트 사용자 표시 이메일입니다.
content.data[].extend.extra.managerInfos object 담당자 이메일을 키로 하는 표시 정보 매핑이며 Issue에서만 사용됩니다.
content.data[].extend.extra.managerInfos.邮箱.name string 해당 이메일 담당자의 표시 이름입니다.
content.data[].extend.其他字段 JSON 클라이언트에서 저장한 기타 확장 정보입니다. 모두 비즈니스 동작을 트리거한다는 의미는 아닙니다.
content.data[].creatorInfo object 생성자 표시 정보입니다. 서드파티 extend.extra.creator에 값이 있으면 일부 읽기 API는 해당 표시 정보를 우선 사용합니다.
content.data[].creatorInfo.name string 표시 이름이며 생략할 수 있습니다.
content.data[].creatorInfo.email string 이메일이며 생략할 수 있습니다.
content.data[].creatorInfo.uuid string 계정 UUID이며 생략할 수 있습니다.
content.data[].updatorInfo object 업데이트한 사용자의 표시 정보이며 빈 객체일 수 있습니다.
content.data[].updatorInfo.name string 표시 이름이며 생략할 수 있습니다.
content.data[].updatorInfo.email string 이메일이며 생략할 수 있습니다.
content.data[].updatorInfo.uuid string 계정 UUID이며 생략할 수 있습니다.
content.data[].levelInfo object 이전 등급 표시 정보이며, 삭제되었거나 현재 유효 목록에 없는 이전 등급을 여전히 포함할 수 있습니다. 해당 구성이 없으면 {}일 수 있습니다. 새로 쓰기에 사용할 수 있는지는 유효 등급 목록을 기준으로 합니다.
content.data[].levelInfo.uuid string 등급 UUID입니다. Issue.level에 계속 사용할 수 있는지는 현재 유효 등급 목록을 기준으로 해야 합니다.
content.data[].levelInfo.name string 등급 이름이며 워크스페이스 언어 또는 등급 구성에 따라 표시됩니다.
content.data[].levelInfo.color string 색상 문자열이며 일반적으로 #RRGGBB입니다.
content.data[].levelInfo.description string 등급 설명입니다.
content.data[].managerInfos array<object> 해석된 담당자 표시 정보입니다. 계정 정보는 실제로 표시 가능한 필드에 따라 반환되며, 팀/알림 대상은 일반적으로 uuid와 name을 포함하고, 이메일은 uuid/email/name을 포함합니다.
content.data[].managerInfos[].uuid string 담당자 식별자입니다.
content.data[].managerInfos[].name string 표시 이름입니다.
content.data[].managerInfos[].email string 이메일 담당자 또는 계정 이메일이며, 값이 있을 때 제공됩니다.
content.data[].ruleType string 소스가 checker이고 모니터 구성을 조회한 경우 제공되는 유형입니다.
content.data[].eventTimeRange array<integer> 연관 이벤트 수가 존재할 때 제공되는 시작/종료 시간이며 Unix 밀리초입니다.
content.data[].eventTimeRange[] integer Unix 밀리초 타임스탬프입니다.
content.data[].eventConditions string 자동 감지 소스에 유효한 규칙이 있을 때 제공되는 이벤트 조회 조건입니다.
content.data[].eventConditionsFilters JSON 자동 감지 소스의 필터 편집 데이터이며, 구성이 있을 때 제공됩니다.
content.data[].channels array<object> channelUUID 필터를 전달할 때 일치하는 채널 객체를 보충하며, 각 항목은 uuid/name을 포함합니다.
content.data[].channels[].uuid string 채널 UUID입니다.
content.data[].channels[].name string 채널 이름입니다.
content.declaration object 또는 null 워크스페이스 공통 선언이며 content 계층에만 추가됩니다.
pageInfo object 최상위 페이지 정보입니다.
pageInfo.pageIndex integer 현재 페이지 번호입니다.
pageInfo.pageSize integer 이 페이지의 최대 항목 수입니다.
pageInfo.count integer 이 페이지의 실제 항목 수입니다.
pageInfo.totalCount integer 조건에 맞는 총 항목 수입니다.
content.data[].creatorInfo.status integer 계정 레코드 상태이며 생략할 수 있습니다.
content.data[].creatorInfo.wsAccountStatus integer 현재 워크스페이스에서의 계정 상태이며 생략할 수 있습니다.
content.data[].creatorInfo.username string 로그인 이름이며 생략할 수 있습니다.
content.data[].creatorInfo.iconUrl string 계정 프로필 이미지 URL이며 생략할 수 있습니다.
content.data[].creatorInfo.mobile string 계정 휴대폰 번호이며 비어 있거나 생략될 수 있습니다.
content.data[].creatorInfo.countryCode string 휴대폰 번호 국가/지역 코드이며 생략할 수 있습니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임이며 생략할 수 있습니다.
content.data[].updatorInfo.status integer 계정 레코드 상태이며 생략할 수 있습니다.
content.data[].updatorInfo.wsAccountStatus integer 현재 워크스페이스에서의 계정 상태이며 생략할 수 있습니다.
content.data[].updatorInfo.username string 로그인 이름이며 생략할 수 있습니다.
content.data[].updatorInfo.iconUrl string 계정 프로필 이미지 URL이며 생략할 수 있습니다.
content.data[].updatorInfo.mobile string 계정 휴대폰 번호이며 비어 있거나 생략될 수 있습니다.
content.data[].updatorInfo.countryCode string 휴대폰 번호 국가/지역 코드이며 생략할 수 있습니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임이며 생략할 수 있습니다.
content.data[].managerInfos[].status integer 계정 레코드 상태이며 생략할 수 있습니다.
content.data[].managerInfos[].wsAccountStatus integer 현재 워크스페이스에서의 계정 상태이며 생략할 수 있습니다.
content.data[].managerInfos[].username string 로그인 이름이며 생략할 수 있습니다.
content.data[].managerInfos[].iconUrl string 계정 프로필 이미지 URL이며 생략할 수 있습니다.
content.data[].managerInfos[].mobile string 계정 휴대폰 번호이며 비어 있거나 생략될 수 있습니다.
content.data[].managerInfos[].countryCode string 휴대폰 번호 국가/지역 코드이며 생략할 수 있습니다.
content.data[].managerInfos[].acntWsNickname string 워크스페이스 닉네임이며 생략할 수 있습니다.
content.data[].managerInfos[].id integer 목록 경로에서 계정 담당자는 계정 레코드 번호를 포함할 수 있습니다.
content.data[].managerInfos[].source string 목록 경로에서 계정 소스이며 생략할 수 있습니다.
content.data[].managerInfos[].userIconUrl string 목록 경로에서 계정 프로필 이미지 URL이며 생략할 수 있습니다.
content.data[].managerInfos[].exterId string 계정 외부 식별자이며 생략할 수 있습니다.
content.data[].managerInfos[].namespace string 계정이 속한 네임스페이스이며 생략할 수 있습니다.
content.data[].managerInfos[].attributes object 또는 array 소스 계정 속성이며 생략할 수 있습니다. 키와 구조는 ID 소스에서 정의합니다.
content.data[].managerInfos[].attributes.自定义字段 JSON 소스에서 정의한 계정 속성입니다.
content.data[].managerInfos[].customAttributes object 또는 array 사용자 지정 계정 속성이며 생략할 수 있습니다.
content.data[].managerInfos[].customAttributes.自定义字段 JSON 사용자 지정 계정 속성 값입니다.
content.data[].managerInfos[].defaultWebhook object 일부 에이전트 계정에서 제공하는 기본 Webhook 설명이며 생략할 수 있습니다. 구조는 계정 구성에 따릅니다.
content.data[].managerInfos[].defaultWebhook.自定义字段 JSON Webhook 구성에서 소스에 따라 제공되는 필드입니다.
content.data[].levelInfo.id integer 또는 null 등급 레코드 번호입니다. 시스템 기본 등급은 이 필드를 제공하지 않습니다.
content.data[].levelInfo.workspaceUUID string 이전 등급 표시 정보의 선택적 필드입니다. 소속 워크스페이스 UUID입니다.
content.data[].levelInfo.status integer 이전 등급 표시 정보의 선택적 필드입니다. 레코드 상태이며 0은 정상, 3은 삭제됨입니다. Issue 비즈니스 상태 statusType과 구분합니다.
content.data[].levelInfo.creator string 이전 등급 표시 정보의 선택적 필드입니다. 생성 호출 주체이며 API Key 식별자, 계정 또는 시스템 주체일 수 있습니다.
content.data[].levelInfo.updator string 이전 등급 표시 정보의 선택적 필드입니다. 최근 업데이트 주체이며, 설정되지 않은 경우 빈 문자열입니다.
content.data[].levelInfo.createAt integer 이전 등급 표시 정보의 선택적 필드입니다. 생성 시간, Unix 초입니다.
content.data[].levelInfo.updateAt integer 이전 등급 표시 정보의 선택적 필드입니다. 최근 업데이트 시간, Unix 초입니다. 업데이트되지 않은 경우 -1일 수 있습니다.
content.data[].levelInfo.deleteAt integer 이전 등급 표시 정보의 선택적 필드입니다. 삭제 시간, Unix 초입니다. 삭제되지 않은 경우 -1입니다.
content.data[].levelInfo.extend object 또는 null 이전 등급 표시 정보의 선택적 필드입니다. 생성 시 저장된 추가 JSON 객체입니다. 등급 수정 API는 현재 이 필드를 수정하지 않습니다.
content.data[].levelInfo.isManage boolean 또는 number 이전 등급 표시 정보의 선택적 필드입니다. 플랫폼 관리 등급인지 여부이며, 워크스페이스 자체 생성 등급은 일반적으로 false입니다.
content.data[].levelInfo.isDefault boolean 시스템 기본 등급 표시 플래그이며 생략할 수 있습니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "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": []
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하세요.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하세요.
400 ft.JsonFormatError JSON 최상위가 객체가 아님 일부 json 파일 형식 오류 JSON 객체를 제출하세요.
500 ft.InternalServerError 등급 또는 구성 저장, 감사 또는 기타 내부 처리 실패 내부 오류 먼저 현재 등급 또는 구성을 읽어 결과를 확인한 후 재시도 여부를 결정하세요. 실패가 지속되면 traceId를 제공하세요.

문서 평가

이 페이지가 도움이 되었나요?