콘텐츠로 이동

가져오기



POST /api/v1/log_index_cfg/import

개요

내부 로그 인덱스 템플릿을 일괄 가져오며, 이름 기준으로 확인, 건너뛰기 또는 덮어쓰기를 수행합니다.

호출 전 준비 및 사용 단계

먼저 대상 구성을 내보내고 백업하며, 비어 있지 않은 logIndexes 배열을 사용합니다. check는 기본적으로 동일한 이름의 인덱스가 있으면 성공 응답으로 content.repeat_name을 반환하고 전체 배치를 가져오지 않습니다. skip은 이미 존재하는 항목을 건너뜁니다. recover는 동일한 이름의 원본 A를 덮어씁니다. 입력에서 동일한 이름의 템플릿(trim 후)은 즉시 오류가 발생합니다. 기본 default 템플릿은 건너뜁니다. 내부 일반 또는 직접 쓰기 템플릿만 지원하며 외부 바인딩은 가져오지 않습니다.

recover는 기존 directIndex 모드를 변경하지 않습니다. desc/extend를 생략하면 desc는 비우고 extend는 전체 교체합니다. duration/storagePolicy/isFullLineIndex/fields를 제공하지 않으면 원래 값을 유지합니다. is_disable을 생략하면 false이며, 이미 비활성화된 A는 활성화됩니다. cloneConfig가 포함되면 연관 B를 새로 만들거나 업데이트합니다. 기존 B가 있으면 해당 UUID/이름을 유지하고 편집 가능한 구성만 덮어씁니다. null/생략은 B를 삭제하지 않습니다. 이미 B로 사용 중인 이름을 직접 가져오면 실패로 보고되며, 반드시 A와 함께 가져와야 합니다. 직접 쓰기/바인딩/기본은 복제 원본으로 사용할 수 없고 B 조건은 비어 있을 수 없습니다. scopedb 템플릿을 새로 만들려면 전체 행이 필요하며, 공개 가져오기는 내부 마이그레이션의 자동 0→1 변환을 수행하지 않습니다.

각 항목은 독립적으로 제출되며, 일부 실패해도 성공한 항목은 롤백되지 않습니다. content.successCount/failCount는 데이터베이스 제출 횟수이며, failedNames는 실패한 이름만 제공하고 항목별 사유는 반환하지 않습니다. 제출 후 다운스트림 정책/필드 동기화 예외가 발생해도 성공으로 집계될 수 있으므로 실제 저장 상태를 확인해야 합니다. 현재 공개 결과에는 skip 수가 별도로 반환되지 않으므로, 전체 입력 수에서 failCount를 빼서 성공 수를 추론하지 마십시오.

