자동 발견 설정 조회¶
GET /api/v1/issue_auto_discovery/{cfg_uuid}/get
개요¶
Issue 자동 발견 규칙 및 템플릿을 읽습니다.
호출 전 및 사용 단계¶
이 모듈은 기존 인시던트 Issue 자동 발견 설정이며, 인시던트 센터 Incidents 온콜 스케줄/자동 집계가 아니고 오류 센터 ErrorTrack 규칙도 아닙니다. 현재 공개 쓰기에서 dqlNamespace는 keyevent만 가능하며, rum/tracing의 이전 예시는 현재 선언과 일치하지 않습니다. 백엔드에서 issueUpgrade=true로 마이그레이션된 워크스페이스는 이 v2 자동 발견 작업을 건너뛰므로, 설정 성공만으로 해당 워크스페이스에서 새 Issue가 생성된다고 보장할 수 없습니다.
권한은 trace.issueDiscovery/rum.issueDiscovery/anomaly.issueDiscovery 중 하나를 충족해야 합니다. 현재 워크스페이스의 삭제되지 않은 규칙만 대상으로 하며, 누락 시 404 레거시 오류 ft.LogIndexCfgNoExists가 발생합니다. 전체 설정과 생성/수정 주체 요약을 반환하며, 생성된 Issue/작업 실행 결과는 제공하지 않습니다.
설정 저장은 즉시 쿼리를 실행하거나 생성 작업을 반환하지 않습니다. 예약은 Asia/Shanghai 달력에 맞춰 주기를 정렬하고 이전 every초 윈도우를 처리하며, 작업 큐/쿼리 소요 시간에 따라 지연될 수 있습니다. keyevent는 monitor 이벤트에서 집계하며, dimensions에 따라 최대 1000개 그룹을 생성하고, 넓은 범위의 완전한 커버리지를 보장하지 않습니다. 그룹 차원을 정렬한 JSON으로 중복 제거 식별자를 생성하며, 규칙 UUID는 이 식별자에 포함되지 않습니다. 여러 규칙이 같은 워크스페이스에서 동일한 차원 값을 가지면 동일한 기존 Issue에 연결될 수 있고, 차원/필터를 수정하면 그룹 결과가 달라질 수 있습니다. 이를 규칙별로 독립적이며 결코 교차하지 않는 Issue 집합으로 간주하지 마세요. Open/Pending 상태에는 답글이 추가되고, Resolved는 재오픈되어 회귀할 수 있으며, Closed는 재사용되지 않습니다. 레거시 Working 분기는 실제 구현에 따라 처리되며, 작업 중 완전한 격리를 보장하지 않습니다. 알림은 비동기이며, HTTP 200은 데이터 쿼리 성공/새 Issue 생성/알림 전달을 의미하지 않습니다.
경로 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| cfg_uuid | string | Y | 현재 Key 워크스페이스의 삭제되지 않은 규칙이며, 상태 0(활성화) 또는 2(비활성화) 모두 읽기/수정할 수 있습니다. 누락 시 레거시 호환 오류 ft.LogIndexCfgNoExists를 사용하며, 메시지에는 로그 인덱스라고 표시되지만 실제로는 이 규칙 UUID를 확인해야 합니다. 예시: iatdc_example가져오기 또는 입력 방법: Issue 자동 발견 규칙 목록에서 content.data[].uuid(iatdc_)를 가져오며, Issue UUID 또는 ErrorTrack 규칙 UUID를 사용하지 마세요. |
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
현재 공개 범위는 keyevent입니다. 설정 저장, 예약 실행, 알림 전달은 서로 다른 단계이며, 파라미터와 전체 응답/오류 경계는 아래를 참조하세요.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 전체 설정 및 주체 요약. |
| content.id | integer 또는 null | 데이터베이스 행 ID이며 경로 위치 지정에 사용되지 않습니다. 제출 전 스냅샷은 null일 수 있습니다. |
| content.uuid | string | 자동 발견 규칙 UUID이며 iatdc_ 접두사를 사용합니다. |
| content.status | integer | 0 활성화, 2 비활성화, 3 소프트 삭제. 읽기 시 3은 제외됩니다. |
| content.creator | string | 생성 주체 UUID이며, 현재 공개 진입점에서는 일반적으로 wsak_입니다. |
| content.updator | string 또는 null | 수정 주체이며, 생성 스냅샷에서는 비어 있거나 null일 수 있습니다. |
| content.createAt | integer | Unix 초 단위 생성 시간. |
| content.updateAt | integer 또는 null | Unix 초 단위 수정 시간이며, 제출 전 생성 스냅샷은 null일 수 있고, 이후 데이터베이스 기본값/수정 값은 -1 또는 실제 시간일 수 있습니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.workspaceUUID | string | 현재 Key가 속한 워크스페이스. |
| content.name | string | 규칙 이름. |
| content.description | string | 규칙 설명이며 Issue 본문 템플릿이 아닙니다. |
| content.dqlNamespace | string | 현재 공개 쓰기는 keyevent입니다. 기존 레코드는 다른 네임스페이스일 수 있으며, 이는 공개 인터페이스로 다시 쓸 수 있음을 의미하지 않습니다. |
| content.every | integer | 주기(초). |
| content.conditions | string | 저장된 DQL 필터 표현식이며, 실행 성공이 검증되었음을 의미하지 않습니다. |
| content.dimensions | array<string> |
그룹 필드 이름 배열이며, 레거시 오류 유형은 내결함성을 가져야 합니다. |
| content.dimensions[] | string | 하나의 이벤트 필드 이름. |
| content.config | object | Issue 생성 정의 템플릿. |
| content.config.name | string | 필수 문자열로 최대 256자이며, Issue 제목 템플릿으로 규칙 name과 다릅니다. {{service}}/{{count}} 등 word 변수명을 지원하고 알 수 없는 변수는 그대로 유지됩니다. 임의의 Python/Jinja 표현식은 지원하지 않으며, 점/하이픈이 있는 필드는 치환을 보장하지 않습니다. |
| content.config.level | string | 선택적 레벨 UUID 또는 빈 문자열이며, 비어 있지 않으면 현재 유효해야 하고 그렇지 않으면 406입니다. 생략하면 지정된 레벨이 없습니다. 인시던트 센터 레벨 UUID의 범용 대체 필드가 아닙니다. |
| content.config.channelUUIDs | array | 선택적 채널 UUID 배열이며, 명시된 항목은 현재 활성 상태여야 합니다. 항상 [] 또는 유효한 배열을 전달하는 것이 권장됩니다. 생략해도 저장은 가능하지만 작업이 None을 순회하다 실패할 수 있습니다. 작업은 기본 채널 연결을 자동으로 보완하지만, 저장 자체는 워크스페이스에 하나 이상의 활성 채널이 있어야 하며 []인 경우에도 마찬가지입니다. |
| content.config.channelUUIDs[] | string | 단일 활성 채널 UUID이며, 차원 필드/팀 UUID가 아닙니다. 알 수 없거나 비활성화된 경우 404입니다. |
| content.config.description | string | 선언상 선택적 문자열이지만 후속 작업이 이 키를 직접 읽으므로 항상 명시적으로 제공하는 것이 권장됩니다(빈 문자열 가능). config 수정은 전체 교체이므로 하위 키를 생략해도 이전 값이 유지되지 않습니다. |
| content.config.extend.text | string | 명시적 문자열을 권장합니다. 작업이 읽어 템플릿 치환을 수행하며, 누락되었거나 문자열이 아니면 비동기적으로 실패할 수 있습니다. config.description과 마찬가지로 각각 저장되는 텍스트 필드입니다. |
| content.config.extend.manager | array | 선택적 담당자 문자열 배열입니다. 유효한 acnt_/현재 워크스페이스 팀/이메일/dutyPerson은 유지되고, 알 수 없는 계정/알 수 없는 값은 조용히 제거될 수 있으며 항목별 오류 보고를 보장하지 않습니다. 무료/체험 워크스페이스는 외부 이메일을 지원하지 않으며 400이 발생할 수 있습니다. 담당자가 없으면 미할당 에스컬레이션 프로세스로 진입할 수 있습니다. |
| content.config.extend.manager[] | string | 하나의 유효한 주체, 이메일 또는 dutyPerson입니다. 문자열이 아니면 문자열 startswith 처리 시 500이 발생할 수 있습니다. |
| content.config.extend.conditionsInputFilters | any | 선택적 임의 JSON으로, 기존 Issue/알림 이벤트 이동 시 필터 보충 표시를 제공합니다. 실제 쿼리는 여전히 최상위 conditions를 사용하므로 이 키만 수정하여 이를 대체할 수 없습니다. |
| content.config.extend.variable | json | 요청 시 입력을 권장하지 않습니다. 작업이 실제 쿼리 열로 해당 객체를 덮어쓰며, 일반적인 count는 윈도우 내 건수입니다. |
| content.config.extend.variable.count | integer | 런타임 발생 횟수이며, 호출자 입력은 신뢰할 수 있는 고정 값으로 적용되지 않습니다. |
| content.config.extend.tags | json | 요청 시 입력을 권장하지 않습니다. 작업이 실제 그룹 tags로 덮어쓰며, Issue 중복 제거 및 템플릿 변수에 참여합니다. |
| content.config.extend.tags.字段 | any | 동적 JSON 태그 값이며, 호출자가 수동 입력한 값으로 그룹 생성을 고정할 수 없습니다. |
| content.config.extend.channelUUIDs | array | 실행 시 유효한 설정 채널로 덮어쓰이며, 이 확장 필드로 config.channelUUIDs를 대체하지 않습니다. |
| content.config.extend.channelUUIDs[] | string | 하나의 런타임 유효 채널 식별자. |
| content.config.extend.自定义键 | any | 임의 JSON 저장 값이며, 이 페이지에서 공개된 추가 실행 보장은 없습니다. 자격 증명을 넣지 마세요. |
| content.config.extend | object 또는 null | 저장된 확장입니다. 새 요청은 객체를 사용해야 하며, null이면 동기 감사 또는 후속 작업에 예외가 발생할 수 있습니다. |
| content.creatorInfo | object | 목록/상세에 추가되는 주체 요약이며, 일치 항목이 없으면 {}입니다. |
| content.creatorInfo.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.creatorInfo.status | integer | 주체 상태. |
| content.creatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버십 상태 요약. |
| content.creatorInfo.username | string | 로그인 이름 또는 Key 이름. |
| content.creatorInfo.name | string | 표시 이름. |
| content.creatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.creatorInfo.email | string | 이메일이며, Key 주체는 자체 UUID일 수 있고 전달 가능성을 보장하지 않습니다. |
| content.creatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.creatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.creatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| content.updatorInfo | object | 목록/상세에 추가되는 주체 요약이며, 일치 항목이 없으면 {}입니다. |
| content.updatorInfo.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.updatorInfo.status | integer | 주체 상태. |
| content.updatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버십 상태 요약. |
| content.updatorInfo.username | string | 로그인 이름 또는 Key 이름. |
| content.updatorInfo.name | string | 표시 이름. |
| content.updatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.updatorInfo.email | string | 이메일이며, Key 주체는 자체 UUID일 수 있고 전달 가능성을 보장하지 않습니다. |
| content.updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.updatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.updatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| content.declaration | object 또는 null | 현재 워크스페이스 공통 선언. |
{
"code": 200,
"content": {
"id": 7,
"uuid": "iatdc_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": null,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "生产事件自动发现",
"description": "按服务聚合生产告警",
"dqlNamespace": "keyevent",
"every": 300,
"conditions": "`df_status` = 'error'",
"dimensions": [
"service"
],
"config": {
"name": "服务{{service}}告警",
"description": "本窗口{{count}}条事件",
"channelUUIDs": [],
"extend": {
"text": "服务{{service}}发现{{count}}条事件",
"manager": []
}
},
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.LogIndexCfgNoExists | 현재 워크스페이스에서 삭제되지 않은 자동 발견 규칙이 존재하지 않음/삭제됨/다른 워크스페이스 | 지정된 로그 인덱스 설정이 존재하지 않습니다 | 현재 워크스페이스의 자동 발견 목록에서 iatdc_ UUID를 새로고침하세요. 이는 레거시에서 재사용된 오류 문구이므로 새 로그 인덱스를 생성하러 가지 마세요. |
| 500 | ft.InternalServerError | 데이터베이스 읽기, 레거시 구조 또는 주체 요약 생성 중 예외 | 내부 오류 | 필드와 traceId를 확인하고 백오프 재시도하세요. 관리자에게 레거시 설정 점검을 요청하세요. |