콘텐츠로 이동

수정



POST /api/v1/error_track_rule/{rule_uuid}/modify

개요

오류 추적 규칙 구성을 완전히 교체합니다.

호출 전 및 사용 단계

현재 Key에는 errorCenter.errorTrackRuleManage 권한이 필요하며 현재 워크스페이스에만 적용됩니다. 먼저 type을 결정한 후 해당 인덱스/애플리케이션/서비스 목록에서 실제 sources를 가져와야 하며, 이전 예시의 wsAdmin/acnt_/group_을 그대로 사용하면 안 됩니다. *는 전체 소스 표시이고 []는 와일드카드가 아닙니다. 알 수 없는 소스는 저장에 성공할 수 있지만 유효한 매칭을 생성할 수 없습니다. logging에서 외부 저장소에 바인딩된 활성 인덱스를 명시적으로 지정하면 거부되며, 다른 소스에는 항목별 존재 여부 검증이 없습니다.

이것은 전체 덮어쓰기 API입니다. name/type은 여전히 필수이며, desc, sources, extend를 생략하면 각각 빈 문자열, [], {}로 변경되며 patch가 아닙니다. 먼저 GET으로 현재 전체 구성을 복사한 후 필요한 필드만 수정하고, type을 변경할 때는 소스도 함께 조정해야 합니다. 404 이전에도 logging 소스를 먼저 검증할 수 있으므로 오류 순서만으로 대상 존재 여부를 추론할 수 없습니다.

이 엔드포인트는 규칙을 저장하고 데이터베이스에 커밋하며, 이 컨트롤러에서 다운스트림 동기화를 호출하거나 과거 데이터 재계산을 수행하지 않고, 게시/스캔 작업도 반환하지 않습니다. HTTP 200은 이번 저장 응답만 확인하며, 이후 오류 생성과 실제 처리 범위는 비즈니스 데이터로 검증해야 합니다. extend에는 공개된 고정 실행 하위 키가 없으며, 자유 객체를 알림/임계값 엔진으로 간주해서는 안 됩니다. 커밋 전 엔터티 스냅샷을 반환하므로 신규 id는 null일 수 있고 sourcesInfo 또는 신원 추가 요약이 없습니다. 상세를 다시 조회하면 최종 id와 rum 요약을 얻을 수 있습니다.

경로 매개변수

매개변수명 유형 필수 설명
rule_uuid string Y 현재 워크스페이스에서 삭제되지 않은 규칙 UUID(상태 0 활성 및 2 비활성 포함)이며, 텔레메트리 issue_id 또는 로컬 isset_ 처리 메타데이터가 아닙니다.
빈 문자열 허용: False
예시: issetrule_example
조회 또는 입력 방법: 오류 추적 규칙 목록에서 content.data[].uuid를 가져옵니다.

요청 헤더

매개변수명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 매개변수

매개변수명 유형 필수 설명
sources[*] any 문자열을 권장하며, 인덱스 name/appId/서비스 service 또는 * 하나입니다. 원래 선언에는 요소 유형 제약이 없으므로 객체/배열 등을 저장하면 RUM 목록 요약 또는 다운스트림 처리에서 500이 발생할 수 있으며, API의 차단에 의존할 수 없습니다. 계정/팀/역할 UUID가 아닙니다.
예시: payment_web
조회 또는 입력 방법: type=logging이면 로그 인덱스 목록에서 name을 가져오고 isBindCustomStore=1을 제외합니다. type=rum이면 RUM 애플리케이션 간략 목록에서 appId를 가져옵니다. type=tracing이면 서비스 목록에서 service를 가져옵니다. 와일드카드는 리터럴 *를 사용합니다.
extend.사용자 정의 키 any 임의의 JSON 값으로 객체/배열/문자열/숫자/부울/null이 가능합니다. 고정된 필수 하위 키가 없으며 자격 증명을 넣지 마십시오.
예시: payment
조회 또는 입력 방법: 호출자가 규칙 표시 정보를 입력합니다.
desc string 선택적 문자열이며 최대 256자이고 빈 값을 허용합니다. 생성 시 생략하면 빈 값이 되고, 수정 시 생략해도 기존 값을 유지하지 않고 비웁니다.
빈 문자열 허용: True
null 허용: False
최대 길이: 256
예시: 跟踪支付Web应用错误
조회 또는 입력 방법: 규칙 관리자가 용도/범위 설명을 입력합니다.
extend json 선택적 JSON 객체입니다. 루트가 null/배열/문자열이면 406이 먼저 반환됩니다. 생성 시 생략하면 {}이고, 수정 시 생략해도 {}로 기존 값을 전체 교체하며, {}를 제출하면 비웁니다. 이 Studio 구현은 객체만 저장하므로 임의의 하위 키로 임계값/알림/정규식 등의 실행 기능을 추론해서는 안 됩니다.
null 허용: False
예시: {"ownerTeam": "payment"}
조회 또는 입력 방법: 호출자가 규칙 유지 관리 표시 정보를 저장할 수 있으며, 공개된 고정 실행 하위 구성은 없습니다.
name string Y 필수 문자열이며 최대 128자입니다. 선언상 비어 있지 않음이 강제되지는 않지만 비우지 않는 것을 권장합니다. 동일한 이름에 대한 이 API의 고유성 검증은 없으므로 이름을 멱등 키로 사용하지 마십시오. 수정 시에도 필수이며 전체 교체합니다.
null 허용: False
최대 길이: 128
예시: 支付Web错误聚合
조회 또는 입력 방법: 호출자가 식별 가능한 규칙 이름을 입력합니다.
sources array 선택적 배열이며 생략하면 []입니다. 수정 시 값을 제공하면 전체 교체하고, 생략해도 비웁니다. []는 와일드카드가 아니며 전체 소스는 ["*"]로 명시해야 합니다. 현재 유효한 문자열/존재 여부를 항목별로 검증하지 않으므로 클라이언트는 실제 이름/식별자를 사용해야 하며, 알 수 없는 값을 저장했다고 해서 매칭이 유효하다는 뜻은 아닙니다. logging에서 현재 활성 상태인 외부 바인딩 인덱스를 지정하면 404가 발생합니다. *는 외부 인덱스를 하나씩 점검하지 않으므로 저장 성공만으로 외부 인덱스 지원을 보장할 수 없습니다.
null 허용: False
예시: ["payment_web"]
조회 또는 입력 방법: type=logging이면 로그 인덱스 목록에서 name을 가져오고 isBindCustomStore=1을 제외합니다. type=rum이면 RUM 애플리케이션 간략 목록에서 appId를 가져옵니다. type=tracing이면 서비스 목록에서 service를 가져옵니다. 와일드카드는 리터럴 *를 사용합니다.
type string Y 필수이며 logging/tracing/rum 중 하나입니다. 수정 시에도 필수이고 유형 변경이 허용되며, 새 유형에 맞는 sources를 동시에 재구성해야 합니다. 애플리케이션 ID/인덱스 이름/서비스 이름을 혼용할 수 없습니다.
null 허용: False
선택 가능한 값: ['logging', 'tracing', 'rum']
예시: rum
조회 또는 입력 방법: 오류 데이터 소스에 따라 선택합니다. logging은 로그, tracing은 트레이스, rum은 RUM 사용자 액세스입니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/error_track_rule/issetrule_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"支付Web错误聚合","desc":"跟踪支付Web应用错误","type":"rum","sources":["payment_web"],"extend":{"ownerTeam":"payment"}}'