필드 매핑을 명시적으로 []로 지정하면 비워지며 생략과 같지 않습니다. extendFields 변경은 대상 필드 가속 스위치에 따라 동기화됩니다. 보존 기간을 줄이거나, 필터를 변경하거나, 전체 행으로 업그레이드하기 전에 영향을 확인하고, 실패 항목은 traceId와 서비스 로그를 결합하여 위치를 파악하며, 전체 배치를 무작정 재시도하지 마십시오.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 유형 필수 설명
logIndexes[*].storagePolicy.longStorageEnabled boolean 객체 내에서 생략하면 기본값은 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되며, 기존 기록 데이터가 즉시 삭제되는 것은 아닙니다.
예: false
가져오기 또는 입력 방법: true는 장기 스토리지 활성화, false는 비활성화이며 JSON 불리언을 명시하는 것을 권장합니다.
logIndexes[*].storagePolicy.longStorageDuration string 활성화 시 조건부 필수입니다. 필드는 d를 포함한 문자열이며, 초/시간 단위가 아니고 메트릭 rp의 3600d 범위를 로그에 적용하지 않습니다.
예: 180d
가져오기 또는 입력 방법: pay는 기본적으로 90d/120d/180d/360d를 선택하며, enterprise/unlimited는 기본 1d부터 1800d까지이고 duration보다 엄격히 커야 합니다.
logIndexes[*].setting.hot_retention integer TLS 조건부 필수이며, 기본 범위는 1~1800일로 24..43200시간에 해당하고 24의 배수여야 합니다. 콜드 스토리지를 사용할 때 핫 스토리지는 최소 7일, 아카이브를 사용할 때는 최소 30일입니다.
예: 168
가져오기 또는 입력 방법: 일수×24로 입력합니다. 예: 7일=168시간.
logIndexes[*].setting.cold_retention integer 선택 사항이며 기본 30..1800일이고 정수 일수에 해당하는 시간 수입니다. 0으로 생략을 나타내지 않으며, 합계는 1800일을 초과할 수 없습니다.
예: 720
가져오기 또는 입력 방법: 저빈도 스토리지 일수×24입니다. 예: 30일=720시간이며, 해당 단계를 활성화하지 않으면 생략합니다.
logIndexes[*].setting.archive_retention integer 선택 사항이며 기본 60..1800일이고 정수 일수에 해당하는 시간 수입니다. 핫 스토리지는 최소 30일이며, 합계는 1800일을 초과할 수 없습니다.
예: 1440
가져오기 또는 입력 방법: 아카이브 일수×24입니다. 예: 60일=1440시간이며, 해당 단계를 활성화하지 않으면 생략합니다.
logIndexes[*].extend.matchMode string 생략/빈 값은 basic으로 처리합니다. advanced는 advancedFilter를 사용하고, basic은 filters를 사용하며, 모드를 전환할 때 해당 전체 조건을 함께 제공합니다.
예: basic
가져오기 또는 입력 방법: 일반 매칭은 basic, 고급 매칭은 advanced입니다.
logIndexes[*].extend.filters array basic의 리프 배열이며, 비어 있지 않은 조건은 conditions를 생성합니다. basic 생성/수정 시 operation이 match 또는 not match인 경우 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하십시오.
예: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]
가져오기 또는 입력 방법: 실제 로그 필드 조건이며, 일반 매칭을 비워야 할 때는 filters=[]를 명시적으로 전달합니다.
logIndexes[*].extend.filters[*].name string 실제 필드 이름이며 백틱을 추가하지 않습니다.
예: env
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].extend.filters[*].condition string 이전 조건과의 and/or 관계이며, 첫 항목의 연결자는 무시됩니다.
예: and
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].extend.filters[*].operation string 주로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용하며, basic에서는 match/not match를 금지합니다.
예: =
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].extend.filters[*].value array 조건 값 배열이며, = 및 비교는 첫 번째 항목을 사용합니다. 존재 유형은 여전히 비어 있지 않은 자리 표시자 배열을 권장합니다.
예: ["production"]
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].extend.filters[*] json 조건 객체이며, 필드 이름/연산/값이 완전해야 합니다.
예: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}
가져오기 또는 입력 방법: 각 항목은 하나의 기본 조건을 나타냅니다.
logIndexes[*].extend.filters[*].value[*] JSON 단일 비교 값이며, 표시 이름으로 실제 값을 대체하지 않습니다.
예: production
가져오기 또는 입력 방법: 로그 원본 필드 값을 사용하며 문자열/숫자 유형을 유지합니다.
logIndexes[*].extend.advancedFilter json advanced일 때 필수인 루트 group 객체입니다. 그룹은 type=group, condition, filters를 사용하고, 리프는 type=rule, name, operation, value를 사용합니다.
예: {"type": "group", "condition": "and", "filters": [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]}
가져오기 또는 입력 방법: 고급 모드는 다음의 재귀 group/rule 구조로 구성하며, basic의 평면 형식을 복사하지 않도록 하십시오.
logIndexes[*].extend.advancedFilter.type string 루트 노드 유형이며 rule일 수 없습니다.
예: group
가져오기 또는 입력 방법: 루트 노드는 group으로 고정됩니다.
logIndexes[*].extend.advancedFilter.condition string 같은 그룹 내 하위 조건의 논리 관계입니다.
예: and
가져오기 또는 입력 방법: and/or이며 기본값은 and입니다.
logIndexes[*].extend.advancedFilter.filters array 하위 노드 배열이며 동일한 group 구조의 중첩을 허용합니다. 빈 그룹은 빈 조건을 생성합니다.
예: [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]
가져오기 또는 입력 방법: 리프 rule 또는 재귀 group 하위 노드를 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*] json rule 리프 또는 group 객체입니다.
예: {"type": "rule", "name": "env", "operation": "=", "value": ["production"]}
가져오기 또는 입력 방법: 리프는 실제 로그 필드로 채우고, 그룹은 동일한 구조로 계속 재귀합니다.
logIndexes[*].extend.advancedFilter.filters[*].type string rule은 리프, group은 재귀 그룹입니다.
예: rule
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*].name string rule 필수 비어 있지 않은 필드 이름입니다.
예: env
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*].operation string rule은 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다.
예: =
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*].value array rule 필수 배열이며, exist/not_exist는 []를 사용할 수 있고 그 외는 빈 배열을 허용하지 않습니다.
예: ["production"]
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*].condition string group 하위 그룹은 and/or를 사용합니다.
예: and
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*].filters array group 하위 그룹 재귀 배열이며, 규칙 리프에서는 생략합니다.
예: []
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].extend.advancedFilter.filters[*].value[*] JSON 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다.
예: production
가져오기 또는 입력 방법: 로그 원본 값을 사용합니다.
logIndexes[*].extend.extendFields array 선택적 주요 필드 배열이며, tag/alias 구조로 제출하고 tag는 비어 있지 않아야 합니다. 생성 시에는 이 구조 검증이 강제되지 않지만 수정 시에는 검증합니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스도 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다.
예: [{"tag": "service", "alias": "服务"}]
가져오기 또는 입력 방법: 실제 로그 필드에서 주요 표시 필드를 선택합니다.
logIndexes[*].extend.extendFields[*] json tag/alias 키만 허용합니다.
예: {"tag": "service", "alias": "服务"}
가져오기 또는 입력 방법: 필드 키 및 표시 별칭에 따라 채웁니다.
logIndexes[*].extend.extendFields[*].tag string 조건부 필수 비어 있지 않은 키입니다.
예: service
가져오기 또는 입력 방법: 실제 로그 필드 이름입니다.
logIndexes[*].extend.extendFields[*].alias string 선택적 표시 별칭입니다.
예: 服务
가져오기 또는 입력 방법: 비즈니스 표시 이름이며 생략할 수 있습니다.
logIndexes[*].extend.topFields array 선택적 표시 구성이며 동일한 tag/alias 객체로 사용합니다. 일반 modify는 독립적인 상단 고정 인터페이스가 아닙니다.
예: [{"tag": "host", "alias": "主机"}]
가져오기 또는 입력 방법: 콘솔의 상단 고정 필드 목록을 유지합니다.
logIndexes[*].extend.topFields[*] json 단일 표시 필드 객체입니다.
예: {"tag": "host", "alias": "主机"}
가져오기 또는 입력 방법: 기존 목록에 따라 다시 채웁니다.
logIndexes[*].extend.topFields[*].tag string 필드 키입니다.
예: host
가져오기 또는 입력 방법: 실제 필드 이름입니다.
logIndexes[*].extend.topFields[*].alias string 선택적 별칭입니다.
예: 主机
가져오기 또는 입력 방법: 표시 별칭입니다.
logIndexes[*].extend.services array 선택적 에코 정보이며 filters의 실제 매칭 조건을 대체하지 않습니다.
예: ["checkout-api"]
가져오기 또는 입력 방법: 콘솔의 관련 서비스 표시 구성을 유지합니다.
logIndexes[*].extend.services[*] string 단일 서비스 표시 값입니다.
예: checkout-api
가져오기 또는 입력 방법: 실제 서비스 이름입니다.
logIndexes[*].fields[*] json 단일 field/originalField 매핑입니다.
예: {"field": "message", "originalField": "content"}
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].fields[*].field string 플랫폼 필드 이름입니다.
예: message
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].fields[*].originalField string 실제 원본 필드입니다.
예: content
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].cloneConfig.name string 복제 생성 시 필수 비어 있지 않은 이름이며 A 이름과 같을 수 없습니다. recover에서 기존 B가 있으면 대상의 원래 UUID와 이름을 사용하며, 가져오기 이름으로 이름을 바꾸지 않습니다.
예: production_logs
가져오기 또는 입력 방법: 비즈니스에 맞게 이름을 지정하고, 먼저 로그 인덱스 목록에서 현재 워크스페이스의 사용 중인 이름을 확인합니다.
logIndexes[*].cloneConfig.desc string 선택적 설명이며 최대 1024자입니다. 일반 modify에서 생략하면 유지되고 빈 문자열이면 비웁니다. 외부 바인딩 수정에서 생략하면 비웁니다.
예: 生产服务日志。
가져오기 또는 입력 방법: 용도, 출처 및 유지 관리 책임 설명을 작성합니다.
logIndexes[*].cloneConfig.duration string 일반 생성 시 기본값은 보통 3d입니다. 비TLS 스토리지에서 pay는 기본적으로 3d/7d/14d/30d/60d/90d를 허용하고, enterprise/unlimited는 기본 1d부터 1800d까지이며, 구체적인 값은 사이트 구성에 따릅니다. modify에서 생략하면 유지되며, TLS는 setting을 기준으로 하며 이 필드로 실제 기간을 제어하지 않습니다.
예: 7d
가져오기 또는 입력 방법: 현재 워크스페이스 버전과 로그 스토리지에 따라 표준 보존 일수를 선택하고 정수+d를 사용합니다.
logIndexes[*].cloneConfig.storagePolicy json 선택적 전체 장기 정책 객체입니다. 일반 생성에서 생략하면 {}이고, 수정에서 생략하면 유지되며, {}는 비활성화로 정규화되고 명시적 비활성화는 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 엄격히 커야 하며 단위는 여전히 일입니다.
예: {"longStorageEnabled": false}
가져오기 또는 입력 방법: 로그 스토리지가 scopedb이고 버전이 pay/enterprise/unlimited일 때만 장기 스토리지를 활성화할 수 있습니다. 먼저 워크스페이스 기능을 확인하십시오.
logIndexes[*].cloneConfig.storagePolicy.longStorageEnabled boolean 객체 내에서 생략하면 기본값은 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되며, 기존 기록 데이터가 즉시 삭제되는 것은 아닙니다.
예: false
가져오기 또는 입력 방법: true는 장기 스토리지 활성화, false는 비활성화이며 JSON 불리언을 명시하는 것을 권장합니다.
logIndexes[*].cloneConfig.storagePolicy.longStorageDuration string 활성화 시 조건부 필수입니다. 필드는 d를 포함한 문자열이며, 초/시간 단위가 아니고 메트릭 rp의 3600d 범위를 로그에 적용하지 않습니다.
예: 180d
가져오기 또는 입력 방법: pay는 기본적으로 90d/120d/180d/360d를 선택하며, enterprise/unlimited는 기본 1d부터 1800d까지이고 duration보다 엄격히 커야 합니다.
logIndexes[*].cloneConfig.isFullLineIndex int 0/1 또는 불리언만 허용합니다. scopedb 생성 시 기본값은 1이며 0은 허용하지 않습니다. 기존 Message는 0→1이 가능하지만 1→0은 불가능하며, 전환 시 message 필드 인덱스가 동기화되고 되돌릴 수 없습니다. modify에서 생략하면 유지됩니다.
예: 1
가져오기 또는 입력 방법: scopedb 로그 생성 시 반드시 1/true여야 하며, 다른 로그 스토리지는 0/false를 유지합니다.
logIndexes[*].cloneConfig.setting json TLS 생성 시 hot_retention을 반드시 제공해야 합니다. 총 duration은 세 시간 수의 합을 일 단위로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지 및 필요한 단계를 완전히 제공하고 cold_retention만 전달하지 마십시오. 다른 스토리지는 이 필드를 TLS로 해석하지 않습니다.
예: {"hot_retention": 168}
가져오기 또는 입력 방법: 워크스페이스 로그 스토리지가 volctls일 때만 표준/저빈도/아카이브 보존을 구성하며, 값 단위는 시간입니다.
logIndexes[*].cloneConfig.setting.hot_retention integer TLS 조건부 필수이며, 기본 범위는 1~1800일로 24..43200시간에 해당하고 24의 배수여야 합니다. 콜드 스토리지를 사용할 때 핫 스토리지는 최소 7일, 아카이브를 사용할 때는 최소 30일입니다.
예: 168
가져오기 또는 입력 방법: 일수×24로 입력합니다. 예: 7일=168시간.
logIndexes[*].cloneConfig.setting.cold_retention integer 선택 사항이며 기본 30..1800일이고 정수 일수에 해당하는 시간 수입니다. 0으로 생략을 나타내지 않으며, 합계는 1800일을 초과할 수 없습니다.
예: 720
가져오기 또는 입력 방법: 저빈도 스토리지 일수×24입니다. 예: 30일=720시간이며, 해당 단계를 활성화하지 않으면 생략합니다.
logIndexes[*].cloneConfig.setting.archive_retention integer 선택 사항이며 기본 60..1800일이고 정수 일수에 해당하는 시간 수입니다. 핫 스토리지는 최소 30일이며, 합계는 1800일을 초과할 수 없습니다.
예: 1440
가져오기 또는 입력 방법: 아카이브 일수×24입니다. 예: 60일=1440시간이며, 해당 단계를 활성화하지 않으면 생략합니다.
logIndexes[*].cloneConfig.extend json 복제 시 비어 있지 않은 매칭 조건을 생성할 수 있는 extend를 반드시 제공해야 하며, A 조건과 결합한 후 매칭합니다. 빈 그룹은 사용할 수 없습니다. recover는 전체를 교체합니다.
예: {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}
가져오기 또는 입력 방법: 매칭 조건은 실제 로그 필드와 값으로 구성하고, 기타 표시 구성은 원본 상세에서 유지합니다.
logIndexes[*].cloneConfig.extend.matchMode string 생략/빈 값은 basic으로 처리합니다. advanced는 advancedFilter를 사용하고, basic은 filters를 사용하며, 모드를 전환할 때 해당 전체 조건을 함께 제공합니다.
예: basic
가져오기 또는 입력 방법: 일반 매칭은 basic, 고급 매칭은 advanced입니다.
logIndexes[*].cloneConfig.extend.filters array basic의 리프 배열이며, 비어 있지 않은 조건은 conditions를 생성합니다. basic 생성/수정 시 operation이 match 또는 not match인 경우 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하십시오.
예: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]
가져오기 또는 입력 방법: 실제 로그 필드 조건이며, 일반 매칭을 비워야 할 때는 filters=[]를 명시적으로 전달합니다.
logIndexes[*].cloneConfig.extend.filters[*].name string 실제 필드 이름이며 백틱을 추가하지 않습니다.
예: env
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.filters[*].condition string 이전 조건과의 and/or 관계이며, 첫 항목의 연결자는 무시됩니다.
예: and
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.filters[*].operation string 주로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용하며, basic에서는 match/not match를 금지합니다.
예: =
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.filters[*].value array 조건 값 배열이며, = 및 비교는 첫 번째 항목을 사용합니다. 존재 유형은 여전히 비어 있지 않은 자리 표시자 배열을 권장합니다.
예: ["production"]
가져오기 또는 입력 방법: 실제 로그 필드, 값 및 매칭 관계에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.filters[*] json 조건 객체이며, 필드 이름/연산/값이 완전해야 합니다.
예: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}
가져오기 또는 입력 방법: 각 항목은 하나의 기본 조건을 나타냅니다.
logIndexes[*].cloneConfig.extend.filters[*].value[*] JSON 단일 비교 값이며, 표시 이름으로 실제 값을 대체하지 않습니다.
예: production
가져오기 또는 입력 방법: 로그 원본 필드 값을 사용하며 문자열/숫자 유형을 유지합니다.
logIndexes[*].cloneConfig.extend.advancedFilter json advanced일 때 필수인 루트 group 객체입니다. 그룹은 type=group, condition, filters를 사용하고, 리프는 type=rule, name, operation, value를 사용합니다.
예: {"type": "group", "condition": "and", "filters": [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]}
가져오기 또는 입력 방법: 고급 모드는 다음의 재귀 group/rule 구조로 구성하며, basic의 평면 형식을 복사하지 않도록 하십시오.
logIndexes[*].cloneConfig.extend.advancedFilter.type string 루트 노드 유형이며 rule일 수 없습니다.
예: group
가져오기 또는 입력 방법: 루트 노드는 group으로 고정됩니다.
logIndexes[*].cloneConfig.extend.advancedFilter.condition string 같은 그룹 내 하위 조건의 논리 관계입니다.
예: and
가져오기 또는 입력 방법: and/or이며 기본값은 and입니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters array 하위 노드 배열이며 동일한 group 구조의 중첩을 허용합니다. 빈 그룹은 빈 조건을 생성합니다.
예: [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]
가져오기 또는 입력 방법: 리프 rule 또는 재귀 group 하위 노드를 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*] json rule 리프 또는 group 객체입니다.
예: {"type": "rule", "name": "env", "operation": "=", "value": ["production"]}
가져오기 또는 입력 방법: 리프는 실제 로그 필드로 채우고, 그룹은 동일한 구조로 계속 재귀합니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].type string rule은 리프, group은 재귀 그룹입니다.
예: rule
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].name string rule 필수 비어 있지 않은 필드 이름입니다.
예: env
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].operation string rule은 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다.
예: =
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].value array rule 필수 배열이며, exist/not_exist는 []를 사용할 수 있고 그 외는 빈 배열을 허용하지 않습니다.
예: ["production"]
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].condition string group 하위 그룹은 and/or를 사용합니다.
예: and
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].filters array group 하위 그룹 재귀 배열이며, 규칙 리프에서는 생략합니다.
예: []
가져오기 또는 입력 방법: 해당 group/rule 노드 구조에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.advancedFilter.filters[*].value[*] JSON 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다.
예: production
가져오기 또는 입력 방법: 로그 원본 값을 사용합니다.
logIndexes[*].cloneConfig.extend.extendFields array 선택적 주요 필드 배열이며, tag/alias 구조로 제출하고 tag는 비어 있지 않아야 합니다. 생성 시에는 이 구조 검증이 강제되지 않지만 수정 시에는 검증합니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스도 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다.
예: [{"tag": "service", "alias": "服务"}]
가져오기 또는 입력 방법: 실제 로그 필드에서 주요 표시 필드를 선택합니다.
logIndexes[*].cloneConfig.extend.extendFields[*] json tag/alias 키만 허용합니다.
예: {"tag": "service", "alias": "服务"}
가져오기 또는 입력 방법: 필드 키 및 표시 별칭에 따라 채웁니다.
logIndexes[*].cloneConfig.extend.extendFields[*].tag string 조건부 필수 비어 있지 않은 키입니다.
예: service
가져오기 또는 입력 방법: 실제 로그 필드 이름입니다.
logIndexes[*].cloneConfig.extend.extendFields[*].alias string 선택적 표시 별칭입니다.
예: 服务
가져오기 또는 입력 방법: 비즈니스 표시 이름이며 생략할 수 있습니다.
logIndexes[*].cloneConfig.extend.topFields array 선택적 표시 구성이며 동일한 tag/alias 객체로 사용합니다. 일반 modify는 독립적인 상단 고정 인터페이스가 아닙니다.
예: [{"tag": "host", "alias": "主机"}]
가져오기 또는 입력 방법: 콘솔의 상단 고정 필드 목록을 유지합니다.
logIndexes[*].cloneConfig.extend.topFields[*] json 단일 표시 필드 객체입니다.
예: {"tag": "host", "alias": "主机"}
가져오기 또는 입력 방법: 기존 목록에 따라 다시 채웁니다.
logIndexes[*].cloneConfig.extend.topFields[*].tag string 필드 키입니다.
예: host
가져오기 또는 입력 방법: 실제 필드 이름입니다.
logIndexes[*].cloneConfig.extend.topFields[*].alias string 선택적 별칭입니다.
예: 主机
가져오기 또는 입력 방법: 표시 별칭입니다.
logIndexes[*].cloneConfig.extend.services array 선택적 에코 정보이며 filters의 실제 매칭 조건을 대체하지 않습니다.
예: ["checkout-api"]
가져오기 또는 입력 방법: 콘솔의 관련 서비스 표시 구성을 유지합니다.
logIndexes[*].cloneConfig.extend.services[*] string 단일 서비스 표시 값입니다.
예: checkout-api
가져오기 또는 입력 방법: 실제 서비스 이름입니다.
logIndexes[*].cloneConfig.conditions string 내보내기 호환 조건 문자열입니다. 가져오기 생성/덮어쓰기는 실제로 extend로 다시 생성하며, 이 필드로 범위를 직접 결정하지 않습니다.
예: { `env` = 'production' }
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].cloneConfig.fields array 필드 매핑입니다. 생략하면 기존 매핑을 유지하고, 명시적 []는 빈 값으로 덮어쓰며, 외부 modify의 빈 배열 동작과 다릅니다.
예: [{"field": "message", "originalField": "content"}]
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].cloneConfig.fields[*] json 단일 field/originalField 매핑입니다.
예: {"field": "message", "originalField": "content"}
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].cloneConfig.fields[*].field string 플랫폼 필드 이름입니다.
예: message
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].cloneConfig.fields[*].originalField string 실제 원본 필드입니다.
예: content
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].cloneConfig.is_disable boolean 내보내기/가져오기 상태 키는 정확히 is_disable입니다. 기본값은 false이며, recover에서 원본이 비활성화되어 있고 true를 전달하지 않으면 활성화됩니다.
예: false
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes array Y 필수 비어 있지 않은 템플릿 배열입니다. 기본 인덱스 템플릿은 건너뛰며, 외부 바인딩은 이 가져오기 기능의 범위가 아닙니다.
null 허용: False
예: []
가져오기 또는 입력 방법: 이 모듈의 export 응답 content 배열에서 템플릿을 가져오십시오. 전체 응답 래퍼를 Body로 사용하지 마십시오.
logIndexes[*] object 템플릿 객체이며 다음 전체 구조로 구성합니다.
예: {"name": "production_logs", "desc": "生产服务日志。", "duration": "7d", "directIndex": false, "isFullLineIndex": 1, "extend": {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}}
가져오기 또는 입력 방법: 각 항목은 일반 내부/직접 쓰기 인덱스이며 cloneConfig를 하나 포함할 수 있습니다.
logIndexes[*].cloneConfig json 선택적 복제 B 템플릿이며, 없으면 null/생략합니다. 이로 인해 대상의 기존 B가 삭제되지는 않으며, 일반 add/modify는 이 공개 파라미터를 지원하지 않습니다.
null 허용: True
예: {}
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].conditions string 내보내기 호환 조건 문자열입니다. 가져오기 생성/덮어쓰기는 실제로 extend로 다시 생성하며, 이 필드로 범위를 직접 결정하지 않습니다.
null 허용: False
예: { `env` = 'production' }
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].desc string 선택적 설명이며 최대 1024자입니다. 일반 modify에서 생략하면 유지되고 빈 문자열이면 비웁니다. 외부 바인딩 수정에서 생략하면 비웁니다.
null 허용: False
예: 生产服务日志。
가져오기 또는 입력 방법: 용도, 출처 및 유지 관리 책임 설명을 작성합니다.
logIndexes[*].directIndex boolean 선택 사항이며 생성 시 기본값은 false입니다. 직접 쓰기는 일반 매칭 순서로 분기하지 않습니다. 일반 modify에는 이 필드가 없으며, 가져오기 recover도 기존 인덱스 모드를 변환하지 않습니다.
null 허용: False
예: false
가져오기 또는 입력 방법: 일반 매칭으로 분기하는 인덱스는 false, 인덱스 이름으로 직접 쓰는 네이티브 직접 쓰기 인덱스는 true입니다.
logIndexes[*].duration string 일반 생성 시 기본값은 보통 3d입니다. 비TLS 스토리지에서 pay는 기본적으로 3d/7d/14d/30d/60d/90d를 허용하고, enterprise/unlimited는 기본 1d부터 1800d까지이며, 구체적인 값은 사이트 구성에 따릅니다. modify에서 생략하면 유지되며, TLS는 setting을 기준으로 하며 이 필드로 실제 기간을 제어하지 않습니다.
null 허용: False
예: 7d
가져오기 또는 입력 방법: 현재 워크스페이스 버전과 로그 스토리지에 따라 표준 보존 일수를 선택하고 정수+d를 사용합니다.
logIndexes[*].extend json 선택적 확장 객체이며 실제 매칭 및 표시 구성을 포함합니다. 일반 modify는 첫 번째 수준 키 기준으로 병합하고, 제공하지 않은 키는 유지하며, 배열 또는 중첩 객체는 전체 교체합니다. {}는 기존 filters를 지우지 않습니다. null은 피하십시오. 일부 수정 분기에서는 500이 발생합니다. 가져오기 recover는 extend를 전체 교체합니다.
null 허용: False
예: {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}
가져오기 또는 입력 방법: 매칭 조건은 실제 로그 필드와 값으로 구성하고, 기타 표시 구성은 원본 상세에서 유지합니다.
logIndexes[*].fields array 필드 매핑입니다. 생략하면 기존 매핑을 유지하고, 명시적 []는 빈 값으로 덮어쓰며, 외부 modify의 빈 배열 동작과 다릅니다.
null 허용: False
예: [{"field": "message", "originalField": "content"}]
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].isFullLineIndex int 0/1 또는 불리언만 허용합니다. scopedb 생성 시 기본값은 1이며 0은 허용하지 않습니다. 기존 Message는 0→1이 가능하지만 1→0은 불가능하며, 전환 시 message 필드 인덱스가 동기화되고 되돌릴 수 없습니다. modify에서 생략하면 유지됩니다.
null 허용: False
예: 1
가져오기 또는 입력 방법: scopedb 로그 생성 시 반드시 1/true여야 하며, 다른 로그 스토리지는 0/false를 유지합니다.
logIndexes[*].is_disable boolean 내보내기/가져오기 상태 키는 정확히 is_disable입니다. 기본값은 false이며, recover에서 원본이 비활성화되어 있고 true를 전달하지 않으면 활성화됩니다.
null 허용: False
예: false
가져오기 또는 입력 방법: 내보내기 템플릿의 해당 필드를 사용하고 대상 워크스페이스 리소스에 맞게 조정합니다.
logIndexes[*].name string Y 생성 시 필수이며, 선언상 최대 256자이지만 실제 저장 컬럼은 128자이므로 128자 이내를 권장합니다. ES 로그 스토리지는 하이픈을 허용하지 않습니다. default 예약 이름이나 다른 인덱스 UUID를 사용하지 마십시오. 일반 인덱스는 modify로 이름을 변경할 수 없습니다.
null 허용: False
예: production_logs
가져오기 또는 입력 방법: 비즈니스에 맞게 이름을 지정하고, 먼저 로그 인덱스 목록에서 현재 워크스페이스의 사용 중인 이름을 확인합니다.
logIndexes[*].setting json TLS 생성 시 hot_retention을 반드시 제공해야 합니다. 총 duration은 세 시간 수의 합을 일 단위로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지 및 필요한 단계를 완전히 제공하고 cold_retention만 전달하지 마십시오. 다른 스토리지는 이 필드를 TLS로 해석하지 않습니다.
null 허용: False
예: {"hot_retention": 168}
가져오기 또는 입력 방법: 워크스페이스 로그 스토리지가 volctls일 때만 표준/저빈도/아카이브 보존을 구성하며, 값 단위는 시간입니다.
logIndexes[*].storagePolicy json 선택적 전체 장기 정책 객체입니다. 일반 생성에서 생략하면 {}이고, 수정에서 생략하면 유지되며, {}는 비활성화로 정규화되고 명시적 비활성화는 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 엄격히 커야 하며 단위는 여전히 일입니다.
null 허용: False
예: {"longStorageEnabled": false}
가져오기 또는 입력 방법: 로그 스토리지가 scopedb이고 버전이 pay/enterprise/unlimited일 때만 장기 스토리지를 활성화할 수 있습니다. 먼저 워크스페이스 기능을 확인하십시오.
repeatLogIndexNameOp string 선택 사항이며 기본값은 check입니다. check는 중복 이름이 있으면 repeat_name을 반환하고 가져오지 않습니다. skip은 기존 항목을 덮어쓰지 않습니다. recover는 구성만 덮어쓰고 기록 데이터는 덮어쓰지 않습니다.
null 허용: False
선택 값: ['check', 'skip', 'recover']
예: check
가져오기 또는 입력 방법: check는 확인, skip은 기존 이름 건너뛰기, recover는 동일한 이름의 구성 덮어쓰기입니다.

