단일 데이터 액세스 규칙 수정¶
POST /api/v1/logging_query_rule/{logging_query_rule_uuid}/modify
개요¶
단일 데이터 액세스 규칙을 수정합니다. v2는 사이트 간 데이터 액세스 구성을 지원합니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| logging_query_rule_uuid | string | Y | 규칙의 UUID |
Body 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | 이름 (2024-09-04 반복 추가, 기본 이름: 생성자_생성 시간) 빈 값 허용 안 함: False 빈 문자열 허용 안 함: False 최대 길이: 64 |
|
| desc | string | 설명 (2024-09-04 반복 추가) 예시: 설명1 빈 값 허용 안 함: False 빈 문자열 허용: True 최대 길이: 256 |
|
| regionCode | string | Y | 사이트 기반 데이터 액세스 권한 부여 빈 값 허용 안 함: False 빈 문자열 허용 안 함: False |
| indexes | array | Y | 인덱스 UUID, [""]는 전체를 의미 예시: [''] 빈 값 허용 안 함: False |
| roleUUIDs | array | Y | 역할 목록 예시: [] 빈 값 허용 안 함: False |
| conditions | string | Y | 필터 검색 예시: search 빈 값 허용 안 함: False |
| extend | json | 사용자 정의 예시: xxx 빈 값 허용 안 함: False |
|
| logic | string | 논리 필드 예시: or 빈 값 허용 안 함: False |
|
| maskFields | string | 마스킹 필드, 여러 필드는 쉼표로 구분 예시: message,host 빈 값 허용 안 함: False 빈 문자열 허용: True |
|
| reExprs | array | 정규 표현식 예시: [{'name': 'jjj', 'reExpr': 'ss', 'enable': 0}, {'name': 'lll', 'reExpr': 'ss', 'enable': 1}] 빈 값 허용 안 함: 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 인터페이스를 통해 조회 가능), 데이터 액세스 구성의 사이트 정보, 기본적으로 현재 사이트의 데이터에 권한 부여 |
요청 예시¶
curl 'https://openapi.guance.com/api/v1/logging_query_rule/lqrl_xxx/modify' \
-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 modify","roleUUIDs":["general"],"indexes":["wksp_4b57c7bab38e4a2d9630f675dc20015d:lgim_f2a50518520b467a920103a19133fa8b"],"extend":{"source":["http_dial_testing"]},"maskFields":"host,message","logic":"and","conditions":"`source` IN [\'http_dial_testing\']","reExprs":[{"name":"qq email maxk","enable":true,"reExpr":"[a-zA-Z0-9_]+@guance.com"}]}' \
--compressed
응답¶
{
"code": 200,
"content": {
"conditions": "`source` IN ['http_dial_testing']",
"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 modify",
"extend": {
"source": [
"http_dial_testing"
]
},
"id": 348,
"indexes": [
"wksp_4b57c7bab38e4a2d9630f675dc20015d:lgim_f2a50518520b467a920103a19133fa8b"
],
"logic": "and",
"maskFields": "host,message",
"name": "temp_test",
"reExprs": [
{
"enable": true,
"name": "qq email maxk",
"reExpr": "[a-zA-Z0-9_]+@guance.com"
}
],
"roleUUIDs": [
"general"
],
"sources": [],
"status": 0,
"type": "logging",
"updateAt": 1730529850.881453,
"updator": "wsak_cd83804176e24ac18a8a683260ab0746",
"uuid": "lqrl_9f1de1d1440f4af5917a534299d0ad09",
"workspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-BA54F258-15AD-4752-88C9-CA2B96070625"
}