자동 검색 구성 수정¶
POST /api/v1/issue_auto_discovery/{cfg_uuid}/modify
개요¶
Issue 자동 검색 구성과 전체 Issue 템플릿을 수정합니다.
호출 전 및 사용 단계¶
이 모듈은 기존 인시던트 Issue 자동 검색 구성이며, 인시던트 센터 Incidents의 온콜/자동 집계나 오류 센터 ErrorTrack 규칙이 아닙니다. 현재 공개 쓰기에서 dqlNamespace는 keyevent만 가능하며, rum/tracing 관련 기존 예시는 현재 선언과 맞지 않습니다. 백그라운드에서 issueUpgrade=true로 마이그레이션된 워크스페이스는 이 v2 자동 검색 작업을 건너뛰므로, 구성 저장 성공만으로 해당 워크스페이스에서 새 Issue가 생성된다고 보장할 수 없습니다.
권한은 trace.issueDiscovery/rum.issueDiscovery/anomaly.issueDiscovery 중 하나를 충족해야 합니다. 규칙 name과 생성되는 Issue의 config.name은 서로 다른 두 필드입니다. every는 300/600/900/1800/3600만 가능하며, 60은 이전 열거형에 나타나지만 선행 최솟값 검사에서 거부됩니다. dimensions에는 명시적인 비어 있지 않은 필드 이름을 사용하고, config에는 description, channelUUIDs, extend.text를 명시적으로 제공하세요. 그렇지 않으면 저장에 성공한 후에도 작업이 누락된 키/잘못된 쿼리로 인해 실패할 수 있습니다.
name/dqlNamespace/every/config는 여전히 공개 필수 항목이며, config는 매번 전체 교체되고 이전 하위 키는 자동으로 유지되지 않습니다. 최상위 description/conditions/dimensions를 생략하면 유지되고, description/conditions를 명시적으로 비우면 삭제되며, dimensions가 나타날 때 []일 수 없습니다. conditions 값 변경은 첫 번째 제출 후 별도 제출에서 연관된 statusType=10이고 status0인 Issue.eventCount를 0으로 초기화합니다. 차원/주기만 변경하면 동일한 초기화가 자동으로 수행되지 않으며 기존 제목/이전 답글도 다시 기록하지 않습니다. 2차/동기 감사 실패 시 구성이 이미 저장되었을 수 있으므로 먼저 확인하세요.
config.extend.manager는 정규화되며, 알 수 없는 계정/대상은 조용히 제거될 수 있습니다. 명시적 null은 선언상 허용되지만 현재 감사/처리에서 직접 .get을 호출하여 500이 발생하므로 전달하지 마세요. dutyPerson을 포함하면 기존 인시던트 알림 일정을 사용하며 인시던트 센터 온콜이 아닙니다. {{변수}}는 그룹 태그/집계 count의 word 키로만 치환되고, 알 수 없는 변수는 원래대로 유지되며, 임의의 템플릿 코드는 실행되지 않습니다.
구성 저장은 쿼리를 즉시 실행하거나 생성 작업을 반환하지 않습니다. 예약 실행은 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를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| dimensions[*] | string | 단일 필드 이름 문자열입니다. 원본 선언은 하위 항목을 제약하지 않습니다. 문자열이 아니면 동기 감사 자료 조합 시 500이 발생합니다. add는 일반적으로 제출 전에 실패하고, modify는 첫 번째 제출 후 실패할 수 있습니다. 문자열이지만 필드가 존재하지 않으면 백그라운드 쿼리 시 실패하거나 데이터가 없을 수 있습니다. 백틱/전체 쿼리 조각을 필드 이름으로 사용하지 마세요. 예시: service획득 또는 입력 방법: 이벤트 필드/태그 이름이며 모든 대상 데이터에 해당 필드가 있는지 확인하세요. |
|
| config.channelUUIDs[*] | string | 단일 활성 채널 UUID입니다. 차원 필드/팀 UUID가 아니며, 알 수 없거나 비활성인 경우 404입니다. 예시: chan_example획득 또는 입력 방법: 현재 워크스페이스 채널 요약 목록의 uuid입니다. |
|
| config.extend.text | string | 명시적 문자열을 권장합니다. 작업이 읽어 템플릿 치환하며, 누락/비문자열이면 비동기 실패할 수 있습니다. config.description과 각각 저장되는 텍스트 필드입니다. 예시: 服务{{service}}发现{{count}}条事件획득 또는 입력 방법: dimensions 태그 및 집계 count에 따라 Issue 본문 템플릿을 구성합니다. |
|
| config.extend.manager | array | 선택적 담당자 문자열 배열입니다. 유효한 acnt_/현재 워크스페이스 팀/이메일/dutyPerson은 유지되고, 알 수 없는 계정/알 수 없는 값은 조용히 제거될 수 있으며 항목별 오류 보고를 보장하지 않습니다. 무료/체험 워크스페이스는 외부 이메일을 지원하지 않으며 400이 발생할 수 있습니다. 담당자가 없으면 미할당 에스컬레이션 절차로 진행될 수 있습니다. 예시: []획득 또는 입력 방법: 워크스페이스 멤버에서 acnt_를, 팀 목록에서 group_을 가져오거나, 멤버/허용된 외부 이메일을 사용합니다. 기존 인시던트의 오늘 온콜 담당자가 필요하면 리터럴 값 dutyPerson을 사용하세요. 구성은 알림 일정을 참고하세요. |
|
| config.extend.manager[*] | string | 하나의 유효한 주체, 이메일 또는 dutyPerson입니다. 문자열이 아니면 문자열 startswith 처리 시 500이 발생할 수 있습니다. 예시: acnt_example획득 또는 입력 방법: 워크스페이스 멤버에서 acnt_를, 팀 목록에서 group_을 가져오거나, 멤버/허용된 외부 이메일을 사용합니다. 기존 인시던트의 오늘 온콜 담당자가 필요하면 리터럴 값 dutyPerson을 사용하세요. 구성은 알림 일정을 참고하세요. |
|
| config.extend.conditionsInputFilters | any | 선택적 임의 JSON으로, 과거 Issue/알림 이벤트 점프 시 보조 필터를 표시하기 위한 것입니다. 실제 쿼리는 여전히 최상위 conditions를 사용하므로 이 키만 수정해 대체할 수 없습니다. 예시: {}획득 또는 입력 방법: 인시던트 조건 편집기에서 표시 구조를 제공할 수 있습니다. |
|
| config.extend.variable | json | 요청에 입력하는 것은 권장하지 않습니다. 작업이 실제 쿼리 열로 해당 객체를 덮어쓰며, 일반적인 count는 구간 내 항목 수입니다. 예시: {"count": 8}획득 또는 입력 방법: 생성 작업 실행 시 집계 변수를 계산합니다. |
|
| config.extend.variable.count | integer | 런타임 발생 횟수이며, 호출자가 입력한 값은 신뢰할 수 있는 고정값으로 적용되지 않습니다. 예시: 8획득 또는 입력 방법: 백그라운드에서 이 구간의 count(*) 쿼리로 계산합니다. |
|
| config.extend.tags | json | 요청에 입력하는 것은 권장하지 않습니다. 작업이 실제 그룹 tags로 덮어쓰며, Issue 중복 제거 및 템플릿 변수에 사용됩니다. 예시: {"service": "payment"}획득 또는 입력 방법: 생성 작업이 그룹 태그에 따라 가져옵니다. |
|
| config.extend.tags.字段 | any | 동적 JSON 태그 값이며, 호출자가 수동 입력한 값으로 그룹 생성을 고정할 수 없습니다. 예시: payment획득 또는 입력 방법: dimensions에 대응하는 이벤트 태그 값에서 가져옵니다. |
|
| config.extend.channelUUIDs | array | 런타임에 유효한 구성 채널로 덮어쓰며, 이 확장 필드로 config.channelUUIDs를 대체하지 않습니다. 예시: []획득 또는 입력 방법: 작업이 config.channelUUIDs에 따라 현재 유효한 채널을 필터링한 후 기록합니다. |
|
| config.extend.channelUUIDs[*] | string | 런타임의 유효한 채널 식별자 하나입니다. 예시: chan_example획득 또는 입력 방법: 현재 워크스페이스의 유효한 채널 uuid입니다. |
|
| config.extend.自定义键 | any | 임의의 JSON 저장 값이며, 이 페이지에서 공개하는 추가 실행 보장은 없습니다. 자격 증명을 넣지 마세요. 예시: value획득 또는 입력 방법: 호출자 측 비즈니스 표시용 확장입니다. |
|
| conditions | string | 선택적 문자열이며 필터 표현식만이고 전체 DQL/JSON이 아닙니다. 생성 시 생략하면 비어 있고, 수정 시 생략하면 유지되며 비우면 삭제됩니다. 현재 저장 시 DQL을 구문 분석하지 않으므로 구문/필드 유효성을 보장하지 않으며, 비동기 작업 실패가 이번 API 오류로 변환되지 않습니다. 엔터티 열은 48자이며 선언에는 길이 제한이 없으므로 짧은 표현식을 권장하고 관리자가 배포 열 제한을 확인해야 합니다. 빈 문자열 허용: True null 허용: False 예시: `df_status` = 'error'획득 또는 입력 방법: 대상 monitor 이벤트의 실제 필드로 DQL 필터 조건을 구성하며, 먼저 쿼리 도구에서 동일한 시간 범위로 검증할 수 있습니다. |
|
| config | json | Y | 필수 객체이며, 수정 시 매번 전체 교체되고 재귀 병합되지 않습니다. name/level/channelUUIDs/description/extend의 다섯 가지 선언된 키만 허용됩니다. 후속 작업의 안정적인 실행을 위해 선택 사항이더라도 description, channelUUIDs 배열, extend 객체 및 extend.text 문자열을 명시적으로 제공하는 것이 좋습니다. 누락 시 저장은 성공하지만 작업이 실패할 수 있습니다. null 허용: False 예시: {"name": "服务{{service}}告警", "description": "本窗口{{count}}条事件", "channelUUIDs": [], "extend": {"text": "服务{{service}}发现{{count}}条事件", "manager": []}}획득 또는 입력 방법: 이 페이지의 템플릿 구성에 따라 Issue 제목, 본문, 채널 및 담당자를 생성합니다. |
| config.channelUUIDs | array | 선택적 채널 UUID 배열이며, 명시적 항목은 현재 활성 상태여야 합니다. 항상 [] 또는 유효한 배열을 전달하는 것이 좋습니다. 생략해도 저장될 수 있지만 작업이 None을 순회하다 실패할 수 있습니다. 작업은 기본 채널 연결을 자동으로 보완합니다. 저장 자체는 []라도 워크스페이스에 활성 채널이 하나 이상 있어야 합니다. null 허용: False 예시: []획득 또는 입력 방법: 채널 요약 목록에서 현재 워크스페이스의 활성 chan_ UUID를 가져옵니다. |
|
| config.description | string | 선언상 선택적 문자열이지만 후속 작업이 이 키를 직접 읽으므로 항상 명시적으로 제공하는 것이 좋습니다(빈 문자열 가능). config 수정은 전체 교체이므로 하위 키를 생략해도 이전 값이 유지되지 않습니다. null 허용: False 예시: 本窗口{{count}}条事件획득 또는 입력 방법: 동일한 템플릿 변수를 사용하여 Issue 설명을 구성합니다. |
|
| config.extend | json | 선택적 객체 또는 null입니다. 실제 생성/수정 감사 자료는 extend.get을 직접 호출하므로 명시적 null은 500을 발생시킵니다. 생성은 일반적으로 제출 전에, 수정의 기존 감사는 제출 후에 실패할 수 있습니다. 항상 text를 포함한 객체를 전달하는 것이 좋습니다. 생략해도 저장 후 작업이 extend/text 누락으로 실패할 수 있습니다. 객체가 나타나면 전체 교체되며 임의의 하위 값은 유효한 구조를 유지해야 합니다. null 허용: True 예시: {"text": "服务{{service}}发现{{count}}条事件", "manager": []}획득 또는 입력 방법: Issue 생성의 표시 확장을 참고하되, 이 페이지에서 확인된 소비 필드를 기준으로 하세요. |
|
| config.level | string | 선택적 레벨 UUID 또는 빈 문자열이며, 비어 있지 않으면 현재 유효해야 하고 그렇지 않으면 406입니다. 생략하면 지정된 레벨이 없습니다. 인시던트 센터 레벨 UUID의 범용 대체 필드가 아닙니다. 빈 문자열 허용: True null 허용: False 예시: system_level_0획득 또는 입력 방법: Issue 레벨 목록에서 uuid를 가져옵니다. 백그라운드에서 전역 레벨이 활성화된 경우 관리자 구성이 우선합니다. |
|
| config.name | string | Y | 필수 문자열로 최대 256자이며, Issue 제목 템플릿과 규칙 name은 다릅니다. {{service}}/{{count}} 등의 word 변수 이름을 지원하며, 알 수 없는 변수는 원래대로 유지됩니다. 임의의 Python/Jinja 표현식은 지원하지 않으며, 점/하이픈이 포함된 필드는 치환을 보장하지 않습니다. null 허용: False 최대 길이: 256 예시: 服务{{service}}告警획득 또는 입력 방법: dimensions 필드 및 집계 변수 count에 따라 제목 템플릿을 구성합니다. |
| description | string | 선택적 문자열이며 빈 값을 허용합니다. 생성 시 생략하면 비어 있고, 수정 시 생략하면 유지되며, 명시적 빈 값은 삭제합니다. Issue 본문 템플릿으로 사용되지 않습니다. 빈 문자열 허용: True null 허용: False 예시: 按服务聚合生产告警획득 또는 입력 방법: 호출자가 규칙 용도 설명을 입력합니다. |
|
| dimensions | array | 선택적 배열이며, 나타나면 최소 한 항목이어야 합니다. 생성 시 생략하면 []로 저장되지만 작업의 by 문 구성이 유효하지 않을 수 있으므로 항상 비어 있지 않은 실제 필드를 제공하는 것이 좋습니다. 수정 시 생략하면 유지되고, []는 선행 406으로 인해 비울 수 없습니다. 채널 UUID가 아닌 필드 이름입니다. 필드 순서/집합은 그룹 쿼리에 영향을 주며, df_label은 집합 기준으로 집계됩니다. null 허용: False 최소 길이: 1 예시: ["service"]획득 또는 입력 방법: 이벤트의 실제 태그 필드에서 그룹 중복 제거에 사용할 필드 이름을 선택합니다. 예: service, host 또는 df_label. |
|
| dqlNamespace | string | Y | 필수이며, 유일하게 공개된 열거형 값은 keyevent입니다. rum/tracing이 아니며, 과거 엔터티/예시에서 다른 값을 허용했다고 해서 전달해서는 안 됩니다. null 허용: False 허용 값: ['keyevent'] 예시: keyevent획득 또는 입력 방법: 현재 공개 범위는 keyevent 이벤트 범위로 고정되어 있습니다. |
| every | integer | Y | 필수 정수이며 300/600/900/1800/3600만 가능합니다. 이전 열거형에 60이 포함되어 있지만 최솟값 300도 동시에 적용되므로 60은 공개 라우트에서 406이며 1분을 선택할 수 없습니다. null 허용: False 허용 값: [60, 300, 600, 900, 1800, 3600] $maxValue: 3600 $minValue: 300 예시: 300획득 또는 입력 방법: 검색 지연과 쿼리량에 따라 주기(초)를 선택합니다. |
| name | string | Y | 필수 문자열로 최대 256자입니다. 선언상 비어 있지 않음이 강제되지는 않지만 비어 있지 않은 값을 권장합니다. 동일 워크스페이스의 삭제되지 않은 규칙 이름은 중복될 수 없습니다. 수정 시에도 필수이며, 이는 규칙 이름이지 생성되는 Issue 제목이 아닙니다. null 허용: False 최대 길이: 256 예시: 生产事件自动发现획득 또는 입력 방법: 유지 관리자가 워크스페이스 내 고유한 규칙 이름을 입력합니다. |
파라미터 추가 설명¶
현재 공개 범위는 keyevent입니다. 구성 저장, 예약 실행, 알림 전달은 서로 다른 단계이며, 파라미터와 전체 응답/오류 경계는 아래에서 확인하세요.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产事件自动发现","description":"按服务聚合生产告警","dqlNamespace":"keyevent","every":300,"conditions":"`df_status` = '"'"'error'"'"'","dimensions":["service"],"config":{"name":"服务{{service}}告警","description":"本窗口{{count}}条事件","channelUUIDs":[],"extend":{"text":"服务{{service}}发现{{count}}条事件","manager":[]}}}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | object | 제출 전 구성 스냅샷이며, 생성/업데이트 주체 요약이 첨부되지 않고 생성된 Issue/실행 결과를 포함하지 않습니다. |
| 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입니다. 기존 레코드는 다른 네임스페이스일 수 있으며, 공개 API로 다시 기록할 수 있음을 의미하지 않습니다. |
| 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.declaration | object 또는 null | 현재 워크스페이스의 공개 선언입니다. |
{
"code": 200,
"content": {
"id": 7,
"uuid": "iatdc_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427260,
"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": []
}
},
"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 파일 형식 오류 | 파라미터 객체를 제출하세요. |
| 400 | ft.IssueAutoDiscoveryCfgNameExists | 현재 워크스페이스에서 삭제되지 않은 규칙 이름이 중복됨 | 동일한 이름의 규칙 이름이 이미 존재함 | 사용하지 않은 이름을 선택하고, 실패/시간 초과 시 기존 구성을 먼저 확인하세요. |
| 406 | ft.IssueLevelNotExists | config.level이 비어 있지 않으며 현재 유효한 Issue 레벨에 없음 | 레벨 구성이 존재하지 않음 | Issue 레벨 목록으로 uuid를 확인하고 표시 이름/인시던트 센터 레벨을 혼용하지 마세요. |
| 404 | ft.NotFoundChannel | 워크스페이스에 활성 채널이 없거나 지정한 channelUUIDs 항목이 활성 채널에 없음 | 지정한 채널을 찾을 수 없음 | 워크스페이스에 활성 채널이 있는지 확인하고 채널 요약 목록에서 UUID를 선택하세요. []도 워크스페이스에 최소 하나의 채널이 있어야 한다는 요구 사항을 우회하지 않습니다. |
| 400 | ft.UnsupportFreeIssueManager | 무료/체험 워크스페이스 담당자가 멤버가 아닌 외부 이메일을 사용함 | 체험판 워크스페이스에서는 인시던트 담당자를 외부 이메일로 지원하지 않습니다 | 현재 워크스페이스 멤버를 사용하거나 관리자가 제품 버전을 확인하도록 하세요. |
| 500 | ft.InternalServerError | 템플릿/담당자/차원, 구성 저장 후 이벤트 카운트 초기화 또는 동기 감사 자료 구성에서 처리되지 않은 예외 발생 | 내부 오류 | 먼저 구성 및 연관 Issue 이벤트 수를 다시 읽으세요. 구성이 이미 1차 제출되었을 수 있으며 후속 오류가 롤백을 보장하지 않습니다. traceId를 보관하세요. |
| 404 | ft.LogIndexCfgNoExists | 현재 워크스페이스에서 삭제되지 않은 자동 검색 규칙이 없음/삭제됨/다른 워크스페이스 | 지정한 로그 인덱스 구성이 존재하지 않습니다 | 현재 워크스페이스의 자동 검색 목록에서 iatdc_ UUID를 새로 고치세요. 이는 과거 재사용 오류 문구이므로 로그 인덱스를 새로 만들지 마세요. |