단일 데이터 액세스 규칙 생성¶
POST /api/v1/data_query_rule/add_v2
개요¶
데이터 액세스 규칙(지정 사이트)을 생성합니다.
호출 전 및 사용 단계¶
먼저 데이터 도메인, 역할, 소스 및 DQL 조건을 확인한 다음 고유 이름으로 생성하십시오. 새 규칙은 status=0이면 즉시 활성화 상태가 됩니다. 쓰기 성공이 소스에 데이터가 있거나 최종 구성원 권한이 예상과 일치함을 보장하지는 않습니다.
이벤트 keyevent 생성 시에는 add_v2를 사용하고 현재 사이트의 regionCode를 명시적으로 지정하는 것을 권장합니다. 기존 add/modify에서 regionCode를 생략하면 빈 문자열로 간주되어 교차 사이트 권한 검증에 들어가며, 일반적으로 리전 오류가 반환됩니다. 수정 v2는 다시 기존 라우트에 의해 가려지므로, 현재 공개된 수정 기능으로는 이벤트 규칙/교차 사이트 규칙의 사이트를 안정적으로 유지할 수 없습니다. 이러한 변경은 콘솔에서 처리하고 실제 적용 여부를 확인하십시오.
이 독립 add_v2 경로는 regionCode를 허용합니다. 예시의 example-region은 실제 사이트 코드로 바꿔야 하며, 로그의 각 인덱스는 여러 사이트에 걸쳐 있으면 안 됩니다.
쓰기는 구성을 교체하고 데이터베이스에 커밋한 뒤 규칙 캐시를 지우고 감사를 기록합니다. 교차 사이트 검증은 리소스 자료를 읽거나 업데이트할 수도 있습니다. 단계는 단일 원자 트랜잭션이 아니므로 500/타임아웃 후에는 목록/상세에서 저장 여부를 먼저 확인하여 무작정 중복 생성하지 마십시오.
규칙 저장은 이후 조건에 해당하는 주체의 데이터 쿼리 범위/결과 마스킹에 영향을 주며, 원본 데이터를 수정, 삭제 또는 보충 수집하지 않고 역할의 기본 쿼리 권한을 새로 추가하지도 않습니다. 여러 역할 및 규칙은 쿼리 측 정책에 따라 병합되므로 단일 규칙만으로 최종 권한을 추론할 수 없습니다. Owner는 예외이며, 관리자와 워크스페이스의 "데이터 액세스 범위 제한" 설정은 일치하는 역할이 없을 때의 처리를 변경하므로 대표 구성원을 사용해 실제 쿼리로 검증해야 합니다. 저장 후 규칙 캐시가 무효화되지만 모든 진행 중인 쿼리가 즉시 전환됨을 보장하지 않습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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와 함께 사용합니다. |
|
| regionCode | string | Y | v2는 소스 사이트 code를 필수로 선언하며, 동일 규칙의 로그 인덱스는 동일 사이트에 속하고 이 값과 일치해야 합니다. 기존 진입점은 이 필드를 허용하지 않습니다. 데이터 액세스 규칙은 교차 사이트/교차 워크스페이스 권한 부여를 대체하지 않으며, 이벤트가 교차 사이트인 경우 keyevent 또는 *를 포함한 유효한 권한 부여가 있어야 합니다. 아래의 중복 라우트 실제 도달 가능성 설명에 유의하십시오. 빈 문자열 허용: False null 허용: False 예시: example-region획득 또는 입력 방법: 대상 소스 사이트 및 유효한 교차 워크스페이스 권한 부여 목록에서 실제 regionCode를 확인합니다. 현재 사이트도 공식 코드를 사용하며 예시 리터럴 값을 입력하지 마십시오. |
| 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)를 사용합니다. |
|
| type | string | Y | 생성 시 logging/rum/tracing/metric/lineage/keyevent 중 하나가 필수입니다. 선언상 null을 허용하지만 잘못된 유형으로는 정상적인 쿼리 규칙을 구성할 수 없으므로 항상 위 문자열을 제출해야 합니다. 수정 시 type을 허용하지 않으며 저장된 유형을 따릅니다. null 허용: True 선택 가능한 값: ['lineage', 'keyevent', 'logging', 'rum', 'tracing', 'metric'] 예시: logging획득 또는 입력 방법: 제한할 데이터 도메인에 따라 선택합니다. |
파라미터 추가 설명¶
데이터 설명.*
1. 역할 권한 부여 액세스 설명 1. 지정된 역할은 지정된 쿼리 범위 내의 데이터만 쿼리할 수 있습니다. 2. 사용자에게 여러 역할이 있고, 해당 사용자의 역할 중 이 규칙의 역할에 포함되지 않는 역할이 있으면 이 데이터 액세스 규칙은 해당 사용자에게 적용되지 않으며, 즉 쿼리 범위를 제한하지 않습니다. 3. 한 워크스페이스의 여러 로그 데이터 액세스 규칙 간 논리는 OR 관계입니다.
2. 요청 파라미터 설명
| 파라미터 이름 | type | 필수 | 설명 |
|---|---|---|---|
| name | string | Y | 이름 |
| desc | String | N | 설명 |
| type | String | Y | 유형(logging, rum, tracing, metric) |
| 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"}] |
| regionCode | string | Y | 사이트 code(workspace/website/list API를 통해 획득 가능) |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/data_query_rule/add_v2' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"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":"example-region"}'
응답¶
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 | 저장 값: 선언상 필수이며 비어 있지 않은 고유 이름을 권장합니다. 빈 문자열도 자동 이름 지정 분기에 진입할 수 있으므로 이 호환 동작에 의존하지 마십시오. 최대 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는 소스 사이트 code를 필수로 선언하며, 동일 규칙의 로그 인덱스는 동일 사이트에 속하고 이 값과 일치해야 합니다. 기존 진입점은 이 필드를 허용하지 않습니다. 데이터 액세스 규칙은 교차 사이트/교차 워크스페이스 권한 부여를 대체하지 않으며, 이벤트가 교차 사이트인 경우 keyevent 또는 *를 포함한 유효한 권한 부여가 있어야 합니다. 아래의 중복 라우트 실제 도달 가능성 설명에 유의하십시오. |
| content.declaration | object | 공통 선언이며, 쓰기 응답에는 소스/역할/주체 요약이 자동으로 추가되지 않습니다. |
{
"code": 200,
"content": {
"id": null,
"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": "example-region",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"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를 유지하십시오. |