단일 데이터 액세스 규칙 수정¶
POST /api/v1/logging_query_rule/{logging_query_rule_uuid}/modify
개요¶
로그 액세스 규칙을 전체 수정합니다(v2 레거시 선언).
호출 전 준비 및 사용 단계¶
먼저 상세 정보를 조회하고, 백업한 뒤 전체 쓰기 가능 필드를 채워 넣습니다. 이 API는 전체를 교체합니다. desc/indexes/sources/conditions/extend/logic/maskFields/reExprs를 생략하면 각각 빈 문자열/[]/{} 등의 기본값으로 복원되므로, 이름만 제출하고 다른 구성이 그대로 유지되기를 기대할 수 없습니다. regionCode를 전달하지 않으면 빈 문자열로 저장됩니다. type은 기존 레코드를 따르며, 이 Body로는 변경할 수 없습니다.
현재 v2 선언은 레거시 엔드포인트와 Method와 URL이 동일하며, 실제 HTTP는 먼저 레거시 엔드포인트에 매칭됩니다. regionCode를 전달하면 알 수 없는 Body 필드로 처리되어 ft.ParameterValidationFailed가 반환됩니다. 이 페이지 선언 표의 regionCode는 과거 v2 계약을 반영한 것으로, 현재 이를 근거로 교차 사이트 기능을 호출할 수 없습니다. 아래 실행 가능한 예시는 동일 경로의 레거시 엔드포인트가 허용하는 필드를 사용하며 regionCode를 전달하지 않습니다. 응답 또한 레거시 엔드포인트의 저장 결과입니다. 명시적인 사이트가 필요한 기능은 접근 가능한 범용 생성 API data_query_rule.add_v2 또는 콘솔을 사용하고, 존재하지 않는 /v2 경로를 추가하려 시도하지 마세요.
쓰기는 구성을 교체하고 데이터베이스에 커밋한 뒤 규칙 캐시를 비우고 감사 로그를 기록합니다. 교차 사이트 검증은 리소스 자료를 읽거나 업데이트할 수도 있습니다. 단계가 단일 원자적 트랜잭션이 아니므로, 500/타임아웃 발생 시 목록/상세에서 먼저 저장 여부를 확인하여 무작정 중복 생성하는 것을 피해야 합니다.
규칙 저장은 이후 조건에 부합하는 ID의 데이터 조회 범위/결과 마스킹에 영향을 주며, 원본 데이터를 수정·삭제하거나 보충 수집하지 않고 역할의 기본 조회 권한도 추가하지 않습니다. 여러 역할과 규칙은 조회 측 정책에 따라 병합되므로 단일 규칙만으로 최종 권한을 추론할 수 없습니다. Owner는 예외이며, 관리자 및 워크스페이스의 "데이터 액세스 범위 제한" 설정은 일치하는 역할이 없을 때의 처리를 변경하므로 대표 멤버의 실제 조회로 검증해야 합니다. 저장 후 규칙 캐시는 무효화되지만, 진행 중인 모든 조회가 즉시 전환됨을 보장하지는 않습니다.
라우트 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| logging_query_rule_uuid | string | Y | 경로 규칙 UUID로, 이름이나 역할 UUID는 사용할 수 없습니다. 조회/수정은 현재 워크스페이스의 삭제되지 않은 항목만 가능합니다. 예시: lqrl_example조회 또는 입력 방법: 로그 액세스 규칙 목록의 content.data[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| indexes[*] | string | 배열 요소는 비어 있지 않은 문자열을 권장합니다. 원래 선언에서 항목별로 강제하지 않았으며, 잘못된 타입은 500을 유발할 수 있습니다. 예시: default조회 또는 입력 방법: 단일 로그 인덱스 uuid/default 또는 이미 권한이 부여된 wksp_출처:lgim_인덱스입니다. |
|
| roleUUIDs[*] | string | 유효한 역할을 사용해야 하며, 계정 UUID는 사용하지 마세요. 예시: role_example조회 또는 입력 방법: 현재 워크스페이스에서 사용 가능한 역할 uuid 또는 단독 *. |
|
| extend.사용자 정의 키 | any | 임의의 직렬화 가능한 JSON 값이며, 추가로 적용되는 조건이 아닙니다. 예시: production조회 또는 입력 방법: 호출자가 정의하는 표시/편집 컨텍스트로, 실제 conditions와 일치하게 유지합니다. |
|
| reExprs[*] | json | name/enable/reExpr만 사용하는 것을 권장합니다. 배열 요소의 구조는 원래 선언에서 강제하지 않았으며, 객체가 아니면 500이 발생할 수 있습니다. 예시: {"name": "token", "enable": true, "reExpr": "tkn_[0-9A-Za-z]+"}조회 또는 입력 방법: 각 객체가 하나의 마스킹 표현식을 정의합니다. |
|
| reExprs[*].name | string | 선택적 표시 이름으로, 매칭 표현식으로 사용되지 않으며 생략해도 정규식 매칭에 영향을 주지 않습니다. 예시: token조회 또는 입력 방법: 업무에서 정의한 정규식 표시 이름입니다. |
|
| reExprs[*].enable | boolean | 명시적인 불리언을 권장하며, 누락 시 미사용으로 처리됩니다. 비활성화된 정규식도 문법은 유효해야 합니다. 예시: true조회 또는 입력 방법: 적용이 필요하면 true, 임시 저장하고 적용하지 않으려면 false입니다. |
|
| reExprs[*].reExpr | string | 비어 있지 않은 정규식을 권장합니다. 현재 누락 시 빈 문자열로 검사되므로, 서버가 유효한 표현식을 채워 줄 것으로 의존할 수 없습니다. 예시: tkn_[0-9A-Za-z]+조회 또는 입력 방법: 실제 민감 콘텐츠 패턴이며, JSON 문자열로 사용할 때는 역슬래시를 두 번 써야 합니다. |
|
| conditions | string | Y | 필터 표현식만 입력하고 전체 쿼리나 바깥쪽 중괄호는 입력하지 않습니다. 이 모듈은 필수 문자열로 선언되어 있습니다. 4048자를 넘지 않도록 권장합니다. keyevent는 Python 문자 수 ≤4048을 별도로 적용하고 E 쿼리 문법을 파싱하며, 다른 타입은 저장 시 조건 의미를 전면적으로 검증하지 않으므로 저장 성공이 향후 조회 성공을 보장하지 않습니다. 이 규칙은 접근이 허용되는 데이터 범위를 정의합니다. null 허용: False 예시: `env` = 'production'조회 또는 입력 방법: 대상 데이터의 실제 태그/필드로부터 DQL 필터 조건을 구성하고, 동일한 소스에서 먼저 조회하여 검증합니다. |
| desc | string | 선택 사항이며, 최대 256자로 위와 동일한 카운트 단위를 사용합니다. 누락/빈 문자열이면 빈 값으로 정리되며, 수정 시 기존 값을 유지하지 않습니다. 빈 문자열 허용: True null 허용: False 최대 길이: 256 예시: 仅允许查看生产环境数据。조회 또는 입력 방법: 업무 담당자가 규칙의 목적과 적용 대상을 작성합니다. |
|
| extend | json | 임의의 JSON을 선택적으로 표시할 수 있으며, 누락 시 {}입니다. 통일된 필수 하위 키나 단위가 없고, 서버가 이로부터 conditions를 자동 생성하지 않으며, 수정 시 전체가 교체됩니다. 자격 증명을 저장하지 마세요. null 허용: False 예시: {}조회 또는 입력 방법: 클라이언트가 자체 편집기에 필요한 표시 구성을 저장하며, 필요 없으면 {}입니다. |
|
| indexes | array | Y | 로그 규칙에서는 명확히 제공해야 하며, 이 모듈은 필수로 선언되어 있습니다. ["*"]는 사용 가능한 모든 로그 인덱스를 의미하며, *는 단독 사용을 권장합니다. []는 전체가 아닙니다. keyevent는 []를 강제로 저장하고, 기타 비로그 타입은 보통 []를 사용합니다. 일반 인덱스 이름으로 UUID를 대체할 수 없으며 권한이 자동 생성되지 않습니다. 저장 성공이 원격의 모든 리소스가 여전히 유효함을 증명하지는 않습니다. null 허용: False 예시: ["default"]조회 또는 입력 방법: 로그 인덱스 목록에서 uuid를 가져오고, 기본 인덱스는 default를 사용합니다. 교차 워크스페이스는 권한이 부여된 출처 워크스페이스 UUID:인덱스 UUID를 사용합니다. |
| logic | string | 호환용 표시 필드로, 보통 and/or입니다. 신규 생성 선언에서는 필수이며, 수정 시에는 생략할 수 있습니다. 생략하면 빈 문자열로 저장됩니다. 실제 적용되는 필터는 conditions를 직접 사용하며, logic을 변경해도 조건이 재작성되지 않고, 다중 역할/다중 규칙 병합은 이 필드로 제어되지 않습니다. null 허용: False 예시: and조회 또는 입력 방법: 클라이언트 필터 편집기의 조건 결합 방식과 일치하게 유지합니다. |
|
| maskFields | string | 선택 사항이며, 누락 시 빈 문자열로 이 규칙의 필드 마스킹이 구성되지 않습니다. 수정 시 생략하면 비워집니다. 필드를 선택했고 reExprs=[]이면 non-null 값은 필드 전체가 ***로 가려집니다. 비어 있지 않은 정규식 목록을 주면 활성화된 정규식만 적용되며, 전부 비활성화한 것이 필드 전체 마스킹과 같지는 않습니다. 저장 열에 맞추어 256자 이하를 권장합니다. 빈 문자열 허용: True null 허용: False 예시: message조회 또는 입력 방법: 조회 결과의 실제 필드 이름에서 선택하고, 여러 개는 영문 쉼표로 구분합니다(예: message,user_email). *로 전체를 선택할 때는 단독으로 사용해야 하며 구체적 필드와 섞지 않습니다. |
|
| name | string | 생략할 수 있습니다. 누락/빈 문자열이면 호출 ID의 표시 이름과 현재 Unix 초를 기준으로 생성을 시도하며, 수정 시에도 동일하게 재생성되어 기존 이름을 유지하지 않습니다. 최대 64 카운트 단위(ASCII/반각 가타카나 1, 기타 문자 2)이며, 활성화 및 비활성화된 동일 타입 규칙이 모두 중복 이름 검사에 참여합니다. 빈 문자열 허용: False null 허용: False 최대 길이: 64 예시: production_only조회 또는 입력 방법: 업무 담당자가 이름을 지정하며, 먼저 로그 액세스 규칙 목록에서 동일 타입의 기존 이름을 확인합니다. |
|
| reExprs | array | 선택 사항이며, 누락 시 []이고 수정 시 전체가 교체됩니다. 저장 시 enable=false 항목을 포함한 각 정규식을 모두 검증하며, 잘못된 정규식은 ft.ErrorRegularExpression을 반환합니다. 단독 *로 임의 문자열을 표현하지 말고 .*를 사용하세요. 선택한 필드에 정규식이 없으면 필드 전체가 ***가 됩니다. 정규식은 문자열 콘텐츠의 매칭 조각만 처리하며, 매칭된 내용을 ***로 치환합니다. 저장 검증과 실행 엔진 간에는 차이가 있으므로 저장 성공 후에도 대표 쿼리로 검증해야 합니다. null 허용: False 예시: [{"name": "token", "enable": true, "reExpr": "tkn_[0-9A-Za-z]+"}]조회 또는 입력 방법: 민감 값 형식에 맞추어 Python re로 실행 가능한 정규식을 작성하고, 마스킹 샘플로 먼저 검증합니다. maskFields와 함께 사용합니다. |
|
| regionCode | string | Y | v2 선언의 필수 출처 사이트 코드로, 동일 규칙의 로그 인덱스는 동일 사이트에 속해야 하며 이 값과 일치해야 합니다. 레거시 엔드포인트는 이 필드를 허용하지 않습니다. 데이터 액세스 규칙이 교차 사이트/교차 워크스페이스 권한을 대체하지 않으며, 이벤트의 교차 사이트에는 keyevent 또는 *를 포함한 유효한 권한이 있어야 합니다. 아래의 중복 라우트 실제 접근 가능성 설명을 참고하세요. 빈 문자열 허용: False null 허용: False 예시: example-region조회 또는 입력 방법: 대상 출처 사이트 및 유효한 교차 워크스페이스 권한 목록에서 실제 regionCode를 확인합니다. 현재 사이트도 정식 코드를 사용하며 예시 리터럴 값을 입력하지 않습니다. |
| roleUUIDs | array | Y | 필수 배열이며, ["*"]는 각 역할을 의미하고 Owner는 여전히 데이터 액세스 제한을 받지 않습니다. []는 역할과 매칭되지 않으며 전체와 같지 않습니다. 이벤트 keyevent는 비어 있지 않은 문자열 배열이어야 하고 *는 단독으로만 나타날 수 있으며, 기타 타입은 스코프 내 역할 존재 여부를 검증하지만 역할 status=0을 보장하지는 않습니다. 기본 조회 권한은 여전히 별도로 갖추어야 합니다. null 허용: False 예시: ["role_example"]조회 또는 입력 방법: 역할 목록에서 현재 워크스페이스의 역할 uuid를 가져오며, 워크스페이스 멤버 목록으로 멤버의 실제 역할을 확인할 수 있습니다. |
파라미터 추가 설명¶
데이터 설명.*
1. 역할 권한 부여 접근 설명 1. 지정된 역할은 지정된 조회 범위 내의 데이터만 조회할 수 있습니다. 2. 사용자에게 여러 역할이 있는 경우, 해당 사용자의 역할 중 이 규칙의 역할에 포함되지 않는 역할이 있으면 이 데이터 액세스 규칙은 해당 사용자에게 적용되지 않습니다. 즉, 조회 범위를 제한하지 않습니다. 3. 한 워크스페이스의 여러 로그 데이터 액세스 규칙 간의 논리는 or 관계입니다.
2. 요청 파라미터 설명
| 파라미터명 | type | 필수 | 설명 |
|---|---|---|---|
| name | string | Y | 이름 |
| desc | String | N | 설명 |
| indexes | array | Y | 로그 인덱스 정보입니다. 다른 워크스페이스(워크스페이스 권한 부여 필수)의 인덱스 권한인 경우 워크스페이스 UUID:인덱스 UUID 형식을 사용합니다. 예: ["wksp_111:lgim_222", "wksp_333:lgim_444"] |
| roleUUIDs | array | Y | 역할 UUID 목록 |
| conditions | string | N | 실제 사용되는 데이터 범위의 필터 조건, 예: "device IN ['PC'] and session_has_replay IN ['1']" |
| extend | dict | Y | 확장 필드로, conditions의 구조 내용을 저장하며 프런트엔드 페이지 표시에 사용합니다. 예: {"device": [ "PC"], "session_has_replay": [1]} |
| logic | string | N | 논리 필드, and/or, 필터 조건을 연결하는 데 사용합니다. |
| maskFields | string | N | 마스킹 필드, 여러 필드는 ,로 구분합니다. |
| reExprs | array | N | 정규 표현식, 예: [{"name":"1111","enable":true,"reExpr":"tkn_[\da-z]*"},{"name":"liuyltest","enable":true,"reExpr":"test"}] |
| regionCode | string | Y | 사이트 code(workspace/website/list API로 조회 가능), 데이터 액세스 구성의 사이트 정보이며, 기본적으로 현재 사이트의 데이터를 권한 부여합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/logging_query_rule/lqrl_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"production_only","desc":"仅允许查看生产环境数据。","indexes":["default"],"roleUUIDs":["role_example"],"conditions":"`env` = '"'"'production'"'"'","extend":{},"logic":"and","maskFields":"message","reExprs":[{"name":"token","enable":true,"reExpr":"tkn_[0-9A-Za-z]+"}]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 레코드 번호입니다. 생성 응답은 커밋 전 스냅샷이라 null일 수 있으며, 이후 작업에는 uuid를 사용합니다. |
| content.uuid | string | lqrl_규칙UUID로, 두 모듈이 엔터티와 식별자를 공유합니다. |
| content.workspaceUUID | string | 이 규칙이 속한 워크스페이스로, 출처 워크스페이스와 구분됩니다. |
| content.status | integer | 0 활성화, 2 비활성화, 3 삭제이며, 이 모듈의 조회는 삭제되지 않은 항목만 대상으로 합니다. |
| content.creator | string | 생성 주체입니다. |
| content.updator | string | 최근 업데이트 주체이며 초기에는 비어 있을 수 있습니다. |
| content.createAt | integer | 생성 Unix 초입니다. |
| content.updateAt | integer | 업데이트 Unix 초이며, 미업데이트 시 -1입니다. |
| content.deleteAt | integer | 삭제 Unix 초이며, 미삭제 시 -1입니다. |
| content.name | string | 저장값: 생략할 수 있습니다. 누락/빈 문자열이면 호출 ID의 표시 이름과 현재 Unix 초를 기준으로 생성을 시도하며, 수정 시에도 동일하게 재생성되어 기존 이름을 유지하지 않습니다. 최대 64 카운트 단위(ASCII/반각 가타카나 1, 기타 문자 2)이며, 활성화 및 비활성화된 동일 타입 규칙이 모두 중복 이름 검사에 참여합니다. |
| content.desc | string | 저장값: 선택 사항이며, 최대 256자로 위와 동일한 카운트 단위를 사용합니다. 누락/빈 문자열이면 빈 값으로 정리되며, 수정 시 기존 값을 유지하지 않습니다. |
| content.indexes | array | 저장값: 로그 규칙에서는 명확히 제공해야 하며, 이 모듈은 필수로 선언되어 있습니다. ["*"]는 사용 가능한 모든 로그 인덱스를 의미하며, *는 단독 사용을 권장합니다. []는 전체가 아닙니다. keyevent는 []를 강제로 저장하고, 기타 비로그 타입은 보통 []를 사용합니다. 일반 인덱스 이름으로 UUID를 대체할 수 없으며 권한이 자동 생성되지 않습니다. 저장 성공이 원격의 모든 리소스가 여전히 유효함을 증명하지는 않습니다. |
| content.indexes[] | string | 저장값: 배열 요소는 비어 있지 않은 문자열을 권장합니다. 원래 선언에서 항목별로 강제하지 않았으며, 잘못된 타입은 500을 유발할 수 있습니다. |
| content.roleUUIDs | array | 저장값: 필수 배열이며, ["*"]는 각 역할을 의미하고 Owner는 여전히 데이터 액세스 제한을 받지 않습니다. []는 역할과 매칭되지 않으며 전체와 같지 않습니다. 이벤트 keyevent는 비어 있지 않은 문자열 배열이어야 하고 *는 단독으로만 나타날 수 있으며, 기타 타입은 스코프 내 역할 존재 여부를 검증하지만 역할 status=0을 보장하지는 않습니다. 기본 조회 권한은 여전히 별도로 갖추어야 합니다. |
| content.roleUUIDs[] | string | 저장값: 유효한 역할을 사용해야 하며, 계정 UUID는 사용하지 마세요. |
| content.conditions | string | 저장값: 필터 표현식만 입력하고 전체 쿼리나 바깥쪽 중괄호는 입력하지 않습니다. 이 모듈은 필수 문자열로 선언되어 있습니다. 4048자를 넘지 않도록 권장합니다. keyevent는 Python 문자 수 ≤4048을 별도로 적용하고 E 쿼리 문법을 파싱하며, 다른 타입은 저장 시 조건 의미를 전면적으로 검증하지 않으므로 저장 성공이 향후 조회 성공을 보장하지 않습니다. 이 규칙은 접근이 허용되는 데이터 범위를 정의합니다. |
| content.extend | json | 저장값: 임의의 JSON을 선택적으로 표시할 수 있으며, 누락 시 {}입니다. 통일된 필수 하위 키나 단위가 없고, 서버가 이로부터 conditions를 자동 생성하지 않으며, 수정 시 전체가 교체됩니다. 자격 증명을 저장하지 마세요. |
| content.extend.사용자 정의 키 | any | 저장값: 임의의 직렬화 가능한 JSON 값이며, 추가로 적용되는 조건이 아닙니다. |
| content.logic | string | 저장값: 호환용 표시 필드로, 보통 and/or입니다. 신규 생성 선언에서는 필수이며, 수정 시에는 생략할 수 있습니다. 생략하면 빈 문자열로 저장됩니다. 실제 적용되는 필터는 conditions를 직접 사용하며, logic을 변경해도 조건이 재작성되지 않고, 다중 역할/다중 규칙 병합은 이 필드로 제어되지 않습니다. |
| content.maskFields | string | 저장값: 선택 사항이며, 누락 시 빈 문자열로 이 규칙의 필드 마스킹이 구성되지 않습니다. 수정 시 생략하면 비워집니다. 필드를 선택했고 reExprs=[]이면 non-null 값은 필드 전체가 ***로 가려집니다. 비어 있지 않은 정규식 목록을 주면 활성화된 정규식만 적용되며, 전부 비활성화한 것이 필드 전체 마스킹과 같지는 않습니다. 저장 열에 맞추어 256자 이하를 권장합니다. |
| content.reExprs | array | 저장값: 선택 사항이며, 누락 시 []이고 수정 시 전체가 교체됩니다. 저장 시 enable=false 항목을 포함한 각 정규식을 모두 검증하며, 잘못된 정규식은 ft.ErrorRegularExpression을 반환합니다. 단독 *로 임의 문자열을 표현하지 말고 .*를 사용하세요. 선택한 필드에 정규식이 없으면 필드 전체가 ***가 됩니다. 정규식은 문자열 콘텐츠의 매칭 조각만 처리하며, 매칭된 내용을 ***로 치환합니다. 저장 검증과 실행 엔진 간에는 차이가 있으므로 저장 성공 후에도 대표 쿼리로 검증해야 합니다. |
| content.reExprs[] | json | 저장값: name/enable/reExpr만 사용하는 것을 권장합니다. 배열 요소의 구조는 원래 선언에서 강제하지 않았으며, 객체가 아니면 500이 발생할 수 있습니다. |
| content.reExprs[].name | string | 저장값: 선택적 표시 이름으로, 매칭 표현식으로 사용되지 않으며 생략해도 정규식 매칭에 영향을 주지 않습니다. |
| content.reExprs[].enable | boolean | 저장값: 명시적인 불리언을 권장하며, 누락 시 미사용으로 처리됩니다. 비활성화된 정규식도 문법은 유효해야 합니다. |
| content.reExprs[].reExpr | string | 저장값: 비어 있지 않은 정규식을 권장합니다. 현재 누락 시 빈 문자열로 검사되므로, 서버가 유효한 표현식을 채워 줄 것으로 의존할 수 없습니다. |
| content.sources | array | 저장값: 비로그 범위 배열이며, ["*"]는 사용 가능한 모든 출처입니다. 생략 시 []이며 전체를 의미하지 않습니다. logging은 []를 강제로 저장합니다. rum/lineage는 권한이 부여된 워크스페이스 UUID:출처 식별자로 한정할 수 있고, tracing/metric/keyevent는 원래 출처 문자열을 사용합니다. keyevent는 비어 있지 않은 문자열 배열이어야 하며 wksp_:출처를 허용하지 않고 *를 다른 값과 섞을 수 없습니다. rum은 현재 regionCode를 명시한 경우에만 조회하여 애플리케이션 존재를 확인하며, 기타 출처는 저장 성공이 실제 데이터 존재를 증명하지 않습니다. |
| content.sources[] | string | 저장값: 상위 type에 따라 해석되는 단일 출처이며, 비어 있지 않은 문자열을 권장합니다. |
| content.type | string | 저장값: 신규 생성 시 logging/rum/tracing/metric/lineage/keyevent 중 하나가 필수입니다. 선언은 null을 허용하지만 유효하지 않은 타입은 정상적인 조회 규칙을 형성할 수 없으므로 항상 위 문자열을 제출해야 합니다. 수정 시 type은 허용되지 않으며 저장된 타입을 따릅니다. |
| content.regionCode | string | 저장값: v2 선언의 필수 출처 사이트 코드로, 동일 규칙의 로그 인덱스는 동일 사이트에 속해야 하며 이 값과 일치해야 합니다. 레거시 엔드포인트는 이 필드를 허용하지 않습니다. 데이터 액세스 규칙이 교차 사이트/교차 워크스페이스 권한을 대체하지 않으며, 이벤트의 교차 사이트에는 keyevent 또는 *를 포함한 유효한 권한이 있어야 합니다. 아래의 중복 라우트 실제 접근 가능성 설명을 참고하세요. |
| content.declaration | object | 공통 선언이며, 쓰기 응답은 출처/역할/ID 요약을 자동으로 추가하지 않습니다. |
{
"code": 200,
"content": {
"id": 100,
"uuid": "lqrl_example",
"workspaceUUID": "wksp_example",
"name": "production_only",
"desc": "仅允许查看生产环境数据。",
"type": "logging",
"indexes": [
"default"
],
"sources": [],
"roleUUIDs": [
"role_example"
],
"conditions": "`env` = 'production'",
"extend": {},
"logic": "and",
"maskFields": "message",
"reExprs": [
{
"name": "token",
"enable": true,
"reExpr": "tkn_[0-9A-Za-z]+"
}
],
"regionCode": "",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427300,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 타입, 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 문법이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 404 | ft.NoInitOtherNodeCfg | 원격 인덱스/RUM 애플리케이션 메타데이터를 읽거나 검증할 때 사용 가능한 출처 사이트 주소를 찾지 못함 | 다른 노드 구성이 초기화되지 않음 | 관리자가 출처 사이트 구성, 접근 가능한 주소, 유효한 교차 워크스페이스 권한을 확인하고 수정한 뒤 재시도합니다. |
| 400 | ft.NameRepeat | 현재 워크스페이스에 동일 타입의 삭제되지 않은 동명 규칙이 있음 | 이름이 이미 존재함 | 이름을 변경하거나, 확인 후 기존 UUID를 업데이트합니다. |
| 400 | ft.ErrorRegularExpression | 비활성화 항목을 포함한 정규식 중 하나가 유효하지 않음 | 정규 표현식에 오류가 있음 | 모든 reExpr를 수정한 뒤 제출하며, 단독 *를 사용하지 마세요. |
| 400 | ft.InvalidRoleUUID | 역할이 워크스페이스 스코프에 없거나 keyevent 역할 배열이 유효하지 않음 | 유효하지 않은 역할 UUID: {} | 현재 워크스페이스의 역할 목록에서 유효한 식별자를 가져오며, 이벤트 *는 단독으로 사용합니다. |
| 400 | ft.InvalidLoggingIndex | 해석된 현재 사이트 출처 워크스페이스의 일반 인덱스가 존재하지 않거나 삭제됨 | 유효하지 않은 인덱스:{} | 유효한 인덱스 UUID/default를 사용하고 권한을 확인합니다. |
| 400 | ft.InvalidRegionDataQueryRuleIndex | 로그 인덱스가 여러 사이트에 걸쳐 있거나 사이트가 일치하지 않으며, 이벤트 교차 사이트에 유효한 권한이 없음 | {}사이트 인덱스 정보가 유효하지 않음 | 사이트별로 규칙을 생성하고, 권한 부여 기록에서 출처와 대상을 확인합니다. |
| 500 | ft.InternalServerError | 배열 항목 형태 불일치, 필드가 저장 길이 초과, 하위 일반 5xx, 데이터베이스 또는 커밋 후 캐시 실패 | 내부 오류 | 본문의 구조와 길이를 확인하고 현재 구성을 읽어 이미 저장되었는지 확인한 뒤 재시도 여부를 결정하고 traceId를 제공합니다. |
| 404 | ft.NotFoundDataQueryRuleCfg | 현재 워크스페이스에 대상 규칙이 없거나 삭제되었으며, 로그 엔드포인트는 logging으로도 한정됨 | 지정된 로그 쿼리 규칙 구성을 찾지 못함 | 올바른 모듈 목록에서 UUID를 다시 가져옵니다. |