파라미터 추가 설명

이 인터페이스는 로그 인덱스 템플릿을 개별적으로 가져오는 데 사용합니다.

호출 흐름

  1. logIndexes 배열을 준비하며, 각 요소는 하나의 로그 인덱스 템플릿을 나타냅니다.
  2. repeatLogIndexNameOp로 동일한 이름의 인덱스를 만났을 때의 처리 정책을 지정합니다.
  3. 정책이 check이고 동일한 이름의 인덱스가 있으면 인터페이스는 repeat_name을 반환하고 저장을 수행하지 않습니다.

repeatLogIndexNameOp 설명

값 설명
check 중복만 확인하며, 동일한 이름의 인덱스가 있으면 repeat_name을 반환합니다.
skip 이미 존재하는 동일한 이름의 인덱스를 건너뛰고 존재하지 않는 인덱스만 가져옵니다.
recover 대상 워크스페이스에 동일한 이름의 인덱스가 있으면 가져오기 템플릿에 따라 해당 인덱스 구성을 덮어씁니다.

특수 규칙

  • name=default인 템플릿은 무시하고 가져오기를 수행하지 않습니다.
  • 외부 인덱스 템플릿은 무시하고 가져오기를 수행하지 않습니다.
  • recover는 동일한 이름의 내부 인덱스만 덮어쓰며 default는 조작하지 않습니다.

