자동 발견 설정 목록¶
GET /api/v1/issue_auto_discovery/list
개요¶
Issue 자동 발견 설정을 페이지 단위로 나열합니다.
호출 전 및 사용 단계¶
이 모듈은 기존 인시던트 Issue 자동 발견 설정이며, 인시던트 센터 Incidents의 교대 근무/자동 집계가 아니고 오류 센터 ErrorTrack 규칙도 아닙니다. 현재 공개 쓰기 dqlNamespace는 keyevent만 가능하며, rum/tracing 이전 예시는 현재 선언과 일치하지 않습니다. 백그라운드에서 이미 마이그레이션된 issueUpgrade=true 워크스페이스는 이 v2 자동 발견 작업을 건너뛰므로, 설정 성공만으로 해당 워크스페이스에서 새 Issue가 생성된다고 보장할 수 없습니다.
권한은 routine.defaultAccess/anomaly.channelManage/anomaly.issueDiscovery 중 하나를 충족해야 합니다. createAt 내림차순으로 삭제되지 않은 규칙을 읽으며 비활성 항목도 포함합니다. 현재 dqlNamespace/isDisable 파라미터는 존재하지만 구현에서 무시되므로, 반드시 각 항목의 필드를 읽어 직접 필터링해야 합니다. content={data,declaration}이며 pageInfo는 최상위에 있고, data 항목에는 선언이 재귀적으로 추가되지 않습니다.
설정 저장은 즉시 쿼리를 실행하거나 생성 작업을 반환하지 않습니다. 스케줄은 Asia/Shanghai 캘린더에 맞춰 주기를 정렬하여 이전 every초 윈도우를 처리하며, 작업 큐/쿼리 소요 시간으로 인해 지연될 수 있습니다. keyevent는 monitor 이벤트에서 집계하며 dimensions 기준으로 최대 1000개 그룹을 생성하고, 넓은 범위의 완전한 커버리지를 보장하지 않습니다. 그룹 차원을 정렬한 JSON으로 중복 식별자를 생성하며 규칙 UUID는 이 식별자에 포함되지 않으므로, 동일 워크스페이스에서 동일 차원 값을 가진 여러 규칙이 동일한 기존 Issue에 연결될 수 있고, 차원/필터를 수정하면 그룹 결과가 달라질 수 있습니다. 이를 규칙별로 독립적이며 절대 교차하지 않는 Issue 집합으로 간주하지 마십시오. Open/Pending 상태는 답글이 추가되고, Resolved는 재오픈되어 회귀할 수 있으며, Closed는 재사용되지 않습니다. 기존 Working 브랜치는 실제 구현에 따라 처리되며, 작업 중 완전한 격리를 보장하지 않습니다. 알림은 비동기이며 HTTP 200은 데이터 쿼리 성공/새 Issue 생성/알림 전달을 의미하지 않습니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Query 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| dqlNamespace | string | 선언되어 있지만 현재 목록 구현에서는 이 필터를 적용하지 않으므로, 전달해도 데이터 범위가 제한되지 않습니다. 반드시 반환 항목의 dqlNamespace를 확인해야 합니다. null 허용: False 예: keyevent획득 또는 입력 방법: 이전 호환 쿼리 파라미터입니다. |
|
| isDisable | string | 현재 목록 구현에서는 활성/비활성 필터를 적용하지 않으므로 true/false를 전달해도 해당 상태로 필터링된다고 보장할 수 없으며, 반환된 status를 기준으로 직접 필터링해야 합니다. null 허용: False 선택 가능 값: ['true', 'false'] 예: false획득 또는 입력 방법: 이전 호환 문자열 파라미터 true/false입니다. |
|
| pageIndex | integer | 선택적 정수이며 생략 시 1입니다. 선언에는 양수/상한이 설정되어 있지 않고, 클라이언트는 양수만 사용합니다. null 허용: False 예: 1획득 또는 입력 방법: 최상위 pageInfo 기준으로 첫 페이지부터 페이지네이션합니다. |
|
| pageSize | integer | 선택적 정수이며 생략 시 20입니다(예시의 10은 기본값이 아닙니다). 선언에는 상한이 없으며, 작은 페이지의 합리적인 양수를 권장합니다. null 허용: False 예: 20획득 또는 입력 방법: 읽기량에 맞춰 페이지 크기를 제어합니다. |
|
| search | string | 선택 사항으로 앞뒤 공백을 제거한 뒤 SQL ILIKE 퍼지 매칭을 수행합니다. 생략하거나 공백이면 필터링하지 않으며 %/_는 와일드카드 의미를 유지합니다. 빈 문자열 허용: True null 허용: False 예: 生产획득 또는 입력 방법: 규칙 이름 검색입니다. |
파라미터 추가 설명¶
현재 공개 범위는 keyevent입니다. 설정 저장, 스케줄 실행, 알림 전달은 서로 다른 단계이며, 파라미터와 전체 응답/오류 경계는 아래를 참고하십시오.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/issue_auto_discovery/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | object | 페이지네이션 콘텐츠 객체입니다. |
| content.data | array<object> |
이 페이지의 규칙이며, 일치 항목이 없으면 []입니다. |
| content.data[].id | integer 또는 null | 데이터베이스 행 ID로 경로 탐색에는 사용하지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.data[].uuid | string | 자동 발견 규칙 UUID이며 iatdc_ 접두사를 가집니다. |
| content.data[].status | integer | 0 활성, 2 비활성, 3 소프트 삭제이며 조회 시 3은 제외됩니다. |
| content.data[].creator | string | 생성 주체 UUID이며, 현재 공개 진입점에서는 일반적으로 wsak_입니다. |
| content.data[].updator | string 또는 null | 갱신 주체이며, 생성 스냅샷에서는 비어 있거나 null일 수 있습니다. |
| content.data[].createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.data[].updateAt | integer 또는 null | Unix 초 단위 갱신 시간이며, 제출 전 생성 스냅샷에서는 null일 수 있고 이후 데이터베이스 기본값/갱신 값은 -1 또는 실제 시간일 수 있습니다. |
| content.data[].deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 보통 -1입니다. |
| content.data[].workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.data[].name | string | 규칙 이름입니다. |
| content.data[].description | string | 규칙 설명이며 Issue 본문 템플릿이 아닙니다. |
| content.data[].dqlNamespace | string | 현재 공개 쓰기는 keyevent이며, 이전 레코드는 다른 네임스페이스일 수 있고 이는 공개 API로 다시 쓸 수 있음을 의미하지 않습니다. |
| content.data[].every | integer | 주기(초)입니다. |
| content.data[].conditions | string | 저장된 DQL 필터 표현식이며, 실행 검증에 성공했음을 의미하지 않습니다. |
| content.data[].dimensions | array<string> |
그룹 필드 이름 배열이며, 이전 오류 유형은 허용 오차 처리가 필요합니다. |
| content.data[].dimensions[] | string | 하나의 이벤트 필드 이름입니다. |
| content.data[].config | object | Issue 생성 정의 템플릿입니다. |
| content.data[].config.name | string | 필수 문자열로 최대 256자이며, Issue 제목 템플릿으로 규칙 name과 다릅니다. {{service}}/{{count}} 등 word 변수 이름을 지원하고 알 수 없는 변수는 그대로 유지됩니다. 임의의 Python/Jinja 표현식은 지원하지 않으며, 점/하이픈이 포함된 필드는 치환이 보장되지 않습니다. |
| content.data[].config.level | string | 선택적 등급 UUID 또는 빈 문자열이며, 비어 있지 않으면 현재 유효해야 하고 그렇지 않으면 406입니다. 생략하면 지정 등급이 없습니다. 인시던트 센터 등급 UUID의 범용 대체 필드가 아닙니다. |
| content.data[].config.channelUUIDs | array | 선택적 채널 UUID 배열이며, 명시된 항목은 현재 활성이어야 합니다. 항상 [] 또는 유효한 배열을 전달하는 것을 권장하며, 생략하면 저장은 되지만 작업이 None을 순회하다 실패할 수 있습니다. 작업은 기본 채널 연결을 자동으로 보완하지만, 저장 자체는 []라도 워크스페이스에 활성 채널이 최소 하나 존재해야 합니다. |
| content.data[].config.channelUUIDs[] | string | 단일 활성 채널 UUID이며 차원 필드/팀 UUID가 아닙니다. 알 수 없거나 비활성이면 404입니다. |
| content.data[].config.description | string | 선언상 선택적 문자열이지만 이후 작업이 이 키를 직접 읽으므로 항상 명시적으로 제공하는 것을 권장합니다(빈 문자열 가능). config 수정은 전체 교체이므로 하위 키를 생략해도 이전 값이 유지되지 않습니다. |
| content.data[].config.extend.text | string | 명시적 문자열을 권장합니다. 작업이 이 값을 읽어 템플릿 치환하며, 누락되거나 문자열이 아니면 비동기적으로 실패할 수 있습니다. config.description과 함께 각각 저장되는 텍스트 필드입니다. |
| content.data[].config.extend.manager | array | 선택적 담당자 문자열 배열입니다. 유효한 acnt_/현재 워크스페이스 팀/이메일/dutyPerson은 유지되고, 알 수 없는 계정/알 수 없는 값은 조용히 제거될 수 있으며 항목별 오류 보고는 보장하지 않습니다. 무료/무료 플랜 워크스페이스는 외부 이메일을 지원하지 않으며 400이 발생할 수 있습니다. 담당자가 없으면 미할당 에스컬레이션 절차로 진입할 수 있습니다. |
| content.data[].config.extend.manager[] | string | 하나의 유효한 주체, 이메일 또는 dutyPerson이며, 문자열이 아니면 문자열 startswith 처리 중 500이 발생할 수 있습니다. |
| content.data[].config.extend.conditionsInputFilters | any | 선택적 임의 JSON으로, 이전 Issue/알림 이벤트 점프 시 추가 필터를 보완해 표시하기 위한 것입니다. 실제 쿼리는 여전히 최상위 conditions를 사용하므로 이 키만 수정해 대체할 수 없습니다. |
| content.data[].config.extend.variable | json | 요청 시 입력을 권장하지 않습니다. 작업이 실제 쿼리 컬럼으로 이 객체를 덮어쓰며, 일반적으로 count는 윈도우 내 건수입니다. |
| content.data[].config.extend.variable.count | integer | 런타임 발생 횟수이며, 호출자가 입력한 값은 신뢰할 수 있는 고정 값으로 적용되지 않습니다. |
| content.data[].config.extend.tags | json | 요청 시 입력을 권장하지 않습니다. 작업이 실제 그룹 tags로 덮어쓰며 Issue 중복 제거 및 템플릿 변수에 참여합니다. |
| content.data[].config.extend.tags.字段 | any | 동적 JSON 태그 값이며, 호출자가 직접 입력한 값으로 그룹 생성이 고정된다고 볼 수 없습니다. |
| content.data[].config.extend.channelUUIDs | array | 런타임에 유효한 설정 채널로 덮어쓰이며, 이 확장 필드로 config.channelUUIDs를 대체할 수 없습니다. |
| content.data[].config.extend.channelUUIDs[] | string | 런타임의 유효한 채널 식별자 하나입니다. |
| content.data[].config.extend.自定义键 | any | 임의의 JSON 저장 값이며, 이 페이지에 공개된 추가 실행 보장은 없습니다. 자격 증명을 넣지 마십시오. |
| content.data[].config.extend | object 또는 null | 저장된 확장입니다. 새 요청은 객체를 사용해야 하며, null이면 동기 감사 또는 이후 작업에서 예외가 발생합니다. |
| content.data[].creatorInfo | object | 목록/상세에附加된 주체 요약이며, 일치 항목이 없으면 {}입니다. |
| content.data[].creatorInfo.uuid | string | 주체 UUID로 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.data[].creatorInfo.status | integer | 주체 상태입니다. |
| content.data[].creatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버십 관계 상태 요약입니다. |
| content.data[].creatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.data[].creatorInfo.name | string | 표시 이름입니다. |
| content.data[].creatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.email | string | 이메일이며, 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로 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.data[].updatorInfo.status | integer | 주체 상태입니다. |
| content.data[].updatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버십 관계 상태 요약입니다. |
| content.data[].updatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.data[].updatorInfo.name | string | 표시 이름입니다. |
| content.data[].updatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.email | string | 이메일이며, Key 주체는 자신의 UUID일 수 있고 전달 가능성은 보장되지 않습니다. |
| content.data[].updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| pageInfo | object | 페이지네이션 메타 정보로 OpenAPI에서는 최상위에 있습니다. content는 객체로 유지됩니다. |
| pageInfo.count | integer | 이 페이지의 실제 건수입니다. |
| pageInfo.totalCount | integer | 현재 유효한 필터를 충족하는 자동 발견 설정 총 개수이며, 생성된 Issue 수가 아닙니다. |
| pageInfo.pageIndex | integer | 페이지 번호로 1부터 시작합니다. |
| pageInfo.pageSize | integer | 이번 요청의 페이지당 건수입니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공용 선언이며, content 상위 객체에만 추가되고 data 항목에는 재귀적으로 추가되지 않습니다. |
{
"code": 200,
"content": {
"data": [
{
"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",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 20
}
}
오류 응답¶
인증, 속도 제한 및 공용 요청 오류는 공용 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반한 경우 | 파라미터 파싱 실패 | Query 파라미터 표와 예시를 확인하십시오. |
| 500 | ft.InternalServerError | 데이터베이스 읽기, 이전 구조 또는 신원 요약 구성 중 예외 발생 | 내부 오류 | 필드와 traceId를 확인하고 백오프 재시도하며, 관리자에게 이전 설정 점검을 요청하십시오. |