기본 유형 인덱스 구성 수정¶
POST /api/v1/log_index_cfg/{cfg_uuid}/modify
개요¶
내부 로그 인덱스의 매칭, 보존 및 표시 구성을 수정합니다.
호출 전 및 사용 단계¶
상세 정보를 먼저 읽어 기존 구성을 백업한 후, 필요에 따라 설명, 매칭 조건, 표준/장기 보존, TLS 단계 또는 전체 행 모드를 수정하세요. 일반 인덱스에서는 생략한 필드가 유지됩니다. extend는 최상위 키 기준으로 병합되며, 일반 매칭을 비우려면 filters=[]를 명시적으로 전달하세요. {}를 전달해도 기존 filters를 비울 수 없습니다. 배열/중첩 객체는 해당 키 전체를 교체하므로 extend=null을 피하세요. 인덱스 이름과 directIndex는 이 수정 Body에 포함되지 않습니다.
특수 cfg_uuid=default는 extend와 isFullLineIndex만 저장하며, desc/duration/storagePolicy/setting은 해당 분기에서 일반 인덱스 보존 설정으로 처리되지 않습니다. 성공 응답만으로 기본 인덱스 보존 기간이 변경되었다고 추론하지 마세요. scopedb의 0→1 전체 행 전환은 되돌릴 수 없으며, 원본 A를 업그레이드하면 기존 B도 함께 업그레이드됩니다. B 자체의 공개 편집 가능한 구성은 직접 조정할 수 있습니다. 이 Body를 통해 B의 이름이나 원본을 변경하거나 다른 B를 생성하지 마세요.
스토리지 구성, 실제 다운스트림 작업, 데이터베이스 커밋은 동일한 원자적 단계가 아닙니다. 오류/타임아웃 발생 시 먼저 목록 및 상세 정보에서 현재 구성을 확인한 다음 스토리지의 실제 상태를 확인하세요. 바로 다시 생성하지 마세요. 인덱스 생성 성공이 물리 인덱스가 생성되었거나 데이터가 이미 존재함을 보장하지 않으므로, 보존 기간을 줄이기 전에 데이터 보존 요구 사항을 먼저 확인하세요.
default 응답은 합성 객체이며 기본 인덱스 필드 및 workspaceName/workspaceStatus만 보장합니다. 일반 엔터티의 id, desc, creator, updator, setting, cloneConfig 등은 존재를 보장하지 않습니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| cfg_uuid | string | Y | 경로 구성 UUID이며 인덱스 이름이 아닙니다. 기본 인덱스는 일부 수정 기능만 지원합니다. 사용법을 참고하세요. 예시: lgim_example획득 또는 입력 방법: 로그 인덱스 목록의 content.data[].uuid에서 현재 워크스페이스 구성을 가져옵니다. 기본 인덱스는 default를 사용합니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| storagePolicy.longStorageEnabled | boolean | 객체 내에서 생략하면 기본값은 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되며, 이는 과거 데이터를 즉시 삭제한다는 의미가 아닙니다. 예시: false획득 또는 입력 방법: true는 장기 스토리지 활성화, false는 비활성화입니다. JSON 부울을 명확히 사용하는 것이 좋습니다. |
|
| storagePolicy.longStorageDuration | string | 활성화 시 조건부 필수입니다. 필드는 d가 포함된 문자열이며 초/시간이 아닙니다. 메트릭 rp의 3600d 범위를 로그에 적용하지 마세요. 예시: 180d획득 또는 입력 방법: pay는 기본적으로 90d/120d/180d/360d를 선택하고, enterprise/unlimited는 기본적으로 1d~1800d이며 duration보다 반드시 커야 합니다. |
|
| extend.matchMode | string | 생략/빈 값은 basic으로 처리합니다. advanced는 advancedFilter를 사용하고 basic은 filters를 사용합니다. 모드를 전환할 때는 해당하는 전체 조건을 함께 제공하세요. 예시: basic획득 또는 입력 방법: 일반 매칭은 basic, 고급 매칭은 advanced입니다. |
|
| extend.filters | array | basic의 리프 배열이며, 비어 있지 않은 조건은 conditions를 생성합니다. basic 생성/수정 시 operation이 match 또는 not match인 경우 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하세요. 예시: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]획득 또는 입력 방법: 실제 로그 필드 조건입니다. 일반 매칭을 비워야 할 때는 filters=[]를 명시적으로 전달하세요. |
|
| extend.filters[*].name | string | 실제 필드 이름이며 백틱을 추가하지 않습니다. 예시: env획득 또는 입력 방법: 실제 로그 필드, 값, 매칭 관계에 따라 입력하세요. |
|
| extend.filters[*].condition | string | 이전 조건과의 and/or 관계이며 첫 항목의 연결자는 무시합니다. 예시: and획득 또는 입력 방법: 실제 로그 필드, 값, 매칭 관계에 따라 입력하세요. |
|
| extend.filters[*].operation | string | 일반적으로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. basic에서는 match/not match를 금지합니다. 예시: =획득 또는 입력 방법: 실제 로그 필드, 값, 매칭 관계에 따라 입력하세요. |
|
| extend.filters[*].value | array | 조건 값 배열이며, = 및 비교는 첫 항목을 사용합니다. 존재 계열은 여전히 비어 있지 않은 자리 표시자 배열을 사용하는 것이 좋습니다. 예시: ["production"]획득 또는 입력 방법: 실제 로그 필드, 값, 매칭 관계에 따라 입력하세요. |
|
| extend.filters[*] | json | 조건 객체이며 필드 이름/연산/값이 완전해야 합니다. 예시: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}획득 또는 입력 방법: 각 항목은 기본 조건 하나를 나타냅니다. |
|
| extend.filters[*].value[*] | JSON | 단일 비교 값이며 표시 이름으로 실제 값을 대체하지 않습니다. 예시: production획득 또는 입력 방법: 로그 원본 필드 값을 사용하며 문자열/숫자 유형을 유지합니다. |
|
| 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의 평면 형식을 복사하지 마세요. |
|
| extend.advancedFilter.type | string | 루트 노드 유형이며 rule일 수 없습니다. 예시: group획득 또는 입력 방법: 루트 노드는 group으로 고정됩니다. |
|
| extend.advancedFilter.condition | string | 같은 그룹 하위 조건의 논리 관계입니다. 예시: and획득 또는 입력 방법: and/or이며 기본값은 and입니다. |
|
| extend.advancedFilter.filters | array | 하위 노드 배열이며 동일한 group 구조를 중첩할 수 있습니다. 빈 그룹은 빈 조건을 생성합니다. 예시: [{"type": "rule", "name": "env", "operation": "=", "value": ["production"]}]획득 또는 입력 방법: 리프 rule 또는 재귀 group 하위 노드를 입력하세요. |
|
| extend.advancedFilter.filters[*] | json | rule 리프 또는 group 객체입니다. 예시: {"type": "rule", "name": "env", "operation": "=", "value": ["production"]}획득 또는 입력 방법: 리프는 실제 로그 필드로 입력하고, 그룹은 동일한 구조로 계속 재귀 구성하세요. |
|
| extend.advancedFilter.filters[*].type | string | rule은 리프, group은 재귀 그룹입니다. 예시: rule획득 또는 입력 방법: 해당 group/rule 노드 구조에 따라 입력하세요. |
|
| extend.advancedFilter.filters[*].name | string | rule 필수이며 비어 있지 않은 필드 이름입니다. 예시: env획득 또는 입력 방법: 해당 group/rule 노드 구조에 따라 입력하세요. |
|
| extend.advancedFilter.filters[*].operation | string | rule에서 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다. 예시: =획득 또는 입력 방법: 해당 group/rule 노드 구조에 따라 입력하세요. |
|
| extend.advancedFilter.filters[*].value | array | rule 필수 배열입니다. exist/not_exist는 []를 사용할 수 있으며, 그 외에는 빈 배열을 허용하지 않습니다. 예시: ["production"]획득 또는 입력 방법: 해당 group/rule 노드 구조에 따라 입력하세요. |
|
| extend.advancedFilter.filters[*].condition | string | group 하위 그룹은 and/or를 사용합니다. 예시: and획득 또는 입력 방법: 해당 group/rule 노드 구조에 따라 입력하세요. |
|
| extend.advancedFilter.filters[*].filters | array | group 하위 그룹의 재귀 배열이며 규칙 리프에서는 생략합니다. 예시: []획득 또는 입력 방법: 해당 group/rule 노드 구조에 따라 입력하세요. |
|
| extend.advancedFilter.filters[*].value[*] | JSON | 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다. 예시: production획득 또는 입력 방법: 로그 원본 값을 사용하세요. |
|
| extend.extendFields | array | 선택적 핵심 필드 배열입니다. tag/alias 구조로 제출해야 하며 tag는 비어 있지 않아야 합니다. 생성 시에는 이 구조 검증이 강제되지 않지만 수정 시에는 검증합니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스를 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다. 예시: [{"tag": "service", "alias": "服务"}]획득 또는 입력 방법: 실제 로그 필드에서 주요 표시 필드를 선택하세요. |
|
| extend.extendFields[*] | json | tag/alias 키만 허용합니다. 예시: {"tag": "service", "alias": "服务"}획득 또는 입력 방법: 필드 키와 표시 별칭에 따라 입력하세요. |
|
| extend.extendFields[*].tag | string | 조건부 필수이며 비어 있지 않은 키입니다. 예시: service획득 또는 입력 방법: 실제 로그 필드 이름입니다. |
|
| extend.extendFields[*].alias | string | 선택적 표시 별칭입니다. 예시: 服务획득 또는 입력 방법: 비즈니스 표시 이름이며 생략할 수 있습니다. |
|
| extend.topFields | array | 선택적 표시 구성이며 동일한 tag/alias 객체로 사용합니다. 일반 modify는 독립적인 상단 고정 API가 아닙니다. 예시: [{"tag": "host", "alias": "主机"}]획득 또는 입력 방법: 콘솔의 상단 고정 필드 목록을 유지합니다. |
|
| extend.topFields[*] | json | 단일 표시 필드 객체입니다. 예시: {"tag": "host", "alias": "主机"}획득 또는 입력 방법: 기존 목록에 따라 채우세요. |
|
| extend.topFields[*].tag | string | 필드 키입니다. 예시: host획득 또는 입력 방법: 실제 필드 이름입니다. |
|
| extend.topFields[*].alias | string | 선택적 별칭입니다. 예시: 主机획득 또는 입력 방법: 표시 별칭입니다. |
|
| extend.services | array | 선택적 표시 정보이며 filters의 실제 매칭 조건을 대체하지 않습니다. 예시: ["checkout-api"]획득 또는 입력 방법: 콘솔의 관련 서비스 표시 구성을 유지합니다. |
|
| extend.services[*] | string | 단일 서비스 표시 값입니다. 예시: checkout-api획득 또는 입력 방법: 실제 서비스 이름입니다. |
|
| desc | string | 선택적 설명이며 최대 1024자입니다. 일반 modify에서 생략하면 유지되고 빈 문자열이면 비웁니다. 외부 바인딩 수정에서 생략하면 비워집니다. 빈 문자열 허용: True null 허용: False 최대 길이: 1024 예시: 生产服务日志。획득 또는 입력 방법: 용도, 원본, 유지 관리 책임 설명을 입력하세요. |
|
| duration | string | 일반 생성 시 기본값은 보통 3d입니다. 비TLS 스토리지에서 pay는 기본적으로 3d/7d/14d/30d/60d/90d를 허용하고 enterprise/unlimited는 기본적으로 1d~1800d를 허용하며 구체적인 값은 사이트 구성에 따릅니다. modify에서 생략하면 유지됩니다. TLS는 setting을 참조하며 이 필드로 실제 기간을 제어하지 않습니다. null 허용: False 예시: 7d획득 또는 입력 방법: 현재 워크스페이스 버전과 로그 스토리지에 따라 표준 보존 일수를 선택하고 정수+d를 사용하세요. |
|
| extend | json | 선택적 확장 객체이며 실제 매칭 및 표시 구성을 포함합니다. 일반 modify는 최상위 키 기준으로 병합하고, 제공되지 않은 키는 유지하며, 배열 또는 중첩 객체는 전체를 교체합니다. {}는 기존 filters를 비우지 않습니다. null을 피하세요. 일부 수정 분기에서는 500이 발생할 수 있습니다. 가져오기 recover는 extend 전체를 교체합니다. null 허용: True 예시: {"matchMode": "basic", "filters": [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]}획득 또는 입력 방법: 매칭 조건은 실제 로그 필드와 값으로 구성하고, 기타 표시 구성은 원본 상세에서 유지합니다. |
|
| isFullLineIndex | int | 0/1 또는 부울만 허용합니다. scopedb 생성 시 기본값은 1이며 0은 허용되지 않습니다. 기존 Message는 0→1이 가능하지만 1→0은 불가능하며, 전환 시 message 필드 인덱스가 동기화되고 되돌릴 수 없습니다. modify에서 생략하면 유지됩니다. null 허용: False 예시: 1획득 또는 입력 방법: scopedb 로그 생성 시에는 1/true여야 하며, 다른 로그 스토리지는 0/false를 유지합니다. |
|
| setting | json | TLS 생성 시 hot_retention을 반드시 제공해야 하며, 총 duration은 세 시간 값의 합을 일 단위로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지와 필요한 단계를 완전히 제공하고 cold_retention만 전달하지 마세요. 다른 스토리지에서는 이 필드를 TLS로 해석하지 않습니다. null 허용: False 예시: {"hot_retention": 168}획득 또는 입력 방법: 워크스페이스 로그 스토리지가 volctls인 경우에만 표준/저빈도/아카이브 보존을 구성하며, 값 단위는 시간입니다. |
|
| setting.archive_retention | int | 선택 사항이며 기본값은 60..1800일이고 정수 일수에 해당하는 시간 수입니다. 핫 스토리지는 최소 30일이며 합계는 1800일을 초과할 수 없습니다. null 허용: False 예시: 1440획득 또는 입력 방법: 아카이브 일수×24입니다. 예를 들어 60일=1440시간입니다. 해당 단계를 사용하지 않으면 생략합니다. |
|
| setting.cold_retention | int | 선택 사항이며 기본값은 30..1800일이고 정수 일수에 해당하는 시간 수입니다. 0을 사용하여 생략을 나타내지 않으며 합계는 1800일을 초과할 수 없습니다. null 허용: False 예시: 720획득 또는 입력 방법: 저빈도 스토리지 일수×24입니다. 예를 들어 30일=720시간입니다. 해당 단계를 사용하지 않으면 생략합니다. |
|
| setting.hot_retention | int | TLS 조건부 필수이며 기본 범위는 1~1800일로 24..43200시간에 해당하고 24의 배수입니다. 콜드 스토리지를 사용할 때 핫 스토리지는 최소 7일, 아카이브를 사용할 때 최소 30일입니다. null 허용: False 예시: 168획득 또는 입력 방법: 일수×24로 입력하세요. 예를 들어 7일=168시간입니다. |
|
| storagePolicy | json | 선택적 전체 장기 정책 객체입니다. 일반 생성 시 {}를 생략합니다. 수정 시 생략하면 유지되고, {}는 비활성화로 정규화되며 명시적 비활성화는 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 반드시 커야 하며 단위는 여전히 일입니다. null 허용: False 예시: {"longStorageEnabled": false}획득 또는 입력 방법: 로그 스토리지가 scopedb이고 버전이 pay/enterprise/unlimited인 경우에만 장기 스토리지를 활성화할 수 있습니다. 먼저 워크스페이스 기능을 확인하세요. |
파라미터 추가 설명¶
extend의 매칭 조건 설명
| 파라미터 이름 | type | 필수 | 설명 |
|---|---|---|---|
| matchMode | String | 매칭 모드, 선택 가능한 값: basic, advanced; 생략 시 basic으로 처리합니다. |
|
| filters | Array[dict] | 일반 매칭 필터 조건 목록이며 advanced 모드에서는 빈 배열을 전달하는 것이 좋습니다. |
|
| advancedFilter | Dict | 고급 매칭 조건 트리이며 matchMode=advanced일 때 적용됩니다. |
advancedFilter의 루트 노드는 항상 group이며, group.filters에는 rule 또는 group을 중첩할 수 있습니다. rule.operation의 선택 가능한 값은 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist입니다. value는 항상 배열이며 exist / not_exist는 빈 배열을 사용합니다. matchMode=advanced일 때 백엔드는 DQL where 스타일로 conditions를 생성하며, 일반 filters는 기존 생성 형식을 유지합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"desc":"生产服务日志已更新。","duration":"14d","extend":{"matchMode":"basic","filters":[{"name":"env","condition":"and","operation":"=","value":["production"]}]}}'
응답¶
HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 데이터베이스 레코드 번호이며, 생성 제출 전 스냅샷에서는 null일 수 있습니다. 작업에는 uuid를 사용합니다. |
| content.uuid | string | lgim_ 인덱스 구성 UUID이며 기본 인덱스는 default를 사용합니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.sourceIndexUUID | string | 클론 인덱스 B의 원본 A UUID이며 일반 인덱스는 비어 있습니다. |
| content.name | string | 인덱스 이름입니다. |
| content.desc | string | 설명입니다. |
| content.conditions | string | extend에 따라 생성된 실제 조건 문자열이며 일반 요청에서는 이 필드를 직접 수정하지 마세요. |
| content.sortNo | integer 또는 string | 매칭 순서 식별자이며 네이티브 직접 쓰기 또는 클론은 일반적으로 0입니다. |
| content.duration | string | 표준 스토리지 기간이며 TLS는 콜드/핫/아카이브 합계 일수입니다. |
| content.isBindCustomStore | integer 또는 boolean | 1/true이면 외부 스토리지에 바인딩됩니다. |
| content.directIndex | integer 또는 boolean | 1/true이면 네이티브 직접 쓰기입니다. |
| content.isFullLineIndex | integer | 1은 전체 행, 0은 Message입니다. |
| content.queryType | string | 조회 범주이며 예를 들어 logging/standard 또는 외부 SLS가 반환하는 모드입니다. |
| content.exterStoreProject | string | 외부 프로젝트/데이터베이스 식별자이며 내부 인덱스는 일반적으로 비어 있습니다. |
| content.exterStoreName | string | 외부 리소스 이름이며 내부 인덱스는 일반적으로 비어 있습니다. |
| content.externalResourceAccessCfgUUID | string | 액세스 구성 식별자이며 자격 증명 원문이 아닙니다. |
| content.storeType | string | 내부 인덱스는 일반적으로 비어 있고 외부에 바인딩된 경우 실제 유형입니다. |
| content.region | string | 외부 리전 코드입니다. |
| content.isPublicNetworkAccess | integer 또는 boolean | 공용 네트워크 액세스 플래그입니다. |
| 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.storagePolicy | object | 선택적 전체 장기 정책 객체입니다. 일반 생성 시 {}를 생략합니다. 수정 시 생략하면 유지되고, {}는 비활성화로 정규화되며 명시적 비활성화는 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 반드시 커야 하며 단위는 여전히 일입니다. |
| content.storagePolicy.longStorageEnabled | boolean | 객체 내에서 생략하면 기본값은 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되며, 이는 과거 데이터를 즉시 삭제한다는 의미가 아닙니다. |
| content.storagePolicy.longStorageDuration | string | 활성화 시 조건부 필수입니다. 필드는 d가 포함된 문자열이며 초/시간이 아닙니다. 메트릭 rp의 3600d 범위를 로그에 적용하지 마세요. |
| content.setting | object | TLS 생성 시 hot_retention을 반드시 제공해야 하며, 총 duration은 세 시간 값의 합을 일 단위로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지와 필요한 단계를 완전히 제공하고 cold_retention만 전달하지 마세요. 다른 스토리지에서는 이 필드를 TLS로 해석하지 않습니다. |
| content.setting.hot_retention | integer | TLS 조건부 필수이며 기본 범위는 1~1800일로 24..43200시간에 해당하고 24의 배수입니다. 콜드 스토리지를 사용할 때 핫 스토리지는 최소 7일, 아카이브를 사용할 때 최소 30일입니다. |
| content.setting.cold_retention | integer | 선택 사항이며 기본값은 30..1800일이고 정수 일수에 해당하는 시간 수입니다. 0을 사용하여 생략을 나타내지 않으며 합계는 1800일을 초과할 수 없습니다. |
| content.setting.archive_retention | integer | 선택 사항이며 기본값은 60..1800일이고 정수 일수에 해당하는 시간 수입니다. 핫 스토리지는 최소 30일이며 합계는 1800일을 초과할 수 없습니다. |
| content.extend | object | 선택적 확장 객체이며 실제 매칭 및 표시 구성을 포함합니다. 일반 modify는 최상위 키 기준으로 병합하고, 제공되지 않은 키는 유지하며, 배열 또는 중첩 객체는 전체를 교체합니다. {}는 기존 filters를 비우지 않습니다. null을 피하세요. 일부 수정 분기에서는 500이 발생할 수 있습니다. 가져오기 recover는 extend 전체를 교체합니다. |
| content.extend.matchMode | string | 생략/빈 값은 basic으로 처리합니다. advanced는 advancedFilter를 사용하고 basic은 filters를 사용합니다. 모드를 전환할 때는 해당하는 전체 조건을 함께 제공하세요. |
| content.extend.filters | array | basic의 리프 배열이며, 비어 있지 않은 조건은 conditions를 생성합니다. basic 생성/수정 시 operation이 match 또는 not match인 경우 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하세요. |
| content.extend.filters[].name | string | 실제 필드 이름이며 백틱을 추가하지 않습니다. |
| content.extend.filters[].condition | string | 이전 조건과의 and/or 관계이며 첫 항목의 연결자는 무시합니다. |
| content.extend.filters[].operation | string | 일반적으로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. basic에서는 match/not match를 금지합니다. |
| content.extend.filters[].value | array | 조건 값 배열이며, = 및 비교는 첫 항목을 사용합니다. 존재 계열은 여전히 비어 있지 않은 자리 표시자 배열을 사용하는 것이 좋습니다. |
| content.extend.filters[] | json | 조건 객체이며 필드 이름/연산/값이 완전해야 합니다. |
| content.extend.filters[].value[] | JSON | 단일 비교 값이며 표시 이름으로 실제 값을 대체하지 않습니다. |
| content.extend.advancedFilter | json | advanced일 때 필수인 루트 group 객체입니다. 그룹은 type=group, condition, filters를 사용하고 리프는 type=rule, name, operation, value를 사용합니다. |
| content.extend.advancedFilter.type | string | 루트 노드 유형이며 rule일 수 없습니다. |
| content.extend.advancedFilter.condition | string | 같은 그룹 하위 조건의 논리 관계입니다. |
| content.extend.advancedFilter.filters | array | 하위 노드 배열이며 동일한 group 구조를 중첩할 수 있습니다. 빈 그룹은 빈 조건을 생성합니다. |
| content.extend.advancedFilter.filters[] | json | rule 리프 또는 group 객체입니다. |
| content.extend.advancedFilter.filters[].type | string | rule은 리프, group은 재귀 그룹입니다. |
| content.extend.advancedFilter.filters[].name | string | rule 필수이며 비어 있지 않은 필드 이름입니다. |
| content.extend.advancedFilter.filters[].operation | string | rule에서 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다. |
| content.extend.advancedFilter.filters[].value | array | rule 필수 배열입니다. exist/not_exist는 []를 사용할 수 있으며, 그 외에는 빈 배열을 허용하지 않습니다. |
| content.extend.advancedFilter.filters[].condition | string | group 하위 그룹은 and/or를 사용합니다. |
| content.extend.advancedFilter.filters[].filters | array | group 하위 그룹의 재귀 배열이며 규칙 리프에서는 생략합니다. |
| content.extend.advancedFilter.filters[].value[] | JSON | 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다. |
| content.extend.extendFields | array | 선택적 핵심 필드 배열입니다. tag/alias 구조로 제출해야 하며 tag는 비어 있지 않아야 합니다. 생성 시에는 이 구조 검증이 강제되지 않지만 수정 시에는 검증합니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스를 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다. |
| content.extend.extendFields[] | json | tag/alias 키만 허용합니다. |
| content.extend.extendFields[].tag | string | 조건부 필수이며 비어 있지 않은 키입니다. |
| content.extend.extendFields[].alias | string | 선택적 표시 별칭입니다. |
| content.extend.topFields | array | 선택적 표시 구성이며 동일한 tag/alias 객체로 사용합니다. 일반 modify는 독립적인 상단 고정 API가 아닙니다. |
| content.extend.topFields[] | json | 단일 표시 필드 객체입니다. |
| content.extend.topFields[].tag | string | 필드 키입니다. |
| content.extend.topFields[].alias | string | 선택적 별칭입니다. |
| content.extend.services | array | 선택적 표시 정보이며 filters의 실제 매칭 조건을 대체하지 않습니다. |
| content.extend.services[] | string | 단일 서비스 표시 값입니다. |
| content.cloneConfig | object 또는 null | 원본 A와 연결된 클론 B의 전체 엔터티이며 없으면 null입니다. 클론 자체 응답에는 이 키가 항상 포함되지는 않습니다. |
| content.cloneConfig.id | integer 또는 null | 데이터베이스 레코드 번호이며, 생성 제출 전 스냅샷에서는 null일 수 있습니다. 작업에는 uuid를 사용합니다. |
| content.cloneConfig.uuid | string | lgim_ 인덱스 구성 UUID이며 기본 인덱스는 default를 사용합니다. |
| content.cloneConfig.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.cloneConfig.sourceIndexUUID | string | 클론 인덱스 B의 원본 A UUID이며 일반 인덱스는 비어 있습니다. |
| content.cloneConfig.name | string | 인덱스 이름입니다. |
| content.cloneConfig.desc | string | 설명입니다. |
| content.cloneConfig.conditions | string | extend에 따라 생성된 실제 조건 문자열이며 일반 요청에서는 이 필드를 직접 수정하지 마세요. |
| content.cloneConfig.sortNo | integer 또는 string | 매칭 순서 식별자이며 네이티브 직접 쓰기 또는 클론은 일반적으로 0입니다. |
| content.cloneConfig.duration | string | 표준 스토리지 기간이며 TLS는 콜드/핫/아카이브 합계 일수입니다. |
| content.cloneConfig.isBindCustomStore | integer 또는 boolean | 1/true이면 외부 스토리지에 바인딩됩니다. |
| content.cloneConfig.directIndex | integer 또는 boolean | 1/true이면 네이티브 직접 쓰기입니다. |
| content.cloneConfig.isFullLineIndex | integer | 1은 전체 행, 0은 Message입니다. |
| content.cloneConfig.queryType | string | 조회 범주이며 예를 들어 logging/standard 또는 외부 SLS가 반환하는 모드입니다. |
| content.cloneConfig.exterStoreProject | string | 외부 프로젝트/데이터베이스 식별자이며 내부 인덱스는 일반적으로 비어 있습니다. |
| content.cloneConfig.exterStoreName | string | 외부 리소스 이름이며 내부 인덱스는 일반적으로 비어 있습니다. |
| content.cloneConfig.externalResourceAccessCfgUUID | string | 액세스 구성 식별자이며 자격 증명 원문이 아닙니다. |
| content.cloneConfig.storeType | string | 내부 인덱스는 일반적으로 비어 있고 외부에 바인딩된 경우 실제 유형입니다. |
| content.cloneConfig.region | string | 외부 리전 코드입니다. |
| content.cloneConfig.isPublicNetworkAccess | integer 또는 boolean | 공용 네트워크 액세스 플래그입니다. |
| content.cloneConfig.status | integer | 0 활성화, 2 비활성화, 3 삭제입니다. |
| content.cloneConfig.creator | string | 생성 주체입니다. |
| content.cloneConfig.updator | string | 최근 업데이트 주체입니다. |
| content.cloneConfig.createAt | integer | 생성 Unix 초입니다. |
| content.cloneConfig.updateAt | integer | 업데이트 Unix 초이며 업데이트되지 않은 경우 -1입니다. |
| content.cloneConfig.deleteAt | integer | 삭제 Unix 초이며 삭제되지 않은 경우 -1입니다. |
| content.cloneConfig.storagePolicy | object | 선택적 전체 장기 정책 객체입니다. 일반 생성 시 {}를 생략합니다. 수정 시 생략하면 유지되고, {}는 비활성화로 정규화되며 명시적 비활성화는 longStorageEnabled=false를 사용합니다. 장기 기간은 표준 duration보다 반드시 커야 하며 단위는 여전히 일입니다. |
| content.cloneConfig.storagePolicy.longStorageEnabled | boolean | 객체 내에서 생략하면 기본값은 false입니다. 비활성화하면 longStorageDuration이 빈 값으로 정규화되며, 이는 과거 데이터를 즉시 삭제한다는 의미가 아닙니다. |
| content.cloneConfig.storagePolicy.longStorageDuration | string | 활성화 시 조건부 필수입니다. 필드는 d가 포함된 문자열이며 초/시간이 아닙니다. 메트릭 rp의 3600d 범위를 로그에 적용하지 마세요. |
| content.cloneConfig.setting | object | TLS 생성 시 hot_retention을 반드시 제공해야 하며, 총 duration은 세 시간 값의 합을 일 단위로 환산합니다. 일반 수정에서 setting을 제공할 때는 핫 스토리지와 필요한 단계를 완전히 제공하고 cold_retention만 전달하지 마세요. 다른 스토리지에서는 이 필드를 TLS로 해석하지 않습니다. |
| content.cloneConfig.setting.hot_retention | integer | TLS 조건부 필수이며 기본 범위는 1~1800일로 24..43200시간에 해당하고 24의 배수입니다. 콜드 스토리지를 사용할 때 핫 스토리지는 최소 7일, 아카이브를 사용할 때 최소 30일입니다. |
| content.cloneConfig.setting.cold_retention | integer | 선택 사항이며 기본값은 30..1800일이고 정수 일수에 해당하는 시간 수입니다. 0을 사용하여 생략을 나타내지 않으며 합계는 1800일을 초과할 수 없습니다. |
| content.cloneConfig.setting.archive_retention | integer | 선택 사항이며 기본값은 60..1800일이고 정수 일수에 해당하는 시간 수입니다. 핫 스토리지는 최소 30일이며 합계는 1800일을 초과할 수 없습니다. |
| content.cloneConfig.extend | object | 선택적 확장 객체이며 실제 매칭 및 표시 구성을 포함합니다. 일반 modify는 최상위 키 기준으로 병합하고, 제공되지 않은 키는 유지하며, 배열 또는 중첩 객체는 전체를 교체합니다. {}는 기존 filters를 비우지 않습니다. null을 피하세요. 일부 수정 분기에서는 500이 발생할 수 있습니다. 가져오기 recover는 extend 전체를 교체합니다. |
| content.cloneConfig.extend.matchMode | string | 생략/빈 값은 basic으로 처리합니다. advanced는 advancedFilter를 사용하고 basic은 filters를 사용합니다. 모드를 전환할 때는 해당하는 전체 조건을 함께 제공하세요. |
| content.cloneConfig.extend.filters | array | basic의 리프 배열이며, 비어 있지 않은 조건은 conditions를 생성합니다. basic 생성/수정 시 operation이 match 또는 not match인 경우 명시적으로 거부합니다. 텍스트 포함 등 복잡한 의미는 advanced의 해당 연산을 우선 사용하세요. |
| content.cloneConfig.extend.filters[].name | string | 실제 필드 이름이며 백틱을 추가하지 않습니다. |
| content.cloneConfig.extend.filters[].condition | string | 이전 조건과의 and/or 관계이며 첫 항목의 연결자는 무시합니다. |
| content.cloneConfig.extend.filters[].operation | string | 일반적으로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. basic에서는 match/not match를 금지합니다. |
| content.cloneConfig.extend.filters[].value | array | 조건 값 배열이며, = 및 비교는 첫 항목을 사용합니다. 존재 계열은 여전히 비어 있지 않은 자리 표시자 배열을 사용하는 것이 좋습니다. |
| content.cloneConfig.extend.filters[] | json | 조건 객체이며 필드 이름/연산/값이 완전해야 합니다. |
| content.cloneConfig.extend.filters[].value[] | JSON | 단일 비교 값이며 표시 이름으로 실제 값을 대체하지 않습니다. |
| content.cloneConfig.extend.advancedFilter | json | advanced일 때 필수인 루트 group 객체입니다. 그룹은 type=group, condition, filters를 사용하고 리프는 type=rule, name, operation, value를 사용합니다. |
| content.cloneConfig.extend.advancedFilter.type | string | 루트 노드 유형이며 rule일 수 없습니다. |
| content.cloneConfig.extend.advancedFilter.condition | string | 같은 그룹 하위 조건의 논리 관계입니다. |
| content.cloneConfig.extend.advancedFilter.filters | array | 하위 노드 배열이며 동일한 group 구조를 중첩할 수 있습니다. 빈 그룹은 빈 조건을 생성합니다. |
| content.cloneConfig.extend.advancedFilter.filters[] | json | rule 리프 또는 group 객체입니다. |
| content.cloneConfig.extend.advancedFilter.filters[].type | string | rule은 리프, group은 재귀 그룹입니다. |
| content.cloneConfig.extend.advancedFilter.filters[].name | string | rule 필수이며 비어 있지 않은 필드 이름입니다. |
| content.cloneConfig.extend.advancedFilter.filters[].operation | string | rule에서 =, !=, in, not_in, match, not_match, wildcard, not_wildcard, regexp, not_regexp, >, <, >=, <=, exist, not_exist를 허용합니다. |
| content.cloneConfig.extend.advancedFilter.filters[].value | array | rule 필수 배열입니다. exist/not_exist는 []를 사용할 수 있으며, 그 외에는 빈 배열을 허용하지 않습니다. |
| content.cloneConfig.extend.advancedFilter.filters[].condition | string | group 하위 그룹은 and/or를 사용합니다. |
| content.cloneConfig.extend.advancedFilter.filters[].filters | array | group 하위 그룹의 재귀 배열이며 규칙 리프에서는 생략합니다. |
| content.cloneConfig.extend.advancedFilter.filters[].value[] | JSON | 단일 문자열 또는 숫자 값입니다. regexp 값에는 백틱이 포함되지 않습니다. |
| content.cloneConfig.extend.extendFields | array | 선택적 핵심 필드 배열입니다. tag/alias 구조로 제출해야 하며 tag는 비어 있지 않아야 합니다. 생성 시에는 이 구조 검증이 강제되지 않지만 수정 시에는 검증합니다. 가져오기는 필드 가속 스위치에 따라 필드 인덱스를 추가로 동기화하며, 직접 modify는 이 구성만 저장합니다. |
| content.cloneConfig.extend.extendFields[] | json | tag/alias 키만 허용합니다. |
| content.cloneConfig.extend.extendFields[].tag | string | 조건부 필수이며 비어 있지 않은 키입니다. |
| content.cloneConfig.extend.extendFields[].alias | string | 선택적 표시 별칭입니다. |
| content.cloneConfig.extend.topFields | array | 선택적 표시 구성이며 동일한 tag/alias 객체로 사용합니다. 일반 modify는 독립적인 상단 고정 API가 아닙니다. |
| content.cloneConfig.extend.topFields[] | json | 단일 표시 필드 객체입니다. |
| content.cloneConfig.extend.topFields[].tag | string | 필드 키입니다. |
| content.cloneConfig.extend.topFields[].alias | string | 선택적 별칭입니다. |
| content.cloneConfig.extend.services | array | 선택적 표시 정보이며 filters의 실제 매칭 조건을 대체하지 않습니다. |
| content.cloneConfig.extend.services[] | string | 단일 서비스 표시 값입니다. |
| content.declaration | object | 워크스페이스 공통 선언이며 단일 엔터티 응답에 추가됩니다. |
| content.workspaceName | string | default 합성 응답에만 포함되는 워크스페이스 이름입니다. |
| content.workspaceStatus | integer | default 합성 응답에만 포함되는 워크스페이스 상태입니다. |
{
"code": 200,
"content": {
"id": 100,
"uuid": "lgim_example",
"workspaceUUID": "wksp_example",
"sourceIndexUUID": "",
"name": "production_logs",
"desc": "生产服务日志已更新。",
"duration": "14d",
"directIndex": false,
"isFullLineIndex": 1,
"extend": {
"matchMode": "basic",
"filters": [
{
"name": "env",
"condition": "and",
"operation": "=",
"value": [
"production"
]
}
]
},
"conditions": "{ `env` = 'production' }",
"sortNo": 1,
"isBindCustomStore": 0,
"queryType": "logging",
"exterStoreProject": "",
"exterStoreName": "",
"externalResourceAccessCfgUUID": "",
"storeType": "",
"region": "",
"isPublicNetworkAccess": 0,
"setting": {},
"storagePolicy": {},
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427300,
"deleteAt": -1,
"cloneConfig": null,
"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 객체를 사용하세요. |
| 429 | ft.OperationTooFrequently | 동일 워크스페이스의 스토리지 쓰기/인덱스 관계 동시 작업 또는 잠금 리스 만료 | 작업이 너무 빈번합니다. 잠시 후 다시 시도하세요 | 진행 중인 작업이 완료될 때까지 기다린 후 백오프 재시도하고, 먼저 현재 상태를 조회하세요. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 다운스트림 연결/일반 5xx 또는 필드 형태 이상 | 내부 오류 | 먼저 구성을 읽고 실제 스토리지 현재 상태를 확인하세요. 계속 실패하면 traceId를 제공하세요. 오류를 미저장으로 간주하거나 바로 다시 생성해서는 안 됩니다. |
| 406 | ft.InvalidDuration | 보존 문자열 형식 또는 현재 버전에서 허용되는 단계와 불일치 | 유효하지 않은 duration | 정수+d를 사용하고 버전별 선택 가능한 기간을 확인하세요. |
| 406 | ft.InvalidDurationRange | 표준/장기 보존이 범위를 초과하거나 장기 보존이 표준 기간보다 크지 않음 | 유효한 데이터 보존 기간 범위를 초과했습니다 | 두 기간과 현재 워크스페이스 기능을 확인하세요. |
| 400 | ft.InvalidActionForbiddenChange | 버전 또는 로그 스토리지 유형에서 장기 정책 활성화를 허용하지 않음 | 인덱스 병합 상태 스위치 변경 금지 | 지원되는 버전과 scopedb 로그에서만 활성화하세요. |
| 406 | ft.CurrentVersionUnsupportRp | 현재 버전은 스토리지 정책 변경을 지원하지 않음 | 현재 버전은 rp:{}를 지원하지 않습니다 |
관리자가 워크스페이스 버전 기능을 확인하도록 하세요. |
| 404 | ft.MissingVolctlsHotRetention | TLS setting에 0이 아닌 hot_retention이 없음 | Volcengine 스토리지, 표준 스토리지(핫 스토리지) 필드 누락 | 핫 스토리지 시간 수와 필요한 콜드/아카이브 필드를 완전히 제공하세요. |
| 400 | ft.InvalidHotRetention | TLS 핫 기간이 정수 일수에 해당하는 시간 수가 아님 | Volcengine 스토리지, 유효하지 않은 핫 데이터 스토리지 기간, 정수 일수에 해당하는 시간 수여야 합니다 | 일수×24를 사용하세요. |
| 400 | ft.InvalidRetention | TLS 특정 단계 기간이 범위를 초과함 | Volcengine 스토리지, 유효하지 않은 {} 스토리지 기간, 범위 {}일 | 이 페이지의 콜드/아카이브 범위에 따라 시간 수를 입력하세요. |
| 400 | ft.InvalidRetentionFullDayhours | 콜드/아카이브가 정수 일수에 해당하는 시간 수가 아님 | Volcengine 스토리지, 유효하지 않은 {} 스토리지 기간, 정수 일수에 해당하는 시간 수여야 합니다 | 24의 정수 배수를 사용하세요. |
| 400 | ft.InvalidColdRententionHot | 콜드 스토리지가 있을 때 핫 단계가 7일 미만 | 스토리지 엔진에 저빈도 스토리지가 있을 때 표준 스토리지는 {}일 이상이어야 합니다 | 핫 단계는 최소 168시간입니다. |
| 400 | ft.InvalidArchiveRententionHot | 아카이브가 있을 때 핫 단계가 30일 미만 | 스토리지 엔진에 아카이브 스토리지가 있을 때 표준 스토리지는 {}일 이상이어야 합니다 | 핫 단계는 최소 720시간입니다. |
| 400 | ft.InvalidAllRetention | TLS 총 보존 기간이 허용 범위를 초과함 | Volcengine 스토리지, 유효하지 않은 총 스토리지 기간, 범위 {}일 | 합계가 1800일(43200시간)을 초과하지 않아야 합니다. |
| 406 | ft.InvalidParameter | 고급 노드 유형, 구조, 값 배열 또는 논리 관계 오류 | 파라미터 {}가 유효하지 않습니다 |
group/rule 구조를 사용하세요. 존재 계열 이외의 value 배열은 비어 있지 않아야 합니다. |
| 406 | ft.InvalidOperationSymbol | 필터 연산자가 지원되지 않음 | 유효하지 않은 연산자 {} |
basic/advanced에 해당하는 연산을 선택하세요. |
| 400 | ft.SpecialCharactersExist | 필드 이름 또는 정규식에 허용되지 않는 백틱이 있음 | 연산자 왼쪽에 특수 문자가 있습니다 | 실제 필드 또는 정규식 값을 전달하고 인위적으로 백틱을 추가하지 마세요. |
| 406 | ft.UnsupportRuleType | basic 조건에서 operation=match/not match 사용 | 지원되지 않는 규칙 유형: {} |
지원되는 basic 조건을 사용하거나 advanced로 전환하세요. |
| 400 | ft.InvalidLogIndexCfgKeyFields | extendFields가 배열이 아니거나, 항목에 tag가 없거나 tag/alias 외 키가 포함됨 | 잘못된 로그 인덱스 핵심 필드 | 이 페이지의 tag/alias 구조를 사용하세요. |
| 404 | ft.LogIndexCfgNoExists | 현재 워크스페이스 구성이 존재하지 않거나 삭제됨 | 지정된 로그 인덱스 구성이 존재하지 않습니다 | 목록에서 유효한 UUID를 다시 가져오세요. |
| 400 | ft.LogIndexCloneRelationInvalid | 클론과 원본 관계가 유효하지 않거나 동시에 변경됨 | 로그 인덱스 클론 관계가 유효하지 않습니다 | A/B 구성을 새로 고친 후 다시 작업하세요. |
| 400 | ft.LogIndexCloneSourceUnsupported | 원본 상태 또는 유형이 더 이상 클론 요구 사항을 충족하지 않음 | 지정된 로그 인덱스는 클론 원본으로 지원되지 않습니다 | 원본이 기본이 아니고 직접 쓰기가 아니며 외부 스토리지에 바인딩되지 않은 일반 내부 인덱스인지 확인하세요. |
| 403 | ft.Forbidden | 권한 부족 또는 현재 버전에서 해당 API를 허용하지 않음 | 작업 권한이 없습니다 | 해당 인덱스 권한이 있는 API Key와 지원 버전을 사용하세요. |