템플릿 필드

필드 유형 필수 설명
name string 예 인덱스 이름
desc string 아니요 인덱스 설명
directIndex boolean 아니요 네이티브 직접 쓰기 인덱스인지 여부
isFullLineIndex int 아니요 전체 행 인덱스인지 여부이며, 정수 0/1 또는 불리언 false/true를 지원합니다. 새 Scopedb 인덱스는 기본값이 1이고 0으로 설정할 수 없습니다. 기존 인덱스를 덮어쓸 때 0→1은 허용되고 1→0은 금지되며, 전달하지 않으면 원래 값을 유지합니다.
conditions string 아니요 매칭 조건
duration string 아니요 스토리지 기간
storagePolicy json 아니요 장기 스토리지 정책
extend json 아니요 확장 구성
setting json 아니요 스토리지 설정
fields array 아니요 필드 매핑
cloneConfig json/null 아니요 복제 인덱스 전체 구성이며, 복제 인덱스가 없으면 null을 전달합니다.
is_disable boolean 아니요 비활성화 여부

반환 설명

  • 가져오기에 성공하면 successCount, failCount를 반환합니다.
  • 일부 객체가 실패하면 반환에 failedNames가 추가로 포함됩니다.
  • check 모드에서 중복이 발견되면 repeat_name을 반환합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/import' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"repeatLogIndexNameOp":"check","logIndexes":[{"name":"production_logs","desc":"生产服务日志。","duration":"7d","directIndex":false,"isFullLineIndex":1,"extend":{"matchMode":"basic","filters":[{"name":"env","condition":"and","operation":"=","value":["production"]}]},"conditions":"{ `env` =  '"'"'production'"'"' }","storagePolicy":{},"setting":{},"fields":[],"is_disable":false,"cloneConfig":null}]}'

