단일 데이터 액세스 규칙 생성¶
POST /api/v1/logging_query_rule/add
개요¶
단일 데이터 액세스 규칙을 생성합니다. v2는 교차 사이트의 데이터 액세스 구성을 지원합니다.
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | 이름 (2024-09-04 반복 추가, 기본 이름, 생성자_생성 시간) Null 허용: False 빈 문자열 허용: False 최대 길이: 64 |
|
| desc | string | 설명 (2024-09-04 반복 추가) 예시: 설명1 Null 허용: False 빈 문자열 허용: True 최대 길이: 256 |
|
| regionCode | string | Y | 사이트 기반 데이터 액세스 권한 Null 허용: False 빈 문자열 허용: False |
| indexes | array | Y | 인덱스 UUID, [""]는 전체를 의미 예시: [''] Null 허용: False |
| roleUUIDs | array | Y | 역할 목록 예시: [] Null 허용: False |
| conditions | string | Y | 필터 검색 예시: search Null 허용: False |
| extend | json | 프론트엔드 사용자 정의 확장 필드 예시: xxx Null 허용: False |
|
| logic | string | Y | 논리 필드 예시: or Null 허용: False |
| maskFields | string | 마스킹 필드, 여러 필드는 쉼표(,)로 구분 예시: message,host Null 허용: False 빈 문자열 허용: True |
|
| reExprs | array | 정규 표현식 예시: [{'name': 'jjj', 'reExpr': 'ss', 'enable': 0}, {'name': 'lll', 'reExpr': 'ss', 'enable': 1}] Null 허용: False |
파라미터 추가 설명¶
데이터 설명.*
1. 역할 권한 액세스 설명 1. 지정된 역할은 지정된 쿼리 범위 내의 데이터만 조회할 수 있습니다. 2. 사용자가 여러 역할을 가지고 있는 경우, 해당 사용자의 역할 중 하나라도 이 규칙의 역할에 포함되지 않으면 이 데이터 액세스 규칙은 해당 사용자에게 적용되지 않습니다. 즉, 쿼리 범위가 제한되지 않습니다. 3. 하나의 워크스페이스 내 여러 로그 데이터 액세스 규칙 간의 논리는 or 관계입니다.
2. 요청 파라미터 설명
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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의 구조적 내용을 저장하며 프론트엔드 페이지 표시용, 예: |
| 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 | 사이트 코드(workspace/website/list API를 통해 조회 가능), 데이터 액세스 구성의 사이트 정보, 기본적으로 현재 사이트의 데이터에 권한 부여 |
요청 예시¶
curl 'https://openapi.guance.com/api/v1/logging_query_rule/add' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw $'{"name":"temp_test","desc":"test openapi","roleUUIDs":["general","role_3ac3042991c046f0b03452771012b268"],"indexes":["wksp_4b57c7bab38e4a2d9630f675dc20015d:lgim_f2a50518520b467a920103a19133fa8b","wksp_eee1a762ed954b7588e30d9bccb717d5:lgim_72143917855c48abae5d4fb1d2fb7a1f"],"extend":{"city":["Tafuna"]},"maskFields":"message","logic":"and","reExprs":[{"name":"qq email maxk","reExpr":"[a-zA-Z0-9_]+@guance.com","enable":true}],"conditions":"`city` IN [\'Tafuna\']"}' \
--compressed
응답¶
{
"code": 200,
"content": {
"conditions": "`city` IN ['Tafuna']",
"createAt": 1730529443,
"creator": "wsak_cd83804176e24ac18a8a683260ab0746",
"declaration": {
"asd": "aa,bb,cc,1,True",
"asdasd": "dawdawd",
"business": "aaa",
"dd": "dd",
"fawf": "afawf",
"organization": "64fe7b4062f74d0007b46676"
},
"deleteAt": -1,
"desc": "test openapi",
"extend": {
"city": [
"Tafuna"
]
},
"id": null,
"indexes": [
"wksp_4b57c7bab38e4a2d9630f675dc20015d:lgim_f2a50518520b467a920103a19133fa8b",
"wksp_eee1a762ed954b7588e30d9bccb717d5:lgim_72143917855c48abae5d4fb1d2fb7a1f"
],
"logic": "and",
"maskFields": "message",
"name": "temp_test",
"reExprs": [
{
"enable": true,
"name": "qq email maxk",
"reExpr": "[a-zA-Z0-9_]+@guance.com"
}
],
"roleUUIDs": [
"general",
"role_3ac3042991c046f0b03452771012b268"
],
"sources": [],
"status": 0,
"type": "logging",
"updateAt": null,
"updator": null,
"uuid": "lqrl_9f1de1d1440f4af5917a534299d0ad09",
"workspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-25C229E5-150F-4DF1-8576-DE17259B7A16"
}