조회¶
GET /api/v1/data_query_rule/{query_rule_uuid}/get
개요¶
지정한 액세스 규칙의 전체 저장 구성과 소스/역할 정보를 읽습니다.
호출 전 및 사용 단계¶
데이터 액세스 규칙 목록에서 UUID를 가져옵니다. 이 워크스페이스의 모든 데이터 영역 규칙을 읽을 수 있습니다. 저장된 엔터티와 소스, 역할 요약을 반환하며, 목록의 creatorInfo/updatorInfo, memberCount 또는 relMemberInfos는 반환하지 않습니다. 소스 정보는 이력이거나 누락될 수 있고, grantStatus=3은 권한 부여를 사용할 수 없음을 나타냅니다. 저장된 구성을 현재 유효한 권한 증명으로 간주하지 마세요.
규칙 저장은 이후 조건에 부합하는 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를 가져옵니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/data_query_rule/lqrl_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
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=[]인 경우 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.indexWsInfo | string 또는 object | 로그 규칙 전용: *는 전체를 의미하고, 그렇지 않으면 원래 indexes 멤버를 동적 키로 사용합니다. 리소스가 없거나 정보를 가져올 수 없으면 하위 객체가 {}일 수 있습니다. |
| content.indexWsInfo.인덱스 식별자 | object | 구성된 인덱스 하나의 공간 및 인덱스 정보입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo | object | 소스 워크스페이스 정보이며 빈 객체일 수 있습니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.uuid | string | 소스 워크스페이스 UUID입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.name | string | 소스 워크스페이스 이름입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.status | integer | 워크스페이스 상태입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.regionCode | string | 사이트 코드입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.regionName | string 또는 null | 사이트 지역화 이름입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.datastore | object | 선택 사항이며, 각 데이터 유형에 대응하는 스토리지 클래스 매핑입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.datastore.데이터 유형 | string | 예: logging은 scopedb에 대응하며 쓰기 가능한 구성이 아닙니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.durationSet | object | 선택 사항이며, 각 데이터 유형의 보존 기간입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.durationSet.데이터 유형 | string | 정수+d 형태의 기간 문자열이며 데이터 영역별로 구분됩니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.storagePolicy | object | 로그 소스 워크스페이스의 선택적 장기 정책 매핑입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.storagePolicy.데이터 유형 | object | 해당 데이터 영역의 장기 정책입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.storagePolicy.데이터 유형.isEnable | boolean | 장기 정책 활성화 여부입니다. |
| content.indexWsInfo.인덱스 식별자.wsInfo.storagePolicy.데이터 유형.duration | string | 장기 보존 기간입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo | object | 일반 인덱스의 전체 엔터티 또는 default 합성 하위 집합입니다. 이력/원격 정보에는 필드가 누락될 수 있으므로 전체를 그대로 다시 전송하여 쓰지 마세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.id | integer 또는 null | 데이터베이스 레코드 번호입니다. 신규 생성 제출 전 스냅샷은 null일 수 있으며 작업에는 uuid를 사용합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.uuid | string | lgim_인덱스 구성 UUID이며 기본 인덱스는 default를 사용합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.sourceIndexUUID | string | 클론 인덱스 B의 소스 A UUID이며 일반 인덱스는 비어 있습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.name | string | 인덱스 이름입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.desc | string | 설명입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.conditions | string | extend에 따라 생성된 실제 조건 문자열이며 일반 요청에서는 이 필드를 직접 수정하지 마세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.sortNo | integer 또는 string | 일치 순서 식별자이며 네이티브 직접 쓰기 또는 클론은 일반적으로 0입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.duration | string | 표준 스토리지 기간이며 TLS는 핫/콜드 아카이브 합계 일수입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.isBindCustomStore | integer 또는 boolean | 1/true이면 외부 스토리지에 바인딩됩니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.directIndex | integer 또는 boolean | 1/true이면 네이티브 직접 쓰기입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.isFullLineIndex | integer | 1은 전체 행, 0은 Message입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.queryType | string | 조회 범주이며 예: logging/standard 또는 외부 SLS가 반환하는 모드입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.exterStoreProject | string | 외부 프로젝트/데이터베이스 식별자이며 내부 인덱스는 일반적으로 비어 있습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.exterStoreName | string | 외부 리소스 이름이며 내부는 일반적으로 비어 있습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.externalResourceAccessCfgUUID | string | 액세스 구성 식별자이며 자격 증명 원문이 아닙니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.storeType | string | 내부 인덱스는 일반적으로 비어 있고 외부 바인딩 시 실제 유형입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.region | string | 외부 리전 코드입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.isPublicNetworkAccess | integer 또는 boolean | 공용 네트워크 액세스 플래그입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.status | integer | 0 활성화, 2 비활성화, 3 삭제. |
| content.indexWsInfo.인덱스 식별자.indexInfo.creator | string | 생성 주체입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.updator | string | 최근 업데이트 주체입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.createAt | integer | 생성 Unix 초입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.updateAt | integer | 업데이트 Unix 초이며, 미업데이트 시 -1입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.deleteAt | integer | 삭제 Unix 초이며, 미삭제 시 -1입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.storagePolicy | object | 선택적 전체 장기 정책 객체입니다. 일반 신규 생성 시 {}를 생략하고, 수정 시 생략하면 유지되며, {}는 비활성화로 정규화되고 명시적 비활성화는 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 엄격히 커야 하며 단위는 여전히 일입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.storagePolicy.longStorageEnabled | boolean | 객체 내에서 누락 시 기본값 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되지만 기록 데이터가 즉시 삭제됨을 의미하지는 않습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.storagePolicy.longStorageDuration | string | 활성화 시 조건부 필수입니다. 필드는 d를 포함한 문자열이며 초/시간이 아니고 메트릭 rp의 3600d 범위를 로그에 적용하지 마세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.setting | object | TLS 신규 생성 시 hot_retention을 반드시 제공해야 하며, 총 duration은 세 시간 수의 합을 일로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지 및 필요한 단계를 완전히 제공하고 cold_retention만 전달하지 마세요. 기타 스토리지는 이 필드를 TLS로 해석하지 않습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.setting.hot_retention | integer | TLS 조건부 필수이며 기본 범위는 1~1800일로 24..43200시간에 대응하고 24의 배수입니다. 콜드 스토리지 사용 시 핫 스토리지는 최소 7일, 아카이브 사용 시 최소 30일입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.setting.cold_retention | integer | 선택 사항이며 기본 30..1800일이고 정수 일의 시간 수입니다. 0으로 생략을 표현하지 않으며 총합은 1800일을 초과할 수 없습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.setting.archive_retention | integer | 선택 사항이며 기본 60..1800일이고 정수 일의 시간 수입니다. 핫 스토리지는 최소 30일이며 총합은 1800일을 초과할 수 없습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend | object | 선택적 확장 객체로 실제 일치 및 표시 구성을 포함합니다. 일반 modify는 첫 번째 레벨 키 기준으로 병합하며 제공하지 않은 키는 유지되고 배열 또는 중첩 객체는 전체 교체됩니다. {}는 기존 filters를 지우지 않습니다. null을 피하세요. 일부 수정 분기에서는 500이 발생합니다. 가져오기 recover는 extend를 전체 교체합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.matchMode | string | 생략/빈 값은 basic으로 처리합니다. advanced는 advancedFilter를 사용하고 basic은 filters를 사용하며, 모드 전환 시 해당하는 전체 조건을 함께 제공하세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters | array | basic의 리프 배열이며 비어 있지 않은 조건은 conditions를 생성합니다. 신규 생성/수정 basic은 operation이 match 또는 not match인 것을 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].name | string | 실제 필드 이름이며 백틱을 추가하지 마세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].condition | string | 이전 조건과의 and/or 관계이며 첫 항목의 연결자는 무시됩니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].operation | string | 일반적으로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. basic에서는 match/not match를 금지합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].value | array | 조건 값 배열이며 = 및 비교는 첫 항목을 사용합니다. 존재 유형은 여전히 비어 있지 않은 자리 표시자 배열을 권장합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters[] | json | 조건 객체이며 필드 이름/연산/값이 완전해야 합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].value[] | JSON | 단일 비교 값이며 표시 이름으로 실제 값을 대체하지 마세요. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter | json | advanced일 때 필수인 루트 group 객체입니다. 그룹은 type=group, condition, filters를 사용하고 리프는 type=rule, name, operation, value를 사용합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.type | string | 루트 노드 유형이며 rule일 수 없습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.condition | string | 동일 그룹 하위 조건의 논리 관계입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters | array | 하위 노드 배열이며 동일한 group 구조의 중첩을 허용합니다. 빈 그룹은 빈 조건을 생성합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[] | json | rule 리프 또는 group 객체입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].type | string | rule은 리프, group은 재귀 그룹입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].name | string | rule 필수이며 비어 있지 않은 필드 이름입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].operation | string | rule은 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].value | array | rule 필수 배열이며 exist/not_exist는 []를 사용할 수 있고 나머지는 빈 배열을 허용하지 않습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].condition | string | group 하위 그룹은 and/or를 사용합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].filters | array | group 하위 그룹의 재귀 배열이며 규칙 리프는 생략합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].value[] | JSON | 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields | array | 선택적 주요 필드 배열입니다. tag/alias 구조로 제출하고 tag는 비어 있지 않아야 합니다. 신규 생성은 이 구조 검증을 강제하지 않지만 수정 시 검증합니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스를 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields[] | json | tag/alias 키만 허용합니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields[].tag | string | 조건부 필수이며 비어 있지 않은 키입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields[].alias | string | 선택적 표시 별칭입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.topFields | array | 선택적 표시 구성이며 동일한 tag/alias 객체로 사용합니다. 일반 modify는 독립적인 상단 고정 API가 아닙니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.topFields[] | json | 단일 표시 필드 객체입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.topFields[].tag | string | 필드 키입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.topFields[].alias | string | 선택적 별칭입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.services | array | 선택적 에코 정보이며 filters의 실제 일치 조건을 대체하지 않습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.extend.services[] | string | 단일 서비스 표시 값입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.workspaceName | string | 소스 워크스페이스 이름이며 생략할 수 있습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.workspaceStatus | integer | 소스 워크스페이스 상태이며 생략할 수 있습니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.regionCode | string | 소스 사이트 코드입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.regionName | string 또는 null | 소스 사이트 이름입니다. |
| content.indexWsInfo.인덱스 식별자.indexInfo.grantStatus | integer | 선택 사항이며 3은 현재 권한 부여를 사용할 수 없음을 나타냅니다. 필드가 없다고 다른 액세스 조건 충족이 보장되는 것은 아닙니다. |
| content.sourcesWsInfo | string 또는 object | 비로그 규칙 전용: *는 전체를 의미하고, 그렇지 않으면 sources 원시 멤버를 키로 사용합니다. 기타 유형은 소스 이름만 표시하며 리소스 존재를 보장하지 않습니다. |
| content.sourcesWsInfo.소스 식별자 | object | 소스 요약 하나입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo | object | RUM은 소스 워크스페이스 정보가 있을 수 있고 기타 유형은 일반적으로 {}입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.uuid | string | 소스 워크스페이스 UUID입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.name | string | 소스 워크스페이스 이름입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.status | integer | 워크스페이스 상태입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.regionCode | string | 사이트 코드입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.regionName | string 또는 null | 사이트 지역화 이름입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.datastore | object | 선택 사항이며, 각 데이터 유형에 대응하는 스토리지 클래스 매핑입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.datastore.데이터 유형 | string | 예: logging은 scopedb에 대응하며 쓰기 가능한 구성이 아닙니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.durationSet | object | 선택 사항이며, 각 데이터 유형의 보존 기간입니다. |
| content.sourcesWsInfo.소스 식별자.wsInfo.durationSet.데이터 유형 | string | 정수+d 형태의 기간 문자열이며 데이터 영역별로 구분됩니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo | object | RUM 애플리케이션 엔터티 또는 기타 유형의 {name,status}이며 정보가 없으면 {}일 수 있습니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.name | string | 비RUM 소스의 원시 이름입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.id | integer | 애플리케이션 레코드 번호입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.uuid | string | appId와 동일합니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.appId | string | RUM 소스 식별자입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.workspaceUUID | string | 애플리케이션이 속한 워크스페이스입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.clientToken | string | 애플리케이션 수집 식별자이며 생략할 수 있습니다. 이 인터페이스의 API Key가 아니며 예시에 실제 값을 출력하지 않습니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.jsonContent | object | 애플리케이션 구성이며 유형마다 구조가 다릅니다. 해당 유형은 RUM 애플리케이션 상세 설명으로 해석하세요. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.jsonContent.구성 키 | JSON | 해당 애플리케이션 유형의 저장된 구성이며 예: name/type 등입니다. 여기서는 표시만 하며 액세스 규칙 매개변수가 아닙니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.status | integer | 애플리케이션 상태이며 이력상 유효하지 않을 수 있습니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.creator | string | 생성 주체입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.updator | string | 업데이트 주체입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.createAt | integer | 생성 Unix 초입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.updateAt | integer | 업데이트 Unix 초입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.deleteAt | integer | 삭제 Unix 초입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.workspaceName | string | 워크스페이스 이름입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.workspaceStatus | integer | 워크스페이스 상태입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.regionCode | string | 소스 사이트 코드입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.regionName | string 또는 null | 소스 사이트 이름입니다. |
| content.sourcesWsInfo.소스 식별자.sourcesInfo.grantStatus | integer | 선택 사항이며 3은 권한 부여가 현재 유효하지 않음을 나타냅니다. |
| content.relRoleInfos | array<object> |
읽기 시 일치하는 역할 요약입니다. *는 유효한 비Owner 역할을 확장하며, 지정 역할은 이력 status 또는 {}를 반환할 수 있습니다. |
| content.relRoleInfos[] | object | 단일 역할 요약이며 찾을 수 없으면 {}일 수 있습니다. |
| content.relRoleInfos[].uuid | string | 역할 UUID이며 생략할 수 있습니다. |
| content.relRoleInfos[].name | string | 역할 이름이며 생략할 수 있습니다. |
| content.relRoleInfos[].status | integer | 역할 상태이며 생략할 수 있습니다. |
| content.regionName | string 또는 null | 소스 사이트 지역화 이름이며 조회할 수 없으면 null일 수 있습니다. |
| content.declaration | object | 공통 선언입니다. |
{
"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": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"indexWsInfo": {
"default": {
"wsInfo": {},
"indexInfo": {}
}
},
"regionName": "예시 사이트",
"relRoleInfos": [
{
"uuid": "role_example",
"name": "프로덕션 조회",
"status": 0
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundDataQueryRuleCfg | 이 워크스페이스에서 지정한 비삭제 규칙을 찾을 수 없거나 로그 진입점 대상이 logging이 아닙니다. | 지정한 로그 쿼리 규칙 구성을 찾을 수 없습니다. | 해당 목록에서 UUID를 다시 가져옵니다. |
| 404 | ft.NoInitOtherNodeCfg | 원격 인덱스/RUM 애플리케이션 메타데이터를 읽거나 검증할 때 사용 가능한 소스 사이트 주소를 찾지 못했습니다. | 다른 노드 구성이 초기화되지 않았습니다. | 관리자가 소스 사이트 구성, 액세스 가능한 주소 및 유효한 워크스페이스 간 권한 부여를 확인하고 수정한 후 다시 시도합니다. |
| 500 | ft.InternalServerError | 규칙, 역할, 소스 워크스페이스 또는 인덱스/애플리케이션 메타데이터 읽기 및 형식 지정에 실패했습니다. | 내부 오류입니다. | 권한이 부여된 소스 및 사이트 정보를 새로 고친 후 잠시 후 다시 시도합니다. 계속 실패하면 traceId를 제공합니다. |