응답

HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.successCount integer 제출에 성공한 항목 수이며, 복제는 A와 동일한 항목으로 계산합니다. 다운스트림 동기화 성공은 보장하지 않습니다.
content.failCount integer 항목별 제출 전 실패 수입니다.
content.failedNames array<string> 실패가 있으면 해당 인덱스 이름을 반환합니다.
content.failedNames[] string 단일 실패 이름입니다.
content.repeat_name array<string> check 모드에서 중복 이름을 발견하면 통계 결과 대신 반환하며, 가져오기를 수행하지 않았습니다.
content.repeat_name[] string 단일 기존 이름입니다.
content.declaration object 워크스페이스 선언입니다.
{
  "code": 200,
  "content": {
    "successCount": 1,
    "failCount": 0,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

check 모드에서 중복 이름 발견:

{
  "code": 200,
  "content": {
    "repeat_name": [
      "production_logs"
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드 누락 또는 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하십시오.
400 ft.JsonFormatError JSON 최상위가 객체가 아니거나 정책이 객체가 아님 일부 json 파일 형식 오류 파라미터 표에 따라 객체를 제출하고 storagePolicy는 JSON 객체를 사용하십시오.
400 ft.ErrorFieldCheck 템플릿 또는 cloneConfig에 비어 있지 않은 이름 누락 {} 필드 검증 실패 유효한 이름을 보완하십시오.
400 ft.FileObjectNameRepeat 동일 배치의 유효한 템플릿 이름 중복 파일에 동일한 이름의 객체 존재 trim 후 이름 기준으로 중복을 제거하십시오.
500 ft.InternalServerError 전처리, 전체 쿼리 또는 최종 응답 처리 실패 내부 오류 먼저 기존 인덱스와 각 항목 상태를 확인한 후 재시도 여부를 결정하고 traceId를 제공하십시오.
403 ft.Forbidden 권한 부족 또는 현재 버전에서 해당 인터페이스 미허용 작업 권한 없음 해당 인덱스 권한이 있는 API Key와 지원 버전을 사용하십시오.

문서 평가

이 페이지가 도움이 되었나요?