목록 조회¶
GET /api/v1/data_query_rule/list
개요¶
다양한 데이터 액세스 규칙과 해당 규칙의 소스 및 활성화/비활성화 설정을 페이지 단위로 조회합니다.
호출 전 준비 및 사용 단계¶
현재 워크스페이스의 삭제되지 않은 규칙을 조회하며, 비활성화된 항목도 포함하고 createAt 기준 내림차순으로 정렬합니다. type은 반드시 명시해야 하며, role/index/source 각 필터 그룹 간에는 AND, 그룹 내에서는 하나라도 일치하면 됩니다. 구성 확인을 위한 구성원/역할 요약을 반환하며, 각 구성원의 최종 유효 권한을 의미하지는 않습니다.
규칙 저장은 이후 조건에 부합하는 ID의 데이터 조회 범위/결과 마스킹에 영향을 주며, 원본 데이터를 수정, 삭제 또는 추가 수집하지 않고 역할의 기본 조회 권한을 새로 추가하지도 않습니다. 여러 역할 및 규칙은 쿼리 측 정책에 따라 병합되므로 단일 규칙만으로 최종 권한을 추론할 수 없습니다. Owner는 예외이며, 관리자 및 워크스페이스의 '데이터 액세스 범위 제한' 설정은 일치하는 역할이 없을 때의 처리를 변경하므로 대표 구성원의 실제 쿼리로 검증해야 합니다. 저장 후 규칙 캐시가 무효화되지만, 진행 중인 모든 쿼리가 즉시 전환된다고 보장할 수는 없습니다.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| indexUUIDs | commaArray | 선택 사항입니다. *를 포함한 규칙은 자동으로 일치합니다. 현재 다른 항목은 결합된 인덱스 식별자의 포함 일치를 사용하므로 근사 일치할 수 있으며, indexes를 다시 확인해야 합니다. null 허용: False 예시: default획득 또는 입력 방법: 로그 인덱스 목록에서 UUID/default를 가져오며, 여러 개는 영문 쉼표로 구분합니다. |
|
| isMask | string | 선택 사항입니다. maskFields가 빈 문자열인지 여부로만 판단하며, 정규식이 실제로 활성화되었거나 일치함을 의미하지는 않습니다. null 허용: False 선택 가능한 값: ['true', 'false'] 예시: true획득 또는 입력 방법: 마스킹 필드가 구성된 항목을 필터링해야 하면 문자열 true, 그렇지 않으면 false입니다. |
|
| pageIndex | integer | 선택 사항이며 기본값은 1입니다. 선언된 최솟값은 없으며 호출자는 양의 정수를 선택해야 합니다. null 허용: False 예시: 1획득 또는 입력 방법: 1부터 시작하여 최상위 pageInfo에 따라 계속 조회합니다. |
|
| pageSize | integer | 선택 사항이며 기본값은 50입니다. 선언된 최댓값은 없습니다. 페이지 크기를 작게 하면 반환량은 줄어들지만 현재 구현은 일치하는 모든 규칙을 먼저 읽은 후 페이지를 나누므로 페이지별로 순차 조회하는 것이 좋습니다. null 허용: False 예시: 50획득 또는 입력 방법: 클라이언트 용량에 따라 50과 같은 적절한 양의 정수를 선택합니다. |
|
| roleUUIDs | commaArray | 선택 사항입니다. 하나라도 일치하는 역할 또는 *를 포함한 규칙에 일치하며, JSON 배열이 아닙니다. null 허용: False 예시: role_example획득 또는 입력 방법: 역할 목록에서 UUID를 가져오며, 여러 개는 영문 쉼표로 구분합니다. |
|
| search | string | 선택 사항입니다. name 기준 포함 일치이며 설명, 필드 또는 데이터는 검색하지 않습니다. null 허용: True 예시: production획득 또는 입력 방법: 규칙 이름 키워드입니다. |
|
| sources | commaArray | 선택 사항입니다. 배열 구성원이 하나라도 정확히 일치하거나 *를 포함하면 일치하며, 다른 필터와 AND로 결합됩니다. null 허용: False 예시: monitor획득 또는 입력 방법: 대상 도메인의 실제 소스에서 값을 가져오며, 여러 개는 영문 쉼표로 구분합니다. |
|
| type | string | Y | Query 선언상 필수입니다. 일반 URL에서는 JSON null로 '전체'를 표현할 수 없으므로 유형을 명시적으로 선택해야 합니다. null 허용: True 선택 가능한 값: ['lineage', 'keyevent', 'logging', 'rum', 'tracing', 'metric'] 예시: logging획득 또는 입력 방법: logging/rum/tracing/metric/lineage/keyevent 중에서 대상 데이터 도메인을 선택합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/data_query_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode type=logging \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=50
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.data | array<object> |
이 페이지의 규칙이며 결과가 없으면 []입니다. |
| content.data[].id | integer 또는 null | 레코드 번호입니다. 생성 제출 전 스냅샷에서는 null일 수 있으며, 후속 작업에는 uuid를 사용합니다. |
| content.data[].uuid | string | lqrl_ 규칙 UUID이며, 두 모듈이 엔터티와 식별자를 공유합니다. |
| content.data[].workspaceUUID | string | 이 규칙이 속한 워크스페이스로, 소스 워크스페이스와 구분됩니다. |
| content.data[].status | integer | 0 활성화, 2 비활성화, 3 삭제입니다. 이 모듈은 삭제되지 않은 항목만 조회합니다. |
| content.data[].creator | string | 생성 주체입니다. |
| content.data[].updator | string | 최근 업데이트 주체이며 초기에는 비어 있을 수 있습니다. |
| content.data[].createAt | integer | 생성 Unix 초입니다. |
| content.data[].updateAt | integer | 업데이트 Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].name | string | 저장 값: 선언상 필수이며 비어 있지 않은 고유 이름을 권장합니다. 빈 문자열도 자동 이름 지정 분기로 진입할 수 있으므로 이 호환 동작에 의존하지 마십시오. 최대 64 계수 단위(ASCII/반각 가타카나 1, 기타 문자 2)입니다. 활성화 및 비활성화된 동일 유형 규칙이 모두 중복 이름 검사에 참여합니다. |
| content.data[].desc | string | 저장 값: 선택 사항이며 최대 256자(위와 동일한 계수 단위)입니다. 누락/빈 문자열은 빈 값으로 정리되며, 수정 시 원래 값을 유지하는 것이 아닙니다. |
| content.data[].indexes | array | 저장 값: 로그 규칙에서는 명시적으로 제공해야 합니다. 선언상 선택 사항이지만 로그 조회에는 유효한 인덱스 범위가 필요하며, []를 생략해도 자동으로 전체로 변경되지 않습니다. ["*"]는 사용 가능한 모든 로그 인덱스를 의미합니다. *는 단독으로 사용하는 것을 권장하며, []는 전체가 아닙니다. keyevent는 []를 강제로 저장하고 다른 비로그 유형은 일반적으로 []를 사용합니다. 일반 인덱스 이름으로 UUID를 대체할 수 없으며 권한 부여가 자동 생성되지 않습니다. 저장 성공이 원격의 모든 리소스가 여전히 유효함을 증명하지는 않습니다. |
| content.data[].indexes[] | string | 저장 값: 배열 구성원은 비어 있지 않은 문자열을 권장합니다. 원래 선언에서 각 항목을 강제하지 않았으며, 잘못된 유형은 500을 유발할 수 있습니다. |
| content.data[].roleUUIDs | array | 저장 값: 필수 배열입니다. ["*"]는 각 역할을 의미하며 Owner는 여전히 데이터 액세스 제한을 받지 않습니다. []는 어떤 역할과도 일치하지 않으며 전체와 같지 않습니다. 이벤트 keyevent는 비어 있지 않은 문자열 배열이어야 하며 *는 단독으로만 나타날 수 있습니다. 다른 유형은 범위 내 역할 존재 여부를 검증하지만 역할 status=0을 보장하지는 않습니다. 기본 조회 권한은 여전히 별도로 보유해야 합니다. |
| content.data[].roleUUIDs[] | string | 저장 값: 유효한 역할을 사용해야 하며 계정 UUID를 사용하지 마십시오. |
| content.data[].conditions | string | 저장 값: 필터 표현식만 입력하고 전체 쿼리나 외부 중괄호는 입력하지 않습니다. 선택 사항이며 기본값은 빈 문자열입니다. 빈 문자열은 추가 필터링을 하지 않습니다. 4048자를 넘지 않도록 권장합니다. keyevent는 Python 문자 수 ≤4048 기준으로 E 쿼리 구문을 파싱하며, 다른 유형은 저장 시 조건 의미를 전면적으로 검증하지 않으므로 성공이 향후 쿼리 성공을 보장하지 않습니다. 이 규칙은 액세스가 허용되는 데이터 범위를 정의합니다. |
| content.data[].extend | json | 저장 값: 선택적 임의 JSON 반환 값이며 기본값은 {}입니다. 통일된 필수 하위 키나 단위가 없고 서버가 여기서 conditions를 자동 생성하지 않습니다. 수정 시 전체 교체되며 자격 증명을 저장하지 마십시오. |
| content.data[].extend.사용자 정의 키 | any | 저장 값: 직렬화 가능한 임의 JSON 값이며 추가로 적용되는 조건이 아닙니다. |
| content.data[].logic | string | 저장 값: 호환용 반환 필드이며 일반적으로 and/or입니다. 선택 사항입니다. 생략하면 빈 문자열로 저장됩니다. 실제 적용되는 필터는 conditions를 직접 사용하며, logic을 변경해도 조건이 다시 작성되지 않고 여러 역할/여러 규칙의 병합은 이 필드로 제어되지 않습니다. |
| content.data[].maskFields | string | 저장 값: 선택 사항이며 기본값인 빈 문자열은 이 규칙의 필드 마스킹을 구성하지 않습니다. 수정 시 생략하면 비워집니다. 필드를 선택했고 reExprs=[]이면 null이 아닌 값은 전체 필드가 ***로 가려집니다. 비어 있지 않은 정규식 목록을 제공하면 활성화된 정규식만 적용되며, 모두 비활성화된 것이 전체 필드 마스킹과 같지는 않습니다. 저장 열에 맞게 256자 이하를 권장합니다. |
| content.data[].reExprs | array | 저장 값: 선택 사항이며 기본값은 []이고 수정 시 전체 교체됩니다. 저장 시 각 항목의 정규식을 모두 검증하며 enable=false 항목도 포함합니다. 잘못된 정규식은 ft.ErrorRegularExpression을 반환합니다. 임의 문자열을 나타내기 위해 단독 *를 사용하지 말고 .*를 사용하십시오. 선택한 필드에 정규식이 없으면 전체 필드가 ***로 처리됩니다. 정규식은 문자열 내용에서 일치하는 조각만 처리하며 일치 내용을 ***로 바꿉니다. 저장 검증과 실행 엔진에는 차이가 있으므로 저장 성공 후에도 대표 쿼리로 검증해야 합니다. |
| content.data[].reExprs[] | json | 저장 값: name/enable/reExpr만 사용하는 것을 권장합니다. 배열 요소의 원래 선언은 구조를 강제하지 않으며, 객체가 아니면 500이 발생할 수 있습니다. |
| content.data[].reExprs[].name | string | 저장 값: 선택적 반환 이름이며 일치 표현식으로 사용되지 않고 생략해도 정규식 일치에 영향을 주지 않습니다. |
| content.data[].reExprs[].enable | boolean | 저장 값: 명시적 불리언을 권장하며, 누락 시 비활성화로 처리됩니다. 비활성화된 정규식도 문법은 유효해야 합니다. |
| content.data[].reExprs[].reExpr | string | 저장 값: 비어 있지 않은 정규식을 권장합니다. 현재 누락 시 빈 문자열로 검사되므로 서버가 유효한 표현식을 채워 준다고 의존해서는 안 됩니다. |
| content.data[].sources | array | 저장 값: 비로그 범위 배열이며 ["*"]는 사용 가능한 모든 소스입니다. []를 생략해도 전체를 의미하지 않습니다. logging은 []를 강제로 저장합니다. rum/lineage는 권한이 부여된 워크스페이스 UUID:소스 식별자 형식으로 제한할 수 있고, tracing/metric/keyevent는 원래 소스 문자열을 사용합니다. keyevent는 비어 있지 않은 문자열 배열이어야 하며 wksp_:소스 형식을 허용하지 않고 *를 다른 값과 함께 사용할 수 없습니다. rum은 현재 regionCode가 명시된 경우에만 조회 시 애플리케이션 존재 여부를 확인하며, 다른 소스는 저장 성공이 실제 데이터 존재를 증명하지 않습니다. |
| content.data[].sources[] | string | 저장 값: 상위 type에 따라 해석되는 단일 소스이며 비어 있지 않은 문자열을 권장합니다. |
| content.data[].type | string | 저장 값: 신규 생성 시 logging/rum/tracing/metric/lineage/keyevent가 필수입니다. 선언상 null을 허용하지만 유효하지 않은 유형은 정상적인 조회 규칙을 구성할 수 없으므로 항상 위 문자열을 제출해야 합니다. 수정 시 type을 허용하지 않고 기존 유형을 따릅니다. |
| content.data[].regionCode | string | 저장 값: v2 선언상 필수인 소스 사이트 코드이며, 동일 규칙의 로그 인덱스는 같은 사이트에 속해야 하고 이 값과 일치해야 합니다. 기존 진입점은 이 필드를 허용하지 않습니다. 데이터 액세스 규칙은 교차 사이트/교차 워크스페이스 권한 부여를 대체하지 않으며, 이벤트의 교차 사이트 액세스에는 keyevent 또는 *를 포함한 유효한 권한 부여가 있어야 합니다. 아래 중복 라우트의 실제 접근 가능성 설명에 유의하십시오. |
| content.data[].indexWsInfo | string 또는 object | 로그 규칙에만 해당합니다. *는 전체를 의미하며, 그 외에는 원래 indexes 구성원을 동적 키로 사용합니다. 리소스가 없거나 정보를 가져올 수 없으면 하위 객체는 {}일 수 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자 | object | 구성된 인덱스의 워크스페이스 및 인덱스 정보입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo | object | 소스 워크스페이스 정보이며 빈 객체일 수 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.uuid | string | 소스 워크스페이스 UUID입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.name | string | 소스 워크스페이스 이름입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.status | integer | 워크스페이스 상태입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.regionCode | string | 사이트 코드입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.regionName | string 또는 null | 현지화된 사이트 이름입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.datastore | object | 선택 사항이며 각 데이터 유형에 대응하는 스토리지 클래스 매핑입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.datastore.데이터 유형 | string | 예를 들어 logging은 scopedb에 대응하며, 쓰기 가능한 구성이 아닙니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.durationSet | object | 선택 사항이며 각 데이터 유형의 보존 기간입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.durationSet.데이터 유형 | string | 정수+d 형식의 기간 문자열이며 데이터 도메인별로 구분됩니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.storagePolicy | object | 로그 소스 워크스페이스의 선택적 장기 정책 매핑입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.storagePolicy.데이터 유형 | object | 해당 데이터 도메인의 장기 정책입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.storagePolicy.데이터 유형.isEnable | boolean | 장기 정책 활성화 여부입니다. |
| content.data[].indexWsInfo.인덱스 식별자.wsInfo.storagePolicy.데이터 유형.duration | string | 장기 보존 기간입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo | object | 일반 인덱스의 전체 엔터티 또는 default의 합성 하위 집합입니다. 이전/원격 정보에는 필드가 누락될 수 있으므로 전체를 그대로 다시 전송하여 쓰기 해서는 안 됩니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.id | integer 또는 null | 데이터베이스 레코드 번호입니다. 생성 제출 전 스냅샷에서는 null일 수 있으며, 작업에는 uuid를 사용합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.uuid | string | lgim_ 인덱스 구성 UUID이며, 기본 인덱스는 default를 사용합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.sourceIndexUUID | string | 클론 인덱스 B의 원본 A UUID입니다. 일반 인덱스는 비어 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.name | string | 인덱스 이름입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.desc | string | 설명입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.conditions | string | extend를 기반으로 생성된 실제 조건 문자열입니다. 일반 요청에서는 이 필드를 직접 수정하지 마십시오. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.sortNo | integer 또는 string | 일치 순서 식별자입니다. 네이티브 직접 쓰기 또는 클론은 일반적으로 0입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.duration | string | 표준 스토리지 기간입니다. TLS의 경우 콜드/핫 아카이브 합계 일수입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.isBindCustomStore | integer 또는 boolean | 1/true이면 외부 스토리지에 바인딩됩니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.directIndex | integer 또는 boolean | 1/true이면 네이티브 직접 쓰기입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.isFullLineIndex | integer | 1은 전체 행, 0은 Message입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.queryType | string | 조회 유형입니다(예: logging/standard 또는 외부 SLS가 반환하는 모드). |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.exterStoreProject | string | 외부 프로젝트/데이터베이스 식별자이며, 내부 인덱스는 일반적으로 비어 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.exterStoreName | string | 외부 리소스 이름이며, 내부는 일반적으로 비어 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.externalResourceAccessCfgUUID | string | 액세스 구성 식별자이며 자격 증명 원문이 아닙니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.storeType | string | 내부 인덱스는 일반적으로 비어 있으며, 외부에 바인딩된 경우 실제 유형입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.region | string | 외부 리전 코드입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.isPublicNetworkAccess | integer 또는 boolean | 공용 네트워크 액세스 플래그입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.status | integer | 0 활성화, 2 비활성화, 3 삭제입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.creator | string | 생성 주체입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.updator | string | 최근 업데이트 주체입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.createAt | integer | 생성 Unix 초입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.updateAt | integer | 업데이트 Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.storagePolicy | object | 선택적 전체 장기 정책 객체입니다. 일반 생성 시 {}를 생략하며, 수정 시 생략하면 유지되고 {}는 비활성화로 정규화됩니다. 명시적으로 끄려면 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 반드시 커야 하며 단위는 여전히 일입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.storagePolicy.longStorageEnabled | boolean | 객체 내에서 생략하면 기본값은 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되지만, 기존 데이터가 즉시 삭제됨을 의미하지는 않습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.storagePolicy.longStorageDuration | string | 활성화 시 조건부 필수입니다. 필드는 d를 포함한 문자열이며 초/시간이 아닙니다. 메트릭 rp의 3600d 범위를 로그에 적용하지 마십시오. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.setting | object | TLS 생성 시 hot_retention을 반드시 제공해야 합니다. 전체 duration은 세 시간 값의 합을 일 단위로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지와 필요한 단계를 완전하게 제공하고 cold_retention만 전달하지 마십시오. 다른 스토리지는 이 필드를 TLS로 해석하지 않습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.setting.hot_retention | integer | TLS에서 조건부 필수이며 기본 범위는 1~1800일로 24..43200시간에 대응하고 24의 배수여야 합니다. 콜드 스토리지를 사용할 때 핫 스토리지는 최소 7일, 아카이브를 사용할 때는 최소 30일입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.setting.cold_retention | integer | 선택 사항이며 기본값은 30..1800일이고 정수 일에 해당하는 시간 수여야 합니다. 0을 생략 표현으로 사용하지 않으며, 합계는 1800일을 초과할 수 없습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.setting.archive_retention | integer | 선택 사항이며 기본값은 60..1800일이고 정수 일에 해당하는 시간 수여야 합니다. 핫 스토리지는 최소 30일이며, 합계는 1800일을 초과할 수 없습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend | object | 선택적 확장 객체로 실제 일치 및 표시 구성을 포함합니다. 일반 modify는 최상위 키 기준으로 병합하며 제공되지 않은 키는 유지되고, 배열 또는 중첩 객체는 전체 교체됩니다. {}는 기존 filters를 지우지 않습니다. null은 피하십시오. 일부 수정 분기에서는 500이 발생합니다. 가져오기 recover는 extend를 전체 교체합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.matchMode | string | 생략/빈 값은 basic으로 처리됩니다. advanced는 advancedFilter를 사용하고 basic은 filters를 사용하며, 모드를 전환할 때 해당 전체 조건을 함께 제공해야 합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters | array | basic의 리프 배열이며 비어 있지 않은 조건은 conditions를 생성합니다. 생성/수정 basic에서는 operation이 match 또는 not match인 경우를 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하십시오. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].name | string | 실제 필드 이름이며 백틱을 추가하지 않습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].condition | string | 이전 조건과의 and/or 관계이며 첫 항목의 연결자는 무시됩니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].operation | string | 주로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. basic에서는 match/not match를 금지합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].value | array | 조건 값 배열입니다. = 및 비교 연산은 첫 항목을 사용합니다. 존재 연산의 경우에도 비어 있지 않은 자리 표시자 배열을 권장합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters[] | json | 조건 객체이며 필드 이름/연산/값이 완전해야 합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.filters[].value[] | JSON | 단일 비교 값이며 표시 이름으로 실제 값을 대체하지 마십시오. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter | json | advanced일 때 필수인 루트 group 객체입니다. 그룹은 type=group, condition, filters를 사용하고 리프는 type=rule, name, operation, value를 사용합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.type | string | 루트 노드 유형이며 rule일 수 없습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.condition | string | 같은 그룹 내 하위 조건의 논리 관계입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters | array | 하위 노드 배열이며 동일한 group 구조의 중첩을 허용합니다. 빈 그룹은 빈 조건을 생성합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[] | json | rule 리프 또는 group 객체입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].type | string | rule은 리프, group은 재귀 그룹입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].name | string | rule에 필수인 비어 있지 않은 필드 이름입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].operation | string | rule에서는 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].value | array | rule에 필수인 배열입니다. exist/not_exist는 []를 사용할 수 있지만 나머지는 빈 배열을 허용하지 않습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].condition | string | group 하위 그룹은 and/or를 사용합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].filters | array | group 하위 그룹의 재귀 배열이며 규칙 리프에서는 생략합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.advancedFilter.filters[].value[] | JSON | 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields | array | 선택적 주요 필드 배열입니다. tag/alias 구조로 제출해야 하며 tag는 비어 있지 않아야 합니다. 생성 시에는 이 구조 검증이 강제되지 않지만 수정 시에는 검증됩니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스도 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields[] | json | tag/alias 키만 허용합니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields[].tag | string | 조건부 필수인 비어 있지 않은 키입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.extendFields[].alias | string | 선택적 표시 별칭입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.topFields | array | 선택적 표시 구성이며 동일한 tag/alias 객체를 사용합니다. 일반 modify는 독립적인 상단 고정 인터페이스가 아닙니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.topFields[] | json | 단일 표시 필드 객체입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.topFields[].tag | string | 필드 키입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.topFields[].alias | string | 선택적 별칭입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.services | array | 선택적 반환 정보이며 filters의 실제 일치 조건을 대체하지 않습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.extend.services[] | string | 단일 서비스 표시 값입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.workspaceName | string | 소스 워크스페이스 이름이며 생략할 수 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.workspaceStatus | integer | 소스 워크스페이스 상태이며 생략할 수 있습니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.regionCode | string | 소스 사이트 코드입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.regionName | string 또는 null | 소스 사이트 이름입니다. |
| content.data[].indexWsInfo.인덱스 식별자.indexInfo.grantStatus | integer | 선택 사항이며 3은 현재 권한 부여를 사용할 수 없음을 의미합니다. 값이 없다고 해서 다른 액세스 조건이 충족됨을 보장하지는 않습니다. |
| content.data[].sourcesWsInfo | string 또는 object | 비로그 규칙에만 해당합니다. *는 전체를 의미하며, 그 외에는 sources의 원래 구성원을 키로 사용합니다. 다른 유형은 소스 이름만 표시하며 리소스 존재를 보장하지 않습니다. |
| content.data[].sourcesWsInfo.소스 식별자 | object | 하나의 소스 요약입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo | object | RUM은 소스 워크스페이스 정보를 가질 수 있으며, 다른 유형은 일반적으로 {}입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.uuid | string | 소스 워크스페이스 UUID입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.name | string | 소스 워크스페이스 이름입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.status | integer | 워크스페이스 상태입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.regionCode | string | 사이트 코드입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.regionName | string 또는 null | 현지화된 사이트 이름입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.datastore | object | 선택 사항이며 각 데이터 유형에 대응하는 스토리지 클래스 매핑입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.datastore.데이터 유형 | string | 예를 들어 logging은 scopedb에 대응하며, 쓰기 가능한 구성이 아닙니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.durationSet | object | 선택 사항이며 각 데이터 유형의 보존 기간입니다. |
| content.data[].sourcesWsInfo.소스 식별자.wsInfo.durationSet.데이터 유형 | string | 정수+d 형식의 기간 문자열이며 데이터 도메인별로 구분됩니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo | object | RUM 애플리케이션 엔터티 또는 다른 유형의 {name,status}이며, 정보가 없으면 {}일 수 있습니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.name | string | 비RUM 소스의 원래 이름입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.id | integer | 애플리케이션 레코드 번호입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.uuid | string | appId와 동일합니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.appId | string | RUM 소스 식별자입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.workspaceUUID | string | 애플리케이션이 속한 워크스페이스입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.clientToken | string | 애플리케이션 수집 식별자이며 생략할 수 있습니다. 이 인터페이스의 API Key가 아니며 예시에는 실제 값을 출력하지 않습니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.jsonContent | object | 애플리케이션 구성이며 유형마다 구조가 다릅니다. 해당 유형은 RUM 애플리케이션 상세 설명으로 해석하십시오. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.jsonContent.구성 키 | JSON | 해당 애플리케이션 유형에 저장된 구성입니다(예: name/type 등). 여기서는 표시용일 뿐 액세스 규칙 파라미터가 아닙니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.status | integer | 애플리케이션 상태이며 과거 데이터로 유효하지 않을 수 있습니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.creator | string | 생성 주체입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.updator | string | 업데이트 주체입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.createAt | integer | 생성 Unix 초입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.updateAt | integer | 업데이트 Unix 초입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.deleteAt | integer | 삭제 Unix 초입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.workspaceName | string | 워크스페이스 이름입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.workspaceStatus | integer | 워크스페이스 상태입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.regionCode | string | 소스 사이트 코드입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.regionName | string 또는 null | 소스 사이트 이름입니다. |
| content.data[].sourcesWsInfo.소스 식별자.sourcesInfo.grantStatus | integer | 선택 사항이며 3은 현재 권한 부여가 유효하지 않음을 의미합니다. |
| content.data[].creatorInfo | object | ID 요약이며 해석 가능한 정보가 없으면 {}입니다. |
| content.data[].creatorInfo.uuid | string | ID UUID이며 생략할 수 있습니다. |
| content.data[].creatorInfo.status | integer | 계정 상태이며 생략할 수 있습니다. |
| content.data[].creatorInfo.wsAccountStatus | integer | 구성원 관계 상태이며 생략할 수 있습니다. |
| content.data[].creatorInfo.name | string | 표시 이름입니다. |
| content.data[].creatorInfo.username | string | 로그인 이름입니다. |
| content.data[].creatorInfo.email | string | 이메일 또는 시스템 ID 식별자입니다. |
| content.data[].creatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.countryCode | string | 국가/지역 코드이며 생략할 수 있습니다. |
| content.data[].creatorInfo.iconUrl | string | 아바타 주소이며 생략할 수 있습니다. |
| content.data[].creatorInfo.acntWsNickname | string | 이 워크스페이스의 닉네임이며 생략할 수 있습니다. |
| content.data[].updatorInfo | object | ID 요약이며 해석 가능한 정보가 없으면 {}입니다. |
| content.data[].updatorInfo.uuid | string | ID UUID이며 생략할 수 있습니다. |
| content.data[].updatorInfo.status | integer | 계정 상태이며 생략할 수 있습니다. |
| content.data[].updatorInfo.wsAccountStatus | integer | 구성원 관계 상태이며 생략할 수 있습니다. |
| content.data[].updatorInfo.name | string | 표시 이름입니다. |
| content.data[].updatorInfo.username | string | 로그인 이름입니다. |
| content.data[].updatorInfo.email | string | 이메일 또는 시스템 ID 식별자입니다. |
| content.data[].updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.countryCode | string | 국가/지역 코드이며 생략할 수 있습니다. |
| content.data[].updatorInfo.iconUrl | string | 아바타 주소이며 생략할 수 있습니다. |
| content.data[].updatorInfo.acntWsNickname | string | 이 워크스페이스의 닉네임이며 생략할 수 있습니다. |
| content.data[].relRoleInfos | array<object> |
조회 시 일치한 역할 요약입니다. *는 유효한 비Owner 역할로 확장되며, 지정한 역할은 과거 status 또는 {}를 반환할 수 있습니다. |
| content.data[].relRoleInfos[] | object | 단일 역할 요약이며 찾을 수 없으면 {}일 수 있습니다. |
| content.data[].relRoleInfos[].uuid | string | 역할 UUID이며 생략할 수 있습니다. |
| content.data[].relRoleInfos[].name | string | 역할 이름이며 생략할 수 있습니다. |
| content.data[].relRoleInfos[].status | integer | 역할 상태이며 생략할 수 있습니다. |
| content.data[].memberCount | integer | 현재 역할 관계를 기준으로 추정한 구성원 수이며 실제 제한 쿼리 수가 아닙니다. 와일드카드 분기는 관계 수에서 1을 뺀 값으로, relMemberInfos 길이와 같지 않을 수 있습니다. |
| content.data[].relMemberInfos | array<object> |
ID를 해석할 수 있는 일치 구성원입니다. * 분기에서는 Owner를 제외합니다. |
| content.data[].relMemberInfos[] | object | ID를 해석할 수 있는 단일 구성원 ID입니다. |
| content.data[].relMemberInfos[].uuid | string | ID UUID이며 생략할 수 있습니다. |
| content.data[].relMemberInfos[].status | integer | 계정 상태이며 생략할 수 있습니다. |
| content.data[].relMemberInfos[].wsAccountStatus | integer | 구성원 관계 상태이며 생략할 수 있습니다. |
| content.data[].relMemberInfos[].name | string | 표시 이름입니다. |
| content.data[].relMemberInfos[].username | string | 로그인 이름입니다. |
| content.data[].relMemberInfos[].email | string | 이메일 또는 시스템 ID 식별자입니다. |
| content.data[].relMemberInfos[].mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].relMemberInfos[].countryCode | string | 국가/지역 코드이며 생략할 수 있습니다. |
| content.data[].relMemberInfos[].iconUrl | string | 아바타 주소이며 생략할 수 있습니다. |
| content.data[].relMemberInfos[].acntWsNickname | string | 이 워크스페이스의 닉네임이며 생략할 수 있습니다. |
| content.data[].excludeOwnerRoleUUIDs | array<string> |
roleUUIDs에 *가 포함된 경우에만 제공되는 유효한 비Owner 역할 UUID입니다. |
| content.data[].excludeOwnerRoleUUIDs[] | string | 단일 역할 UUID입니다. |
| content.declaration | object | 공통 선언입니다. |
| pageInfo.pageIndex | integer | 현재 페이지 번호입니다. |
| pageInfo.pageSize | integer | 페이지 크기입니다. |
| pageInfo.count | integer | 이 페이지의 수량입니다. |
| pageInfo.totalCount | integer | 비어 있지 않은 페이지에서는 일치하는 규칙의 총수입니다. 현재 빈 페이지가 조기 반환되면 이 값은 0이며, 범위를 벗어난 페이지의 0으로 전체 규칙이 없다고 증명할 수 없습니다. |
{
"code": 200,
"content": {
"data": [
{
"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": {}
}
},
"creatorInfo": {},
"updatorInfo": {},
"memberCount": 1,
"relRoleInfos": [
{
"uuid": "role_example",
"name": "生产查询",
"status": 0
}
],
"relMemberInfos": []
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 50,
"count": 1,
"totalCount": 1
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반한 경우 | 파라미터 파싱 실패 | Query 파라미터 표와 예시를 확인하십시오. |
| 404 | ft.NoInitOtherNodeCfg | 원격 인덱스/RUM 애플리케이션 메타데이터를 읽거나 검증할 때 사용 가능한 소스 사이트 주소를 찾지 못한 경우 | 다른 노드 구성이 초기화되지 않음 | 관리자가 소스 사이트 구성, 접근 가능한 주소 및 유효한 교차 워크스페이스 권한 부여를 확인한 후 수정하고 재시도하십시오. |
| 500 | ft.InternalServerError | 규칙, 역할, 소스 워크스페이스 또는 인덱스/애플리케이션 메타데이터 읽기 및 형식 지정 실패 | 내부 오류 | 권한이 부여된 소스 및 사이트 정보를 새로 고친 후 잠시 후 재시도하십시오. 계속 실패하면 traceId를 제공하십시오. |