콘텐츠로 이동

인시던트 댓글 조회



GET /api/v1/incidents/comment/{incident_uuid}/list

개요

인시던트 댓글 및 첨부 파일/ID 요약을 페이지 단위로 읽습니다.

호출 전 및 사용 단계

Key는 routine.defaultAccess 또는 incidents.incidentsQuery 중 하나에 해당해야 합니다. 현재 워크스페이스에서 읽으며, 경로의 incident_uuid는 인시던트 목록의 content.data[].uuid에서 가져옵니다. createAt 내림차순, 동일한 경우 id 내림차순으로 페이지를 나누며, 기본값은 pageIndex=1/pageSize=10입니다. 페이지 정보는 최상위 pageInfo에 있고, content는 data 배열과 declaration을 포함하는 객체입니다. 빈 목록이라고 해서 인시던트가 존재한다는 것이 보장되지는 않으며, 이 엔드포인트는 상위 인시던트를 먼저 검증하지 않습니다.

수동 및 시스템 댓글을 반환하며 creatorInfo/updatorInfo와 첨부 파일 요약이 포함됩니다. 시스템 생성 작업 댓글의 creator는 시스템 응답 ID일 수 있으며, 실제 작업 주체는 extend.operator/operator_info에 있을 수 있습니다. 모든 댓글을 수동 댓글로 간주하지 마십시오. 알 수 없는 ID는 {}이며, 빈 본문/확장은 저장된 값대로 읽고, 첨부 파일은 downloadAttachment를 통해 별도로 다운로드합니다. 조회 중 새로 추가된 레코드는 오프셋 페이지네이션을 이동시킬 수 있으므로 uuid 기준으로 중복을 제거하며 계속 읽어야 하며, 고정된 스냅샷이라고 주장하지 않습니다.

경로 매개변수

매개변수명 유형 필수 설명
incident_uuid string Y 현재 워크스페이스의 인시던트 UUID이며, 알림 이벤트 ID, SLO UUID 또는 댓글 UUID가 아닙니다.
null 허용: False
예시: incident_example
가져오기 또는 입력 방법: 인시던트 목록에서 content.data[].uuid를 가져옵니다.

요청 헤더

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

Query 요청 매개변수

매개변수명 유형 필수 설명
pageIndex integer 선택적 정수이며 기본값은 1이고, >=1을 권장합니다. 현재 선언에서는 양수를 제한하지 않으므로 음수에 대한 오류를 의존할 수 없습니다. 추가/변경 중에는 오프셋 페이지네이션이 이동할 수 있습니다.
null 허용: False
예시: 1
가져오기 또는 입력 방법: 첫 페이지부터 시작하여 최상위 pageInfo에 따라 다음 페이지를 이어갑니다.
pageSize integer 선택적 정수이며 기본값은 10입니다. 현재 구현에서는 최댓값을 선언하지 않았으므로 호출자는 합리적인 양수로 제한해야 하며, 0/음수는 안정적인 페이지네이션 계약으로 간주하지 않습니다.
null 허용: False
예시: 10
가져오기 또는 입력 방법: 조회량에 따라 선택하며 10~100을 권장합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/incidents/comment/incident_example/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=10

응답

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

