수정¶
POST /api/v1/issue/{issue_uuid}/modify
개요¶
Issue 제목, 설명, 등급, 담당자, 처리 상태를 업데이트하고 변경 사항을 기록하며 알림을 전송합니다.
호출 전 및 사용 단계¶
먼저 Issue 상세를 읽고 유지해야 할 전체 extend 객체를 복사한 후 대상 필드를 제출합니다. name, description, level, statusType을 생략하면 현재 값을 유지합니다. extend는 현재 반드시 제출해야 하며, {}는 확장 내용을 대체하므로 기존 담당자 등의 정보가 지워질 수 있습니다. extend.channels는 이미 바인딩된 채널에 추가만 하며, []는 기존 채널을 해제하지 않습니다. 등급, 담당자 또는 상태를 업데이트하면 작업 기록이 생성됩니다. Resolved/Closed는 resolveAt을 기록하며, 다시 열어도 해당 이력 값은 지워지지 않습니다. 새 첨부 파일을 추가하려면 먼저 업로드한 후 attachmentUuids를 제출하여 바인딩합니다. 기존 첨부 파일 기록은 다시 연결할 수 있으며, 생략하거나 []를 전달해도 기존 바인딩은 지워지지 않습니다. 기존 첨부 파일을 제거하려면 첨부 파일 삭제 API를 사용합니다. API 성공이 알림 전달을 의미하지는 않습니다. 알림은 비동기로 실행되며, 수신자는 채널 구독, 알림 대상, 알림 정책, 담당자 및 이번 @ 멤버에 따라 달라집니다. 콘솔에서 알림 설정 및 실제 전달 여부를 확인하십시오. 쓰기와 후속 알림, 첨부 파일 처리는 단계적으로 실행되므로 실패하거나 시간 초과된 경우 먼저 리소스가 생성 또는 업데이트되었는지 조회한 후 재시도 여부를 결정하여 중복 기록과 알림을 방지하십시오.
경로 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| attachmentUuids[*] | json | 단일 업로드된 첨부 파일 UUID입니다. 예시: att_example가져오기 또는 입력 방법: 첨부 파일 업로드의 content.attachmentUuid에서 가져옵니다. |
|
| extend.text | json | 선택적 일반 텍스트로, 서버 측 길이 검사에 사용되며 최대 3000자입니다. 예시: 定位生产接口延迟。가져오기 또는 입력 방법: 설명의 일반 텍스트에서 추출하며 3000자 이내로 제한합니다. 생략하면 빈 텍스트로 검사합니다. |
|
| extend.channels | array | 채널 참조 배열입니다. 이미 바인딩된 채널에 추가 병합하며, []는 기존 바인딩을 지우지 않습니다. 예시: [{"type": "#", "uuid": "chan_example", "name": "生产异常"}]가져오기 또는 입력 방법: 채널 목록에서 실제 채널 UUID를 가져와 설명의 # 채널을 참조합니다. 생략하면 추가하지 않습니다. |
|
| extend.channels[*] | json | 채널 참조 객체입니다. 예시: {"type": "#", "uuid": "chan_example", "name": "生产异常"}가져오기 또는 입력 방법: 각 항목에 동일 워크스페이스의 실제 채널을 하나씩 선택합니다. |
|
| extend.channels[*].uuid | json | 채널 UUID입니다. 예시: chan_example가져오기 또는 입력 방법: 채널 목록의 content[].uuid에서 가져옵니다. |
|
| extend.channels[*].name | json | 클라이언트 표시 이름입니다. 예시: 生产异常가져오기 또는 입력 방법: 채널 목록에서 해당 name을 가져와 표시에 사용합니다. 생략할 수 있습니다. |
|
| extend.channels[*].type | json | 채널 참조 표시입니다. 예시: #가져오기 또는 입력 방법: 채널 참조는 고정적으로 #을 사용하며, 서버가 읽은 결과에 이 표시를 보완합니다. |
|
| extend.channels[*].exists | json | 선택적 표시 플래그로, 서버의 리소스 검증을 대체하지 않습니다. 예시: true가져오기 또는 입력 방법: 유효성 증빙으로 전달할 필요가 없으며, 조회 응답 시 현재 리소스 존재 여부에 따라 다시 계산됩니다. |
|
| extend.members | array | 이번 @ 멤버 참조로, 일회성 알림 이메일을 수집하는 데 사용됩니다. 담당자 배열이 아닙니다. 예시: [{"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 | 외부 표시 정보로, API의 실제 인증/작성자 신원을 대체하지 않습니다. 예시: {}가져오기 또는 입력 방법: 서드파티 통합에서 외부 작업자를 표시해야 할 때 입력합니다. 없으면 생략하거나 {}를 사용합니다. |
|
| extend.extra.creator | json | 생성자 표시 객체입니다. 예시: {"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 | 담당자 식별자 배열입니다. 담당자가 없으면 [] 또는 생략합니다. 수정 시 전체 대상 배열을 전달합니다. 유효하지 않은 계정/팀/알림 대상은 필터링될 수 있습니다. dutyPerson은 워크스페이스 시간대의 당일 온콜 캘린더에 따라 구체적인 대상으로 해석되며, 당일 HH:MM 시간대 기준으로 판단하지 않습니다. 이번 저장 후에는 이후 교대에 따라 자동으로 변경되지 않습니다. 예시: ["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 단일 데이터 분석 시 doc_time에 따라 덮어쓴 기록의 조회 창을 결정할 수 있습니다. 예시: https://example.com/source?doc_time=1785430800000가져오기 또는 입력 방법: 콘솔 소스 페이지에서 전체 링크를 가져옵니다. viewer 소스의 doc_time은 Unix 밀리초를 사용합니다. |
|
| extend.extra.managerInfos | json | 이메일 담당자 표시 정보 매핑이며 생략할 수 있습니다. 예시: {"xxx@guance.com": {"name": "外部值班人"}}가져오기 또는 입력 방법: extend.manager의 이메일을 키로 사용하여 외부 담당자의 표시 정보를 입력합니다. |
|
| extend.extra.managerInfos.邮箱.name | json | 개별 이메일 담당자의 표시 이름입니다. 예시: 外部值班人가져오기 또는 입력 방법: 이메일 키는 담당자 배열의 이메일과 일치해야 하며, 이름은 외부 비즈니스 시스템에서 가져옵니다. |
|
| attachmentUuids | array | 선택적 업로드된 첨부 파일 UUID 배열입니다. 비어 있지 않으면 각 항목을 이 Issue에 바인딩하거나 다시 바인딩합니다. 생략하거나 []를 전달해도 기존 첨부 파일은 삭제되지 않습니다. null 허용: True 예시: []가져오기 또는 입력 방법: 먼저 첨부 파일 업로드를 호출하여 content.attachmentUuid를 저장합니다. 이 워크스페이스에서 실제로 업로드되어 사용 가능한 첨부 파일만 사용할 수 있습니다. 생략하거나 []이면 첨부 파일을 추가하지 않습니다. |
|
| description | string | 선택적 새 설명이며, 생략하면 기존 값을 유지합니다. null 허용: False 예시: 定位生产接口延迟,记录处理过程。가져오기 또는 입력 방법: 현상, 범위, 처리 목표를 작성합니다. 상세 진단 자료는 첨부 파일로 업로드할 수 있습니다. |
|
| extend | json | Y | 필수 확장 객체이며 null을 전달하지 마십시오. 객체를 전달하면 저장된 확장 내용을 대체합니다. 일부 생성자 표시 정보는 서버에서 유지합니다. null 허용: True 예시: {}가져오기 또는 입력 방법: 확장 내용이 없으면 {}를 전달합니다. 수정 전에 먼저 원래 값을 읽고 전체 객체에서 변경할 필드를 조정합니다. |
| level | string | 선택적 새 등급 UUID입니다. 생략하면 현재 등급을 유지하고, 빈 문자열은 등급을 지웁니다. 빈 문자열 허용: True null 허용: False 예시: system_level_1가져오기 또는 입력 방법: 먼저 유효 등급 목록을 호출하여 실제 반환된 uuid를 가져옵니다. 등급을 지정하지 않을 때는 빈 문자열을 전달합니다. |
|
| name | string | Issue 제목이며 최대 256자입니다. null 허용: False $maxCustomLength: 256 예시: checkout-api 延迟异常가져오기 또는 입력 방법: 문제 현상에 따라 명확한 제목을 작성합니다. |
|
| statusType | integer | 선택적 상태입니다. 생략하면 변경되지 않습니다. 상태: 10 Open, 15 Working, 20 Resolved, 25 Closed, 30 Pending. null 허용: False 선택 가능한 값: [10, 15, 20, 25, 30] 예시: 15가져오기 또는 입력 방법: 비즈니스 처리 진행 상황에 따라 10/15/20/25/30을 선택합니다. |
파라미터 추가 설명¶
이 API는 resourceType/resourceUUID/resource를 수정하지 않으며, Issue 삭제도 제공하지 않습니다. 첨부 파일 관리는 답글 생성 및 첨부 파일 삭제와 함께 처리하십시오. 일괄 재시도 전에 먼저 최종 상태를 조회하십시오.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue/issue_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"statusType":15,"extend":{}}'
응답¶
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.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": 15,
"statusTypeUpdateRecord": [
"1785430800&&Working"
],
"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": [],
"attachments": [],
"declaration": {}
},
"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 객체를 제출하십시오. |
| 404 | ft.ObjectNotExists | 지정한 리소스가 현재 워크스페이스에 없거나 조회 조건에 맞지 않음 | 지정한 객체가 존재하지 않음 | 동일 워크스페이스 리소스 UUID를 다시 가져오고, 삭제되었는지 확인하십시오. |
| 406 | ft.IssueLevelNotExists | level이 현재 워크스페이스의 유효 등급 집합에 속하지 않음 | 등급 설정이 존재하지 않음 | 먼저 유효 등급 목록을 조회하여 반환된 uuid를 가져오십시오. 등급을 설정하지 않으려면 파라미터 설명에 따라 빈 문자열을 전달할 수 있습니다. |
| 406 | ft.ExceedMaxLengthLimit | extend.text 길이가 3000자를 초과함 | 텍스트 최대 길이 제한 초과 | 일반 텍스트 필드를 줄이고, 대량의 진단 자료는 첨부 파일로 업로드하십시오. |
| 400 | ft.UnsupportFreeIssueManager | 제한된 워크스페이스 버전에서 본 공간 멤버가 아닌 외부 이메일을 담당자로 사용함 | 무료 플랜 워크스페이스에서는 인시던트 담당자를 외부 이메일로 지정할 수 없습니다 | 본 워크스페이스 멤버를 선택하거나, 해당 버전이 외부 이메일 담당자를 지원하는지 확인하십시오. |
| 500 | ft.InternalServerError | 등급 또는 설정 저장, 감사 또는 기타 내부 처리 실패 | 내부 오류 | 먼저 현재 등급 또는 설정을 읽어 결과를 확인한 후 재시도 여부를 결정하십시오. 계속 실패하면 traceId를 제공하십시오. |