수정¶
POST /api/v1/data_query_rule/{query_rule_uuid}/modify
개요¶
데이터 액세스 규칙을 전체적으로 수정합니다.
호출 전 및 사용 단계¶
먼저 상세 정보를 읽고 전체 쓰기 가능한 필드를 백업한 뒤 다시 채웁니다. 이 API는 전체를 교체합니다. desc/indexes/sources/conditions/extend/logic/maskFields/reExprs를 생략하면 각각 빈 문자열/[]/{} 등의 기본값으로 복원되므로, 이름만 제출하고 다른 구성이 그대로 유지되기를 기대할 수 없습니다. regionCode를 전달하지 않으면 빈 문자열로 저장됩니다. 유형은 원본 레코드를 따르며 이 Body로는 변경할 수 없습니다.
이벤트 keyevent 생성 시에는 add_v2를 사용하고 현재 사이트의 regionCode를 명시하는 것이 좋습니다. 기존 add/modify에서 regionCode를 생략하면 빈 문자열로 간주되어 교차 사이트 권한 부여 검증에 들어가며, 일반적으로 리전 오류가 반환됩니다. 수정 v2는 다시 기존 라우트에 의해 가려지므로, 현재 공개된 수정 API로는 이벤트 규칙/교차 사이트 규칙의 사이트를 안정적으로 보존할 수 없습니다. 이러한 변경은 콘솔에서 처리하고 실제 적용 여부를 확인해야 합니다.
이 기존 엔드포인트는 regionCode를 허용하지 않으며, 제공되지 않으면 빈 문자열로 저장되고 읽기/쿼리 시 현재 사이트로 해석됩니다. 명시적 소스 사이트를 보존해야 하는 규칙을 이 엔드포인트로 수정하는 것은 피해야 합니다.
쓰기 작업은 구성을 교체하고 데이터베이스에 커밋한 다음 규칙 캐시를 지우고 감사 로그를 기록합니다. 교차 사이트 검증은 리소스 정보를 읽거나 업데이트할 수도 있습니다. 단계는 단일 원자적 트랜잭션이 아니므로 500/시간 초과 후에는 목록/상세에서 먼저 저장 여부를 확인하여 무분별하게 반복 생성하는 것을 피해야 합니다.
규칙 저장은 이후 조건에 부합하는 ID의 데이터 쿼리 범위/결과 마스킹에 영향을 주지만, 원본 데이터를 수정, 삭제 또는 보충 수집하지 않으며 역할의 기본 쿼리 권한을 추가하지도 않습니다. 여러 역할 및 규칙은 쿼리 측 정책에 따라 병합되므로 단일 규칙만으로 최종 권한을 추론할 수 없습니다. Owner는 예외이며, 관리자 및 워크스페이스의 “데이터 액세스 범위 제한” 설정은 일치하는 역할이 없을 때의 처리를 변경하므로 대표 구성원의 실제 쿼리로 검증해야 합니다. 저장 후 규칙 캐시가 무효화되지만 진행 중인 모든 쿼리가 즉시 전환된다고 보장할 수는 없습니다.
라우트 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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 문자열로 사용할 경우 백슬래시를 두 번 써야 합니다. |
|
| sources[*] | string | 상위 type에 따라 해석되는 단일 소스이며, 비어 있지 않은 문자열을 권장합니다. 예: monitor가져오기 또는 입력 방법: 해당 데이터 쿼리 결과/소스 목록에서 실제 식별자를 가져옵니다. 이벤트 source에는 이벤트 ID나 모니터 UUID를 입력해서는 안 됩니다. |
|
| conditions | string | 필터 표현식만 입력하고 전체 쿼리나 외부 중괄호는 입력하지 않습니다. 선택 사항이며 기본값은 빈 문자열입니다. 빈 문자열이면 추가 필터링을 하지 않습니다. 4048자를 넘지 않는 것을 권장합니다. keyevent는 Python 문자 수 기준 ≤4048자이고 E 쿼리 구문을 파싱합니다. 다른 유형은 저장 시 조건 의미를 전면적으로 검증하지 않으므로 저장 성공이 향후 쿼리 성공을 보장하지 않습니다. 이 규칙은 액세스가 허용되는 데이터 범위를 정의합니다. 빈 문자열 허용: True null 허용: False 예: `env` = 'production'가져오기 또는 입력 방법: 대상 데이터의 실제 태그/필드에서 DQL 필터 조건을 구성하고, 동일한 소스에서 먼저 쿼리로 검증합니다. |
|
| desc | string | 선택 사항이며 최대 256자(위와 동일한 계수 단위)입니다. 누락되거나 빈 문자열이면 빈 값으로 지워지며, 수정 시 원래 값을 유지하지 않습니다. 빈 문자열 허용: True null 허용: False 최대 길이: 256 예: 仅允许查看生产环境数据。가져오기 또는 입력 방법: 비즈니스 담당자가 규칙 목적과 적용 대상을 작성합니다. |
|
| extend | json | 표시용 임의 JSON을 선택적으로 저장할 수 있으며, 누락 시 {}입니다. 통일된 필수 하위 키나 단위는 없고, 서버가 이 값에서 conditions를 자동 생성하지 않으며, 수정 시 전체가 교체됩니다. 자격 증명은 저장해서는 안 됩니다.null 허용: False 예: {}가져오기 또는 입력 방법: 클라이언트가 자체 편집기에 필요한 표시 구성을 저장합니다. 필요 없으면 {}입니다. |
|
| indexes | array | 로그 규칙에는 명시적으로 제공해야 합니다. 선언상 선택 사항이지만 로그 쿼리에는 유효한 인덱스 범위가 필요하며, []를 생략해도 자동으로 전체로 변경되지 않습니다. ["\*"]는 사용 가능한 모든 로그 인덱스를 의미합니다. *는 단독으로 사용하는 것을 권장하며, []는 전체가 아닙니다. keyevent는 []를 강제로 저장하고, 기타 비로그 유형은 일반적으로 []를 사용합니다. 일반 인덱스 이름으로 UUID를 대체할 수 없으며, 권한 부여가 자동 생성되지 않습니다. 저장 성공이 원격의 모든 리소스가 여전히 유효함을 증명하지는 않습니다.null 허용: False 예: ["default"]가져오기 또는 입력 방법: 로그 인덱스 목록에서 uuid를 가져오며, 기본 인덱스는 default를 사용합니다. 교차 워크스페이스는 권한이 부여된 소스 워크스페이스 UUID:인덱스 UUID를 사용합니다. |
|
| logic | string | 호환 표시 필드이며 일반적으로 and/or입니다. 선택 사항입니다. 생략하면 빈 문자열로 저장됩니다. 실제 적용되는 필터는 conditions를 직접 사용하며, logic을 변경해도 조건이 다시 작성되지 않습니다. 다중 역할/다중 규칙 병합은 이 필드로 제어되지 않습니다.null 허용: False 예: and가져오기 또는 입력 방법: 클라이언트 필터 편집기의 조건 결합 방식과 일치시킵니다. |
|
| maskFields | string | 선택 사항이며, 누락 시 빈 문자열로 이 규칙의 필드 마스킹을 구성하지 않습니다. 수정 시 생략하면 지워집니다. 필드를 선택했고 reExprs=[]이면 null이 아닌 값은 전체 필드가 ***로 마스킹됩니다. 비어 있지 않은 정규식 목록을 제공하면 활성화된 정규식만 적용되며, 모두 비활성화한 것이 전체 필드 마스킹을 의미하지는 않습니다. 저장 열에 맞게 ≤256자를 권장합니다.빈 문자열 허용: True null 허용: False 예: message가져오기 또는 입력 방법: 쿼리 결과의 실제 필드 이름에서 선택하고, 여러 개는 영어 쉼표로 구분합니다(예: message,user_email). *로 전체를 선택할 때는 단독으로 사용해야 하며 구체적 필드와 섞지 않습니다. |
|
| name | string | Y | 선언상 필수이며, 비어 있지 않은 고유 이름을 권장합니다. 빈 문자열도 자동 명명 분기에 들어갈 수 있으므로 이 호환 동작에 의존해서는 안 됩니다. 최대 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와 함께 사용합니다. |
|
| roleUUIDs | array | Y | 필수 배열입니다. ["\*"]는 모든 역할을 의미하며, Owner는 여전히 데이터 액세스 제한을 받지 않습니다. []는 어떤 역할과도 일치하지 않으며 전체를 의미하지 않습니다. 이벤트 keyevent는 비어 있지 않은 문자열 배열이어야 하며, *는 단독으로만 나타날 수 있습니다. 기타 유형은 범위 내 역할 존재 여부를 검증하지만 역할 status=0을 보장하지는 않습니다. 기본 쿼리 권한은 별도로 보유해야 합니다.null 허용: False 예: ["role_example"]가져오기 또는 입력 방법: 역할 목록에서 현재 워크스페이스의 역할 uuid를 가져옵니다. 워크스페이스 멤버 목록에서 구성원의 실제 역할을 확인할 수 있습니다. |
| sources | array | 비로그 범위 배열입니다. ["\*"]는 사용 가능한 모든 소스를 의미하며, []를 생략한다고 전체를 의미하지는 않습니다. logging은 []를 강제로 저장합니다. rum/lineage는 권한이 부여된 워크스페이스 UUID:소스 식별자로 제한할 수 있습니다. tracing/metric/keyevent는 원시 소스 문자열을 사용합니다. keyevent는 비어 있지 않은 문자열 배열이어야 하며 wksp_:소스를 허용하지 않고, *는 다른 값과 섞을 수 없습니다. rum은 현재 regionCode를 명시한 경우에만 애플리케이션 존재 여부를 조회해 확인합니다. 기타 소스는 저장 성공이 실제 데이터 존재를 증명하지 않습니다.null 허용: False 예: ["*"]가져오기 또는 입력 방법: 비로그는 실제 데이터 소스에 따라 입력합니다. rum은 RUM 애플리케이션 목록의 appId, tracing은 service, metric은 메저먼트 이름, lineage는 실제 로그 소스 source, keyevent는 이벤트 source(예: monitor)를 사용합니다. |
매개변수 추가 설명¶
1. 요청 매개변수 설명
| 매개변수 이름 | type | 필수 | 설명 |
|---|---|---|---|
| name | string | Y | 이름 |
| desc | String | N | 설명 |
| indexes | array | Y | type이 logging일 때 필수입니다. 현재 워크스페이스가 아닌 인덱스 권한(워크스페이스 권한 부여 필수)인 경우 워크스페이스 UUID:인덱스 UUID를 사용합니다. 예: ["wksp_111:lgim_222", "wksp_333:lgim_444"] |
| sources | array | Y | type이 logging이 아닐 때 필수입니다. type이 rum이면 애플리케이션 appId 목록, tracing이면 서비스 이름 목록, metric이면 메저먼트 목록입니다. |
| 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"}] |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/data_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"],"sources":[],"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 | 생성한 ID입니다. |
| content.updator | string | 최근 업데이트한 ID이며 초기에는 비어 있을 수 있습니다. |
| content.createAt | integer | 생성 Unix 초입니다. |
| content.updateAt | integer | 업데이트 Unix 초이며, 업데이트되지 않았으면 -1입니다. |
| content.deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않았으면 -1입니다. |
| content.name | string | 저장 값: 선언상 필수이며, 비어 있지 않은 고유 이름을 권장합니다. 빈 문자열도 자동 명명 분기에 들어갈 수 있으므로 이 호환 동작에 의존해서는 안 됩니다. 최대 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=[]이면 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를 제공합니다. |
| 400 | ft.InvalidSources | keyevent 소스 구조가 유효하지 않거나, 현재 사이트를 명시한 rum 소스 애플리케이션이 존재하지 않습니다. | 유효하지 않은 리소스 정보:{} | 이벤트에는 비어 있지 않은 source 문자열 배열을 제공하고 *는 단독으로 사용합니다. RUM은 유효한 애플리케이션에서 appId를 가져옵니다. |
| 406 | ft.InvalidParameter | keyevent conditions가 문자열이 아니거나 길이가 4048자를 초과합니다. | 매개변수 {}가 유효하지 않습니다. |
길이 규정을 준수하는 DQL 조건 문자열을 사용합니다. |
| 406 | ft.DqlParseError | keyevent 조건을 파싱할 수 없습니다. | dql parser 파싱 실패: {} | 이벤트 쿼리에서 필터 조건을 검증하고 원래 오류와 traceId를 보존합니다. |
| 404 | ft.NotFoundDataQueryRuleCfg | 현재 워크스페이스의 대상 규칙이 존재하지 않거나 삭제되었으며, 로그 엔드포인트는 logging으로도 제한됩니다. | 지정된 로그 쿼리 규칙 구성을 찾지 못했습니다. | 올바른 모듈 목록에서 UUID를 다시 가져옵니다. |