워크스페이스 데이터 보존 기간 수정¶
POST /api/v1/workspace/modify_rp_duration
개요¶
현재 워크스페이스의 각 카테고리 표준 보존 기간과 지원되는 장기 스토리지 정책을 조정합니다.
호출 전 및 사용 단계¶
workspace.ilmManage 권한이 필요합니다. 먼저 현재 워크스페이스 상세에서 versionType, billingState, durationSet, storagePolicy, esIndexMerged, datastore를 읽어 현재 사이트의 허용 범위를 확인한 후 변경할 카테고리를 제출합니다. free/freeEdition은 작업할 수 없으며, 미납/만료 상태는 거부됩니다. 보존 기간을 단축하면 이후 조회 가능한 이력 범위에 영향을 주며, 정리된 데이터를 복구할 수 있다는 의미가 아닙니다.
필드는 실제 인덱스 모드에 따라 필터링됩니다. 병합 모드는 apm, 분할 모드는 tracing/rum/profiling/security를 사용합니다. 적용되지 않는 모드의 필드는 오류 대신 무시될 수 있으므로 반드시 반환된 변경 요약을 확인하고 다시 읽어야 합니다. lineage는 Doris/ScopeDB만 지원하며 표준 기간만 있습니다. 이 페이지는 session_replay를 지원하지 않으며 다른 진입점의 필드를 반환하지 않습니다.
장기 총 기간은 표준 기간보다 커야 합니다. 로그는 scopedb만 지원하며 pay/enterprise/unlimited에서 지원됩니다. 메트릭은 pay와 청구 센터가 활성화된 unlimited에서 metric_point_total이 필요하며, 다른 버전에서도 timeseries를 명시하면 거부됩니다. unlimited는 장기 유형으로 rp/logging만 허용합니다. 표준 기간을 변경하기 전에 기존 장기 기간이 새 표준 기간보다 여전히 큰지 먼저 확인해야 합니다. 서버는 일부 레거시 정책에 대해 호환성을 위해 유지하며, storagePolicy를 전달하지 않을 때 성공 응답만으로 두 구성이 적절하다고 증명할 수 없습니다. 정책 카테고리를 생략하면 유지되고, 카테고리 {}를 제출하거나 longStorageEnabled를 생략하면 비활성화로 정규화됩니다.
데이터베이스와 메트릭/로그/lineage 다운스트림은 단계적으로 업데이트되며, 데이터베이스 커밋 후 오류가 발생할 수 있습니다. 일부 비 guancedb 메트릭 알림에는 내결함성이 있어 HTTP 성공도 모든 다운스트림이 이미 적용되었음을 증명하지 않습니다. 다시 읽어 확인한 후 완료되지 않은 동기화만 처리하십시오. lineage 실패는 보상 알림으로 이어질 수 있으므로 무작정 반복 수정하지 마십시오. 성공 content에는 실제 변경만 나열되며, 변경이 없으면 {}일 수 있습니다. 빈 요약으로 제출된 모든 필드가 이미 적용되었다고 추론하지 마십시오.
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| storagePolicy.rp | json | 메트릭 정책 객체입니다. 카테고리 생략/해당 카테고리 null은 변경하지 않습니다. 카테고리 {}는 비활성화로 정규화되며 기존 장기 정책을 비활성화할 수 있습니다. 유지하려면 전체 카테고리 객체를 생략해야 합니다. 예: {"longStorageEnabled": false}획득 또는 입력 방법: 현재 storagePolicy.rp에서 전체 구성을 읽습니다. |
|
| storagePolicy.rp.longStorageEnabled | boolean | 선택 사항이며 JSON 불리언 사용을 권장합니다. 카테고리 객체가 있을 때 생략하면 기본값은 false입니다. lineage는 false/생략만 가능하며, 그 외는 거부됩니다. 예: false획득 또는 입력 방법: 장기 보존이 필요하면 true, 명시적으로 비활성화하려면 false를 선택합니다. |
|
| storagePolicy.rp.longStorageDuration | string | 활성화 시 조건부 필수이며, 비활성화 시 빈 문자열로 정규화됩니다. pay 메트릭 기본값은 90d/120d/180d/360d/540d/720d이고, 로그 기본값은 90d/120d/180d/360d입니다. enterprise/unlimited 로그 기본값은 1d~1800d, 메트릭은 1d~3600d이며 사이트에서 재정의할 수 있습니다. lineage는 빈 값/생략만 가능합니다. 예: 180d획득 또는 입력 방법: 사이트에서 허용된 장기 보존 기간 옵션 중에서 선택하고 표준 기간보다 큰지 확인합니다. |
|
| storagePolicy.logging | json | 로그 정책 객체입니다. 카테고리 생략/해당 카테고리 null은 변경하지 않습니다. 카테고리 {}는 비활성화로 정규화되며 기존 장기 정책을 비활성화할 수 있습니다. 유지하려면 전체 카테고리 객체를 생략해야 합니다. 예: {"longStorageEnabled": false}획득 또는 입력 방법: 현재 storagePolicy.logging에서 전체 구성을 읽습니다. |
|
| storagePolicy.logging.longStorageEnabled | boolean | 선택 사항이며 JSON 불리언 사용을 권장합니다. 카테고리 객체가 있을 때 생략하면 기본값은 false입니다. lineage는 false/생략만 가능하며, 그 외는 거부됩니다. 예: false획득 또는 입력 방법: 장기 보존이 필요하면 true, 명시적으로 비활성화하려면 false를 선택합니다. |
|
| storagePolicy.logging.longStorageDuration | string | 활성화 시 조건부 필수이며, 비활성화 시 빈 문자열로 정규화됩니다. pay 메트릭 기본값은 90d/120d/180d/360d/540d/720d이고, 로그 기본값은 90d/120d/180d/360d입니다. enterprise/unlimited 로그 기본값은 1d~1800d, 메트릭은 1d~3600d이며 사이트에서 재정의할 수 있습니다. lineage는 빈 값/생략만 가능합니다. 예: 180d획득 또는 입력 방법: 사이트에서 허용된 장기 보존 기간 옵션 중에서 선택하고 표준 기간보다 큰지 확인합니다. |
|
| storagePolicy.lineage | json | 데이터 관측 가능성 정책 객체입니다. 카테고리 생략/해당 카테고리 null은 변경하지 않습니다. 카테고리 {}는 비활성화로 정규화되며 기존 장기 정책을 비활성화할 수 있습니다. 유지하려면 전체 카테고리 객체를 생략해야 합니다. 예: {"longStorageEnabled": false}획득 또는 입력 방법: 현재 storagePolicy.lineage에서 전체 구성을 읽습니다. |
|
| storagePolicy.lineage.longStorageEnabled | boolean | 선택 사항이며 JSON 불리언 사용을 권장합니다. 카테고리 객체가 있을 때 생략하면 기본값은 false입니다. lineage는 false/생략만 가능하며, 그 외는 거부됩니다. 예: false획득 또는 입력 방법: lineage는 false 또는 생략만 입력하며 장기 보존을 지원하지 않습니다. |
|
| storagePolicy.lineage.longStorageDuration | string | 활성화 시 조건부 필수이며, 비활성화 시 빈 문자열로 정규화됩니다. pay 메트릭 기본값은 90d/120d/180d/360d/540d/720d이고, 로그 기본값은 90d/120d/180d/360d입니다. enterprise/unlimited 로그 기본값은 1d~1800d, 메트릭은 1d~3600d이며 사이트에서 재정의할 수 있습니다. lineage는 빈 값/생략만 가능합니다. 예: 획득 또는 입력 방법: lineage는 빈 문자열 또는 생략만 입력하며 장기 보존 기간 옵션을 선택하지 않습니다. |
|
| apm | string | 병합 인덱스 APM 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). 병합 인덱스 모드에서만 적용되며, 분할 모드에서는 무시될 수 있습니다. null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.apm, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| backup_log | string | 백업 로그 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 180d/360d/720d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). null 허용: False 예: 180d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.backup_log, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| dialtest | string | 신서틱 테스트 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.dialtest, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| keyevent | string | 이벤트 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 14d/30d/60d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). null 허용: False 예: 14d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.keyevent, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| lineage | string | 데이터 관측 가능성 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). 실제 lineage가 Doris/ScopeDB인 경우에만 사용할 수 있으며 장기 스토리지를 구성하지 않습니다. null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.lineage, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| logging | string | 기본 로그 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.logging, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| profiling | string | 프로파일링 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). 분할 인덱스 모드에서만 적용되며, 병합 모드에서는 무시될 수 있습니다. null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.profiling, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| rp | string | 메트릭 시계열 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d/180d/360d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~3600d). null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.rp, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| rum | string | 실제 사용자 모니터링(RUM) 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). 분할 인덱스 모드에서만 적용되며, 병합 모드에서는 무시될 수 있습니다. null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.rum, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| security | string | 보안 데이터 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 90d/180d/360d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). 분할 인덱스 모드에서만 적용되며, 병합 모드에서는 무시될 수 있습니다. null 허용: False 예: 90d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.security, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
|
| storagePolicy | json | 선택 객체이며 제출된 카테고리만 병합합니다. 생략/{}는 기존 정책을 유지합니다. null은 허용되지 않습니다. 장기 기간은 총 보존 기간이며 표준 기간과 합산되지 않습니다. 활성화 시 이번 요청의 해당 표준 기간보다 반드시 커야 합니다. 문서에 나열된 rp/logging만 장기 활성화에 사용되며, lineage는 호환 목적의 비활성화만 지원합니다. null 허용: False 예: {"rp": {"longStorageEnabled": true, "longStorageDuration": "180d"}}획득 또는 입력 방법: 현재 워크스페이스의 content.storagePolicy에서 대상 카테고리의 전체 정책을 읽습니다. |
|
| tracing | string | 애플리케이션 트레이스 표준 보존 기간입니다. 선택 사항이며, 생략하면 유지되고 null은 허용되지 않습니다. 소문자 일수 d; pay 코드 기본값으로 선택 가능: 3d/7d/14d/30d/60d/90d; enterprise/unlimited 허용 범위는 사이트 기준입니다(unlimited 코드 기본값 1d~1800d). 분할 인덱스 모드에서만 적용되며, 병합 모드에서는 무시될 수 있습니다. null 허용: False 예: 3d획득 또는 입력 방법: 현재 워크스페이스의 content.durationSet.tracing, esIndexMerged 및 datastore에서 현재 값을 가져와 현재 버전/엔진에서 허용된 옵션에 따라 선택합니다. |
매개변수 추가 설명¶
현재 워크스페이스가 지원하는 모드의 스토리지 카테고리만 업데이트합니다. 표준 기간은 durationSet이며, 장기 기간은 총 보존 기간으로 표준 기간과 단순 합산할 수 없습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/modify_rp_duration' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"logging":"14d"}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 변경된 데이터 유형의 요약만 포함합니다. 변경이 없으면 {}일 수 있으며, 항상 전체 durationSet을 반환하지는 않습니다. |
| content.데이터 유형 | object | 예: rp/logging/lineage, 실제 변경된 각 카테고리입니다. |
| content.데이터 유형.old | string 또는 null | 이전 표준 보존 기간이며, 표준 기간이 변경된 경우에만 나타납니다. |
| content.데이터 유형.new | string | 새 표준 보존 기간이며, 표준 기간이 변경된 경우에만 나타납니다. |
| content.데이터 유형.oldStoragePolicy | object | 이전 장기 정책이며, 정책이 변경된 경우에만 나타납니다. 미구성 시 {}일 수 있습니다. |
| content.데이터 유형.oldStoragePolicy.longStorageEnabled | boolean | 이전 장기 활성화 스위치이며 생략될 수 있습니다. |
| content.데이터 유형.oldStoragePolicy.longStorageDuration | string | 이전 장기 총 기간이며 비어 있거나 생략될 수 있습니다. |
| content.데이터 유형.newStoragePolicy | object | 새 장기 정책이며 변경 시에만 나타납니다. lineage의 중립 정책은 {}일 수 있습니다. |
| content.데이터 유형.newStoragePolicy.longStorageEnabled | boolean | 새 장기 활성화 스위치입니다. |
| content.데이터 유형.newStoragePolicy.longStorageDuration | string | 새 장기 총 기간이며 비활성화 시 비어 있습니다. |
| content.declaration | object 또는 null | 비어 있지 않은 변경 객체에는 공통 선언이 추가됩니다. content={}일 때는 삽입되지 않습니다. |
{
"code": 200,
"content": {
"logging": {
"old": "7d",
"new": "14d"
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
메트릭 장기 스토리지 과금 방식을 조회할 때 청구 센터 업스트림의 명확한 4xx는 실제 HTTP 및 ft.CloudCareApiError를 유지할 수 있으며, message는 업스트림 안내를 따릅니다. 일반 5xx/시간 초과는 최종적으로 500 ft.InternalServerError로 통합됩니다. 먼저 보존 기간과 장기 정책을 다시 읽고 과금 조회 상태를 확인하십시오. 무작정 반복 수정하지 마십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건을 위반함 | 매개변수 파싱 실패 | 매개변수 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 이 페이지의 매개변수에 따라 JSON 객체를 제출합니다. |
| 400 | ft.FreeWKSPLimit | 현재 워크스페이스 버전 free/freeEdition | 유효하지 않은 작업, 현재 워크스페이스는 무료 플랜입니다 | 보존 정책 편집을 지원하는 버전으로 업그레이드한 후 작업합니다. |
| 400 | ft.WKSPStatusAbnormal | 워크스페이스 billingState가 arrearage/expired | 워크스페이스 미납 또는 만료 | 먼저 청구/만료 상태를 처리합니다. |
| 406 | ft.CurrentVersionUnsupportRp | 편집 지원 버전이 아니거나 현재 사이트에 해당 옵션이 없음 | 현재 버전은 rp:{}를 지원하지 않습니다 |
관리자가 버전과 구성을 확인합니다. |
| 400 | ft.IllegalDataKeepTime | pay 표준 기간이 유효하지 않거나 lineage 새 표준 기간이 유효하지 않음 | 유효하지 않은 데이터 보존 기간 | 현재 사이트에서 허용된 기간을 선택하고 소문자 일수 d를 확인합니다. |
| 406 | ft.InvalidDuration | 표준/장기 형식 또는 장기 고정 옵션이 유효하지 않음 | 유효하지 않은 duration | 양의 정수 일수에 d를 붙이고 현재 버전에서 허용된 옵션을 사용합니다. |
| 406 | ft.InvalidDurationRange | 사용자 지정 표준 또는 장기 범위가 유효하지 않거나 장기 기간이 표준 기간보다 크지 않음 | 유효한 데이터 보존 기간 범위를 벗어남 | 버전 범위를 확인하고 장기 기간은 표준 기간보다 반드시 커야 합니다. |
| 400 | ft.JsonFormatError | storagePolicy 또는 카테고리 정책이 객체가 아님 | 일부 json 파일 형식 오류 | 이 페이지의 정책 객체 구조를 사용합니다. |
| 400 | ft.InvalidActionForbiddenChange | 장기 정책의 버전/엔진/메트릭 과금 유형이 지원되지 않음 | 인덱스 병합 상태 스위치 변경 금지 | 로그 scopedb 및 메트릭 과금 유형을 확인한 후 활성화합니다. |
| 404 | ft.NamespaceDatastoreNotFound | lineage를 요청했지만 현재 워크스페이스에 유효한 Doris/ScopeDB lineage 엔진이 없음 | {}의 스토리지 유형을 찾을 수 없음 | 실제 데이터 엔진 지원 여부를 확인합니다. |
| 404 | ft.ForbiddenIndexCfg | lineage에 중립이 아닌 장기 정책을 제출함 | sls/beaver 스토리지 유형의 인덱스 구성을 지원하지 않음 | lineage는 표준 보존 기간만 사용하고 장기 보존을 활성화하지 않습니다. |
| 429 | ft.OperationTooFrequently | 스토리지 상호 배제가 바쁘거나 실행 중 잠금을 잃음 | 작업이 너무 빈번합니다. 잠시 후 다시 시도하십시오 | 백오프하고 먼저 보존 기간과 실제 동기화 상태를 다시 읽은 후 처리하십시오. 동시에 덮어쓰지 마십시오. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시/큐, 다운스트림 일반 5xx/시간 초과 또는 처리되지 않은 유형의 실패. 쓰기가 이미 커밋되었을 수 있음 | 내부 오류 | 먼저 현재/대상 워크스페이스 상세와 다운스트림 상태에서 저장된 결과를 확인하십시오. 무작정 반복 생성/교체하지 마십시오. 이미 저장된 경우 완료되지 않은 동기화만 처리하고 traceId를 제공하십시오. |
| 406 | ft.InvalidBossNode | 메트릭 장기 보존을 활성화하려면 청구 센터 과금 방식을 조회해야 하지만 브랜드/청구 센터 노드가 구성되지 않음 | 유효하지 않은 Boss 노드 | 관리자가 브랜드 및 청구 센터 노드를 확인하도록 하십시오. 먼저 현재 보존 기간과 스토리지 정책을 다시 읽은 후 재시도 여부를 결정하십시오. |