ISSUE 수정¶
POST /api/v1/issue/{issue_uuid}/modify
개요¶
Issue 제목, 등급, 상태 또는 전체 확장 정보를 업데이트하고 첨부 파일을 연결하며 수정 알림을 비동기로 트리거합니다.
호출 전 확인 및 사용 단계¶
사이트 수준 External 자격 증명을 사용하며(인증은 External API 서명 인증 참조), Issue UUID로 전체 사이트에서 소속 워크스페이스를 조회합니다. 워크스페이스 OpenAPI Key 범위 인터페이스가 아닙니다. 해당 데이터 범위 권한이 있는 External 자격 증명만 신뢰할 수 있는 통합에 제공하세요. 먼저 Issue 상세와 소속 워크스페이스를 읽습니다. 일반 필드는 생략하면 유지됩니다. extend는 생략하면 유지되고, 존재하면 전체가 교체되므로 먼저 원본 객체를 읽은 뒤 전체 목표 객체를 구성해야 합니다. 채널 관계는 덮어쓰기 삭제가 아니라 추가 병합됩니다. 첨부 파일이 비어 있지 않으면 바인딩/재바인딩하며, []/null은 기존 첨부 파일을 삭제하지 않습니다. 빈 JSON도 시간을 업데이트하고 수정 알림을 예약하므로 부작용 없는 프로브로 사용할 수 없습니다. 상태를 명시적으로 반복 제출해도 작업 기록이 추가될 수 있으며, 20/25는 resolveAt을 갱신합니다. 저장, 채널 재구성, 첨부 파일, 작업 응답에는 여러 커밋 지점이 있으며 이후 알림 예약 및 감사 기록이 수행됩니다. 500은 이미 일부 적용되었을 수 있으므로 먼저 GET으로 확인한 뒤 재시도 여부를 결정하세요. 알림은 채널 구독, 정책 일정, 담당자, 이번 @ 계정 등을 비동기로 소비하며, 성공이 전달을 의미하지는 않습니다. 상태 수정은 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 초 문자열을 생성합니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| attachmentUuids[*] | json | 업로드된 단일 첨부 파일 UUID입니다. 예시: att_example가져오기 또는 입력 방법: 첨부 파일 업로드의 content.attachmentUuid를 사용합니다. |
|
| extend.text | json | 선택적 순수 텍스트이며, 현재 description과 독립적으로 길이가 3000 Python 문자를 초과하지 않는지만 검사합니다. 생략하면 빈 텍스트로 검사하며, null/길이를 계산할 수 없는 유형은 500이 발생할 수 있습니다. 예시: 定位生产接口延迟。가져오기 또는 입력 방법: 설명의 순수 텍스트에서 추출하여 3000자 이내로 제한합니다. 생략하면 빈 텍스트로 검사합니다. |
|
| extend.channels | array | 설명에서 # 채널 객체 배열을 선택적으로 지정합니다. 존재하면 이번 UUID, 기존 바인딩, 기본 채널을 병합·중복 제거한 뒤 관계를 재구성하며, 전체 교체가 아닙니다. []는 기존 바인딩을 해제하지 않으며, 생략하면 관계를 조정하지 않습니다. 이 필드 자체는 extend 내용으로서 여전히 전체 교체됩니다. null은 잘못된 구현으로 500이 발생합니다. 예시: [{"type": "#", "uuid": "chan_example", "name": "生产异常"}]가져오기 또는 입력 방법: 채널 목록에서 실제 채널 UUID를 가져와 설명의 # 채널을 참조합니다. 생략하면 추가하지 않습니다. |
|
| extend.channels[*] | json | 채널 참조 객체입니다. 예시: {"type": "#", "uuid": "chan_example", "name": "生产异常"}가져오기 또는 입력 방법: 각 항목에 동일 워크스페이스의 실제 채널 하나를 선택합니다. |
|
| extend.channels[*].uuid | json | 채널 UUID이며, 호출자는 동일 워크스페이스이고 연결이 허용되는지 검증해야 합니다. 현재 바인딩은 UUID 존재/소속을 완전히 검증하지 않으므로 성공이 유효함을 증명하지 않으며, GET bindChannels로 확인해야 합니다. 예시: chan_example가져오기 또는 입력 방법: 채널 목록의 content[].uuid에서 가져옵니다. |
|
| extend.channels[*].name | json | 클라이언트 표시 이름입니다. 예시: 生产异常가져오기 또는 입력 방법: 채널 목록에서 해당 name을 가져와 표시에 사용하며 생략할 수 있습니다. |
|
| extend.channels[*].type | json | 채널 참조 표시입니다. 예시: #가져오기 또는 입력 방법: 채널 참조는 고정적으로 #을 사용하며, 서버에서 읽은 결과에는 이 표시가 보완됩니다. |
|
| extend.channels[*].exists | json | 선택적 표시 플래그이며 서버의 리소스 검증을 대체하지 않습니다. 예시: true가져오기 또는 입력 방법: 유효성 자격 증명으로 전달할 필요가 없으며, 조회 응답에서 현재 리소스 존재 여부에 따라 다시 계산됩니다. |
|
| extend.members | array | 선택적 이번 @ 계정 객체 배열입니다. 현재 삭제되지 않은 계정 이메일을 추출하여 추가 일회성 알림으로 사용하며, 담당자 배열이 아닙니다. 이메일/팀 객체로 계정 UUID를 직접 대체할 수 없습니다. 반복 제출 시 다시 알림될 수 있으며, 생략하면 이번 추가 @가 없습니다. null/객체가 아닌 요소는 500이 발생할 수 있습니다. 예시: [{"type": "@", "uuid": "acnt_example", "name": "值班工程师"}]가져오기 또는 입력 방법: 대상 워크스페이스 멤버 관리에서 계정 UUID를 가져옵니다. 생략하면 이번 @ 멤버를 추가하지 않습니다. |
|
| extend.members[*] | json | 멤버 참조 객체입니다. 예시: {"type": "@", "uuid": "acnt_example", "name": "值班工程师"}가져오기 또는 입력 방법: @가 필요한 각 계정에 대해 객체를 작성합니다. |
|
| extend.members[*].uuid | json | 멤버 계정 UUID입니다. 예시: acnt_example가져오기 또는 입력 방법: 대상 워크스페이스 멤버 관리에서 acnt_ 계정 UUID를 가져옵니다. |
|
| extend.members[*].name | json | 클라이언트 표시 이름입니다. 예시: 值班工程师가져오기 또는 입력 방법: 멤버 표시 이름을 사용하며 생략할 수 있습니다. |
|
| extend.members[*].type | json | 멤버 참조 표시입니다. 예시: @가져오기 또는 입력 방법: 멤버 참조는 @를 사용합니다. |
|
| extend.members[*].exists | json | 선택적 표시 플래그입니다. 예시: true가져오기 또는 입력 방법: 유효성 자격 증명으로 전달할 필요가 없으며 조회 시 다시 계산됩니다. |
|
| extend.extra | json | 선택적 외부 표시 JSON 객체이며 인증/감사의 실제 SYS ID를 변경하지 않습니다. 생략/{}는 전체 교체 시 기존 표시 업데이트자를 지울 수 있습니다. null 등 객체 구조에 맞지 않으면 500이 발생할 수 있습니다. 예시: {}가져오기 또는 입력 방법: 서드파티 통합에서 외부 작업자를 표시해야 할 때 작성하며, 없으면 생략하거나 {}를 사용합니다. |
|
| extend.extra.creator | json | 외부 생성자 표시 객체입니다. 기존 extra가 있으면 이번 creator가 먼저 제거된 뒤 기존 creator(있는 경우)가 유지됩니다. 수정으로 생성자를 덮어쓸 수 있다고 보장하지 않습니다. 기존 extra가 비어 있어야만 이번 creator가 저장될 수 있습니다. 예시: {"name": "外部工单创建人", "email": "xxx@guance.com"}가져오기 또는 입력 방법: 통합 시스템의 생성자에서 가져오며, 수정 시 기존 creator는 일반적으로 서버에서 유지됩니다. |
|
| extend.extra.creator.name | json | 표시 이름이며 생략할 수 있습니다. 예시: 外部工单创建人가져오기 또는 입력 방법: 외부 시스템 표시 이름을 가져옵니다. |
|
| extend.extra.creator.email | json | 표시 이메일이며 생략할 수 있습니다. 예시: xxx@guance.com가져오기 또는 입력 방법: 외부 시스템 이메일을 가져오며 예시는 가상 주소입니다. |
|
| extend.extra.updator | json | 업데이트자 표시 객체입니다. 예시: {"name": "外部工单更新人", "email": "xxx@guance.com"}가져오기 또는 입력 방법: 수정 시 통합 시스템의 이번 작업자 정보를 가져옵니다. |
|
| extend.extra.updator.name | json | 표시 이름이며 생략할 수 있습니다. 예시: 外部工单更新人가져오기 또는 입력 방법: 외부 시스템 표시 이름을 가져옵니다. |
|
| extend.extra.updator.email | json | 표시 이메일이며 생략할 수 있습니다. 예시: xxx@guance.com가져오기 또는 입력 방법: 외부 시스템 이메일을 가져옵니다. |
|
| extend.manager | array | 선택적 담당자 전체 목표 배열이며 extend가 존재할 때만 교체됩니다. 이 키를 생략하거나 []를 사용하면 전체 객체 교체 시 기존 담당자가 지워집니다. 비어 있지 않으면 알 수 없는 계정/팀/알림 대상 또는 유효하지 않은 이메일을 필터링합니다. dutyPerson은 당일 온콜 캘린더에 따라 구체적인 대상으로 해석되어 저장되며, 이후 교대에 따라 자동으로 변경되지 않습니다. []로 필터링되어도 성공할 수 있으므로 managerInfos를 확인해야 합니다. 일반 사이트 External은 SYS ID이며 외부 표시 업데이트자를 가장하지 않습니다. 예시: ["acnt_example"]가져오기 또는 입력 방법: 대상 워크스페이스의 멤버 관리에서 acnt_ 계정 UUID, 팀 관리에서 group_ UUID를 가져옵니다. 알림 대상 UUID는 알림 대상 목록에서 가져옵니다. 실제 이메일 또는 dutyPerson을 입력할 수도 있습니다. |
|
| extend.manager[*] | json | 계정 UUID, 팀 UUID, 알림 대상 UUID, 이메일 또는 dutyPerson입니다. 예시: acnt_example가져오기 또는 입력 방법: 대상 워크스페이스의 멤버 관리에서 acnt_ 계정 UUID, 팀 관리에서 group_ UUID를 가져옵니다. 알림 대상 UUID는 알림 대상 목록에서 가져옵니다. 실제 이메일 또는 dutyPerson을 입력할 수도 있습니다. |
|
| extend.linkList | array | 참조 링크 배열이며 클라이언트 필요에 따라 저장합니다. 예시: [{"name": "处理手册", "link": "https://example.com/runbook"}]가져오기 또는 입력 방법: 비즈니스 측에서 접근 가능한 참조 링크를 제공하며, 생략하면 추가하지 않습니다. |
|
| extend.linkList[*] | json | 링크 객체입니다. 예시: {"name": "处理手册", "link": "https://example.com/runbook"}가져오기 또는 입력 방법: 각 항목은 참조 링크 하나를 설명합니다. |
|
| extend.linkList[*].name | json | 링크 이름입니다. 예시: 处理手册가져오기 또는 입력 방법: 링크 표시 이름을 입력합니다. |
|
| extend.linkList[*].link | json | 링크 주소입니다. 예시: https://example.com/runbook가져오기 또는 입력 방법: 전체 접근 가능 URL을 입력하며 예시 도메인은 교체해야 합니다. |
|
| extend.sourceLink | json | 선택적 소스 링크이며 소스 유형에 따라 알림 템플릿에서 소비됩니다. 이 수정은 viewer 적용 시간 범위를 다시 계산하지 않으므로 일반 연동은 기존 값을 유지하면 됩니다. 예시: https://example.com/source?doc_time=1785430800000가져오기 또는 입력 방법: 콘솔 소스 페이지에서 전체 링크를 가져옵니다. viewer 소스의 doc_time은 Unix 밀리초를 사용합니다. |
|
| extend.extra.managerInfos | json | 담당자 이메일에서 표시 프로필 객체로의 매핑입니다. 이번에 비어 있지 않은 매핑을 제공하지 않고 기존 매핑이 있으면 이번 manager 배열에 여전히 포함된 이메일 항목만 유지하며, 다른 기존 표시 항목은 유지하지 않습니다. 예시: {"xxx@guance.com": {"name": "外部值班人"}}가져오기 또는 입력 방법: extend.manager의 이메일을 키로 사용하여 외부 담당자의 표시 정보를 입력합니다. |
|
| extend.extra.managerInfos.邮箱.name | json | 단일 이메일 담당자의 표시 이름입니다. 예시: 外部值班人가져오기 또는 입력 방법: 이메일 키는 담당자 배열의 이메일과 일치해야 하며, 이름은 외부 비즈니스 시스템에서 가져옵니다. |
|
| extend.extra.managerInfos.邮箱 | json | 이메일 표시 객체이며 name 문자열만 전달하는 것을 권장합니다. 예시: {"name": "外部值班人"}가져오기 또는 입력 방법: 키는 extend.manager의 동일한 이메일이어야 합니다. |
|
| attachmentUuids | array | 선택적 업로드된 첨부 파일 UUID 배열입니다. 생략, null 또는 []는 모두 기존 첨부 파일을 추가하거나 제거하지 않습니다. 비어 있지 않으면 각 항목을 이 Issue에 바인딩/재바인딩하며, 처리에 독립적인 커밋이 있어 본문 업데이트와 원자적임을 보장하지 않습니다. 해당 워크스페이스에 속하고 연결이 허용된다고 확인한 업로드된 첨부 파일만 제출할 수 있습니다. 유효하지 않거나 삭제된 UUID는 현재 전용 404 대신 500이 발생할 수 있습니다. 허용 null: True 예시: []가져오기 또는 입력 방법: 먼저 첨부 파일 업로드를 호출하고 content.attachmentUuid를 저장합니다. 이 워크스페이스에서 실제로 업로드되어 사용 가능한 첨부 파일만 사용할 수 있습니다. 생략 또는 []는 첨부 파일을 추가하지 않습니다. |
|
| description | string | 선택적 설명 문자열이며, 생략하면 유지되고 빈 문자열이면 비우며 null은 허용되지 않습니다. extend.text에서 자동 생성되지 않습니다. 허용 null: False 예시: 定位生产接口延迟,记录处理过程。가져오기 또는 입력 방법: 현상, 범위 및 처리 목표를 작성하며, 상세 진단 자료는 첨부 파일로 업로드할 수 있습니다. |
|
| extend | json | 선택적 확장 객체입니다. 생략하면 기존 저장 객체를 유지하고, 전체 객체를 제출하면 전체 교체됩니다. {}는 담당자/텍스트/표시 정보를 지울 수 있지만 기존 extra.creator는 조건부로 유지됩니다. 선언상 null을 허용하지만 현재 코드에서 .get 접근 시 500이 발생하므로 반드시 객체를 전달하거나 생략해야 합니다. 동적 하위 필드는 완전히 검증되지 않으며 잘못된 유형은 500을 유발할 수 있습니다. 허용 null: True 예시: {}가져오기 또는 입력 방법: 수정 전에 이 페이지 상세 content.extend를 읽고 전체 내용을 복사한 뒤 조정합니다. 제목/상태만 변경할 때는 생략할 수 있습니다. |
|
| level | string | 선택적 유효 등급 UUID이며, 생략하면 유지됩니다. 빈 문자열은 등급을 지우고 null은 허용되지 않습니다. 시스템 기본/워크스페이스 사용자 지정/백그라운드 전역 등급은 현재 유효 목록에서 가져오며, system_level_3을 고정적으로 P3로 간주하지 않습니다. 빈 문자열 허용: True 허용 null: False 예시: system_level_1가져오기 또는 입력 방법: 먼저 유효 등급 목록을 호출하여 실제 반환된 uuid를 사용합니다. 등급을 지정하지 않을 때는 빈 문자열을 전달합니다. |
|
| name | string | 선택적 새 제목이며 생략하면 유지됩니다. 최대 256 사용자 지정 길이 계산 단위(ASCII는 1, 중국어 등 비ASCII는 일반적으로 2)이며, 순수 중국어는 128자를 넘지 않는 것을 권장합니다. null은 허용되지 않습니다. 허용 null: False $maxCustomLength: 256 예시: checkout-api 延迟异常가져오기 또는 입력 방법: 문제 현상에 따라 명확한 제목을 작성합니다. |
|
| statusType | integer | 선택적 상태 정수 10 Open, 15 Working, 20 Resolved, 25 Closed, 30 Pending이며, 생략하면 유지됩니다. 명시적으로 제출할 때마다 값이 변경되지 않아도 작업 기록이 남습니다. 20/25는 resolveAt을 갱신하며, 다시 열어도 과거 resolveAt이 지워지지 않습니다. null은 허용되지 않습니다. 허용 null: False 선택 값: [10, 15, 20, 25, 30] 예시: 15가져오기 또는 입력 방법: 비즈니스 처리 진행에 따라 10/15/20/25/30을 선택합니다. |
파라미터 추가 설명¶
description은 실제 설명 필드입니다. 원문 설명의 decription은 과거 오타이며 요청 키로 사용할 수 없습니다. 기본 등급 이름은 설정과 언어를 따르며, system_level_3을 고정적으로 P3라고 부를 수 없습니다. 첨부 파일은 먼저 권한이 있는 /api/v1/attachment/upload를 통해 업로드하고 content.attachmentUuid를 가져와야 합니다. 이는 프런트엔드/OpenAPI 대응 진입점이며, 이 External 모듈에서 새로 추가한 업로드 진입점이 아닙니다.
전체 확장 객체 예시(실제 멤버/채널로 교체하고, 원본 객체 내 필요한 다른 키는 유지):
{
"extend": {
"text": "正在定位延迟原因。",
"channels": [
{
"uuid": "chan_example",
"type": "#",
"name": "生产异常"
}
],
"members": [
{
"uuid": "acnt_example",
"type": "@",
"name": "值班工程师"
}
],
"manager": [
"acnt_example"
],
"linkList": [
{
"name": "处理手册",
"link": "https://example.com/runbook"
}
],
"extra": {
"updator": {
"name": "外部系统操作人",
"email": "xxx@guance.com"
}
}
}
}
요청 예시¶
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 = 'POST'
path = '/api/v1/issue/issue_example001/modify'
query = {}
data = {'name': '生产接口延迟', 'statusType': 15}
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"))
응답¶
HTTP 200, 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 실제 생성 ID이며 extend.extra 표시 정보에 따라 변경되지 않습니다. |
| content.updator | string | 최근 업데이트 ID입니다. 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 실제 인증 ID를 변경하지 않습니다. |
| 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일 수 있습니다. 수정 응답은 실제 생성 ID 요약을 사용하며 해당 표시로 덮어쓰지 않습니다. |
| content.creatorInfo.name | string | 표시 이름이며 생략할 수 있습니다. |
| content.creatorInfo.email | string | 이메일이며 생략할 수 있습니다. |
| content.creatorInfo.uuid | string | 계정 UUID이며 생략할 수 있습니다. |
| content.updatorInfo | object | 업데이트자 표시 객체입니다. GET은 extend.extra.updator를 우선 사용하며, 수정 응답은 실제 SYS ID 요약을 사용합니다. |
| 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.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.creatorInfo.status | integer | 계정 레코드 상태이며 생략할 수 있습니다. |
| content.creatorInfo.wsAccountStatus | integer | 선택적 워크스페이스 상태입니다. 수정 응답의 계정 요약은 워크스페이스 컨텍스트 없이 읽으므로 이를 근거로 멤버가 Issue 워크스페이스에서 유효한 상태인지 판단할 수 없습니다. |
| 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 | 선택적 워크스페이스 상태입니다. 수정 응답의 계정 요약은 워크스페이스 컨텍스트 없이 읽으므로 이를 근거로 멤버가 Issue 워크스페이스에서 유효한 상태인지 판단할 수 없습니다. |
| 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 | 과거 등급 표시 정보의 선택 필드입니다. 생성 호출 ID이며 API Key 식별자, 계정 또는 시스템 ID일 수 있습니다. |
| content.levelInfo.updator | string | 과거 등급 표시 정보의 선택 필드입니다. 최근 업데이트 ID이며 설정되지 않은 경우 빈 문자열입니다. |
| 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 | 시스템 기본 등급 표시 플래그이며 생략할 수 있습니다. |
{
"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": "生产接口延迟",
"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
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | 요청 JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | JSON 객체를 제출합니다. 일반 필드만 변경할 때는 extend를 생략할 수 있습니다. |
| 406 | ft.IssueLevelNotExists | level이 비어 있지 않지만 해당 Issue 워크스페이스의 현재 유효 등급 집합에 없음 | 등급 구성이 존재하지 않음 | 유효 등급 목록에서 content.workspaceUUID에 따라 uuid를 가져옵니다. 빈 문자열은 등급을 지울 수 있습니다. |
| 406 | ft.ExceedMaxLengthLimit | extend.text 길이가 3000자를 초과 | 텍스트 최대 길이 제한 초과 | 순수 텍스트 길이를 줄입니다. 긴 진단 내용은 첨부 파일로 업로드한 뒤 연결할 수 있습니다. |
| 400 | ft.UnsupportFreeIssueManager | 무료/제한 플랜에서 비워크스페이스 멤버 이메일을 담당자로 설정 | 무료 플랜 워크스페이스에서는 인시던트 담당자를 외부 이메일로 지원하지 않습니다 | 워크스페이스 내 유효한 멤버/팀/알림 대상을 선택하거나 플랜과 이메일 범위를 먼저 확인합니다. |
| 500 | ft.InternalServerError | 대상이 없음/삭제됨, extend=null/동적 필드 유형 오류, 유효하지 않은 첨부 파일 UUID 또는 단계별 데이터베이스/응답/채널/알림 전달 예외 | 내부 오류 | 먼저 GET으로 최종 필드, 첨부 파일 및 채널을 확인하세요. 오류가 롤백을 증명하지는 않습니다. 본문 커밋이 완료된 후에도 실패할 수 있으며, 재시도 시 상태 기록과 알림이 증가할 수 있으므로 먼저 확인한 뒤 재시도하세요. |