응답

HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content object 저장된 규칙 엔터티 스냅샷입니다.
content.id integer 또는 null 데이터베이스 행 ID이며 경로 위치 지정에 사용되지 않습니다. 커밋 전 스냅샷에서는 null일 수 있습니다.
content.uuid string 오류 추적 규칙 UUID로 issetrule_ 접두사를 가지며, 오류 처리 메타데이터 isset_ 또는 텔레메트리 issue_id가 아닙니다.
content.status integer 데이터베이스 상태: 0 활성, 2 비활성, 3 소프트 삭제(읽기 시 3 제외).
content.creator string 생성 주체 UUID이며, 이 공개 엔드포인트에서는 일반적으로 생성 Key 리소스 wsak_입니다. 과거 기록은 다른 주체일 수 있으며 sys 메타데이터를 자동 초기화하지 않습니다.
content.updator string 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있을 수 있습니다.
content.createAt integer Unix 초 단위 생성 시간입니다.
content.updateAt integer Unix 초 단위 업데이트 시간이며, 생성 후 업데이트되지 않은 경우 일반적으로 -1입니다.
content.deleteAt integer Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 일반적으로 -1입니다.
content.workspaceUUID string 현재 Key가 속한 워크스페이스입니다.
content.name string 규칙 이름이며 동일한 이름이 허용됩니다.
content.desc string 규칙 설명입니다.
content.type string logging/tracing/rum.
content.sources array 저장된 소스 배열이며 클라이언트는 문자열만 사용해야 합니다. 과거의 비문자열 값은 허용 범위로 처리해야 합니다.
content.sources[] JSON 정상적으로는 인덱스 이름/appId/서비스 이름 또는 *이며, 역할 또는 계정 ID가 아닙니다.
content.extend object 또는 null 저장된 확장이며 정상적으로는 객체로 기록됩니다. 과거 값은 허용 범위로 처리해야 합니다.
content.extend.사용자 정의 키 JSON 사용자 정의 저장 값이며 고정된 실행 의미는 없습니다.
content.declaration object 또는 null 현재 워크스페이스의 공개 선언입니다.
{
  "code": 200,
  "content": {
    "id": 7,
    "uuid": "issetrule_example",
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427260,
    "deleteAt": -1,
    "workspaceUUID": "wksp_example",
    "name": "支付Web错误聚合",
    "desc": "跟踪支付Web应用错误",
    "type": "rum",
    "sources": [
      "payment_web"
    ],
    "extend": {
      "ownerTeam": "payment"
    },
    "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 파일 형식이 잘못되었습니다. 규칙 객체를 제출합니다.
404 ft.NotSupportExternalLogIndexCfg type=logging이고 sources가 현재 워크스페이스의 활성 isBindCustomStore=1 인덱스를 명확히 지정했습니다. 외부 인덱스 구성을 지원하지 않습니다. 내장 인덱스를 선택하거나 지원되는 소스로 변경합니다. *로 우회하여 외부 인덱스가 지원된다고 추론해서는 안 됩니다.
404 ft.ObjectNotExists 현재 워크스페이스에 대상 규칙이 없거나 삭제되었습니다. 지정한 객체가 존재하지 않습니다. 목록에서 규칙 uuid를 새로고침합니다.
500 ft.InternalServerError 데이터베이스, 과거 객체 또는 처리되지 않은 저장/응답 구성 예외입니다. 내부 오류 먼저 규칙 목록/상세를 다시 읽어 실제 저장 여부를 확인합니다. 생성에는 멱등 키가 없으므로 결과를 알 수 없는 요청을 반복 제출하지 마십시오.

문서 평가

이 페이지가 도움이 되었나요?