필드 유형 설명
content object 페이지 내용 객체이며, 레코드 배열은 data에, 선언은 declaration에 있습니다.
content.data array<object> 현재 페이지의 레코드 배열이며, 일치하는 항목이 없으면 []입니다.
content.data[].id integer 또는 null 데이터베이스 행 ID; 비즈니스 식별에는 uuid를 사용하며, 제출 전 스냅샷에서는 null일 수 있습니다.
content.data[].uuid string 해당 리소스 UUID.
content.data[].status integer 데이터베이스 상태, 0 활성/3 삭제; 인시던트 비즈니스 상태 incidentsStatus와 다릅니다.
content.data[].creator string 생성 주체, API Key는 일반적으로 wsak_리소스 UUID입니다.
content.data[].updator string 최근 업데이트 주체, 업데이트되지 않은 경우 비어 있을 수 있습니다.
content.data[].createAt integer Unix 초 단위 생성 시간.
content.data[].updateAt integer Unix 초 단위 최근 업데이트 시간.
content.data[].deleteAt integer Unix 초 단위 삭제 시간; 삭제되지 않은 경우 -1.
content.data[].incidentsUUID string 소속 인시던트 UUID.
content.data[].workspaceUUID string 소속 워크스페이스.
content.data[].comment string 댓글 본문이며 시스템 생성 작업 설명을 포함할 수 있습니다. 본문을 구조화된 작업 기록으로 간주하지 않습니다.
content.data[].extend object 또는 JSON 저장된 확장; 시스템 댓글에는 operator/operator_info/operate_type/before/after 등이 포함될 수 있습니다.
content.data[].extend.members array<object> @멤버 입력 기록으로, 댓글 생성 시 추가 이메일 알림 후보에 사용되며 전송 완료를 의미하지 않습니다.
content.data[].extend.members[].type string @는 계정 멘션을 나타내며, 다른 값은 해당 이메일 후보에 포함되지 않습니다.
content.data[].extend.members[].uuid string 계정 UUID.
content.data[].extend.members[].exists boolean 고객 편집기 상태이며, 서버 알림 필터링은 이 값에 의존하지 않습니다.
content.data[].extend.linkList array<object> 비즈니스 링크 표시 자료.
content.data[].extend.linkList[].name string 링크 표시 이름.
content.data[].extend.linkList[].link string 링크 URL.
content.data[].extend.manager array<string> 과거 외부 담당자 이메일 배열로, 수정 시 기존 extra.managerInfos를 유지할 때 필터링에 사용됩니다. 인시던트 assigner와 동일하지 않습니다.
content.data[].extend.manager[] string 과거 담당자 이메일 하나.
content.data[].extend.extra object 외부 ID 보조 자료로, 수정 시 기존 creator와 manager에 남아 있는 managerInfos가 유지될 수 있습니다.
content.data[].extend.extra.creator JSON 원래 생성자 보조 ID 자료; 기존 값이 있으면 수정으로 생성자를 변경할 수 없습니다.
content.data[].extend.extra.managerInfos object 과거 담당자 이메일에서 ID 자료로의 동적 매핑.
content.data[].extend.extra.managerInfos.邮箱 JSON 해당 이메일에 대응하는 원래 ID 자료.
content.data[].extend.operator string 시스템 작업 댓글의 원래 작업 주체 식별자.
content.data[].extend.operator_info object 시스템 작업 댓글에 첨부된 주체 요약.
content.data[].extend.operate_type string 시스템 작업 댓글에 첨부된 작업 유형.
content.data[].extend.before JSON 시스템 작업의 이전 값이며 동작에 따라 달라집니다.
content.data[].extend.after JSON 시스템 작업의 새 값이며 동작에 따라 달라집니다.
content.data[].extend.自定义字段 JSON 호출자/시스템이 저장한 기타 확장 키-값; 이 인터페이스는 고정 구조를 보장하지 않습니다.
content.data[].extend.operator_info.uuid string 주체 UUID; 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content.data[].extend.operator_info.status integer 주체 상태.
content.data[].extend.operator_info.wsAccountStatus integer 워크스페이스 멤버 상태; Key는 Key 상태를 사용하며 인시던트 상태가 아닙니다.
content.data[].extend.operator_info.username string 로그인 이름/Key 이름/시스템 이름.
content.data[].extend.operator_info.name string 표시 이름, 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content.data[].extend.operator_info.iconUrl string 아바타 URL, 시스템 요약에서는 생략될 수 있습니다.
content.data[].extend.operator_info.email string 연락 이메일; Key 요약은 Key UUID일 수 있으며 실제 발송 가능한 이메일이 아닙니다.
content.data[].extend.operator_info.mobile string 연락 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].extend.operator_info.countryCode string 국가 코드, 시스템 요약에서는 생략될 수 있습니다.
content.data[].extend.operator_info.acntWsNickname string 워크스페이스 닉네임, 시스템 요약에서는 생략될 수 있습니다.
content.data[].creatorInfo object 생성/업데이트 주체 요약, 알 수 없는 경우 {}.
content.data[].creatorInfo.uuid string 주체 UUID; 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content.data[].creatorInfo.status integer 주체 상태.
content.data[].creatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태; Key는 Key 상태를 사용하며 인시던트 상태가 아닙니다.
content.data[].creatorInfo.username string 로그인 이름/Key 이름/시스템 이름.
content.data[].creatorInfo.name string 표시 이름, 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content.data[].creatorInfo.iconUrl string 아바타 URL, 시스템 요약에서는 생략될 수 있습니다.
content.data[].creatorInfo.email string 연락 이메일; Key 요약은 Key UUID일 수 있으며 실제 발송 가능한 이메일이 아닙니다.
content.data[].creatorInfo.mobile string 연락 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].creatorInfo.countryCode string 국가 코드, 시스템 요약에서는 생략될 수 있습니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임, 시스템 요약에서는 생략될 수 있습니다.
content.data[].updatorInfo object 생성/업데이트 주체 요약, 알 수 없는 경우 {}.
content.data[].updatorInfo.uuid string 주체 UUID; 시스템 응답 주체는 비어 있거나 시스템 식별자일 수 있습니다.
content.data[].updatorInfo.status integer 주체 상태.
content.data[].updatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태; Key는 Key 상태를 사용하며 인시던트 상태가 아닙니다.
content.data[].updatorInfo.username string 로그인 이름/Key 이름/시스템 이름.
content.data[].updatorInfo.name string 표시 이름, 시스템 AI 표시 이름은 사이트 설정을 사용합니다.
content.data[].updatorInfo.iconUrl string 아바타 URL, 시스템 요약에서는 생략될 수 있습니다.
content.data[].updatorInfo.email string 연락 이메일; Key 요약은 Key UUID일 수 있으며 실제 발송 가능한 이메일이 아닙니다.
content.data[].updatorInfo.mobile string 연락 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].updatorInfo.countryCode string 국가 코드, 시스템 요약에서는 생략될 수 있습니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임, 시스템 요약에서는 생략될 수 있습니다.
content.data[].attachments array<object> 연결된 첨부 파일 요약, 연결되지 않은 경우 [].
content.data[].attachments[].uuid string 첨부 파일 UUID; 이 모듈의 downloadAttachment 인터페이스를 통해 다운로드합니다.
content.data[].attachments[].fileName string 원본 파일 이름.
content.data[].attachments[].fileSuffix string 파일 확장자, 점 없음; 파일 내용/직접 링크는 반환하지 않습니다.
content.declaration object 현재 워크스페이스 공통 선언이며, data의 각 항목에 재귀적으로 삽입되지 않습니다.
pageInfo.pageIndex integer 현재 페이지, 기본값 1.
pageInfo.pageSize integer 현재 페이지 크기, 기본값 10.
pageInfo.count integer 현재 페이지 항목 수.
pageInfo.totalCount integer 일치하는 총 항목 수; 변경 중에는 달라질 수 있습니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 123,
        "uuid": "inccmt_example",
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "incidentsUUID": "incident_example",
        "workspaceUUID": "wksp_example",
        "comment": "데이터베이스 연결 이상을 확인했으며 처리 중입니다.",
        "extend": {},
        "creatorInfo": {},
        "updatorInfo": {},
        "attachments": []
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반함 매개변수 파싱 실패 Query 매개변수 표 및 예시를 확인하십시오.
500 ft.InternalServerError 데이터베이스 읽기, 과거 객체/설정 형식 또는 연관 요약 구성 등에서 처리되지 않은 예외 내부 오류 조회 매개변수를 확인하고 traceId를 보존하십시오. 백오프 후 재시도할 수 있으며, 계속 실패하면 관리자에게 관련 기록 및 서비스 로그를 확인하도록 요청하십시오.

문서 평가

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