인덱스 구성 활성화/비활성화¶
POST /api/v1/log_index_cfg/{cfg_uuid}/set_disable
개요¶
기본이 아닌 단일 로그 인덱스 구성을 활성화하거나 비활성화합니다.
호출 전 확인 사항 및 사용 단계¶
목록에서 인덱스 UUID를 선택합니다. true이면 status=2, false이면 0으로 설정합니다. 인터페이스 선언상 null이 허용되지만 현재 구현에서는 거짓값으로 처리하여 활성화합니다. 호출자는 명확한 불리언 값만 제출해야 합니다. 기본 default는 지원되지 않으며, 존재하지 않거나 삭제된 경우 404를 반환합니다.
복제본 B는 독립적으로 활성화/비활성화할 수 있습니다. B 자체가 활성화되어 있더라도 원본 A가 비활성화된 경우 현재 유효한 트래픽 분기로 간주해서는 안 되며, 원본 상태와 함께 확인해야 합니다. 상태 저장 후 캐시를 지우며 기존 로그를 삭제하지 않고 모든 다운스트림 읽기/쓰기가 즉시 전환됨을 보장하지 않습니다. 원본/복제 관계의 동시 변경이 발생하면 새로 고친 후 다시 시도해야 합니다.
라우트 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| isDisable | boolean | Y | 필수이며 JSON 불리언 사용을 권장합니다. 선언상 null이 허용되지만 현재 null은 활성화로 처리됩니다. null 허용: True 예: true가져오기 또는 입력 방법: true는 비활성화, false는 활성화입니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_example/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며 엔터티 또는 다운스트림 상태를 반환하지 않습니다. |
{
"code": 200,
"content": true,
"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를 제공하세요. 오류를 미저장 상태로 간주하거나 바로 다시 추가할 수 있는 것으로 처리하지 마세요. |
| 400 | ft.DefaultIndexUnsupportAction | 대상이 default인 경우 | 기본 인덱스는 이 작업을 지원하지 않습니다. | 기본 인덱스는 이 활성화/비활성화 진입점을 사용하지 않습니다. |
| 404 | ft.LogIndexCfgNoExists | 지정한 워크스페이스의 삭제되지 않은 인덱스가 존재하지 않음 | 지정한 로그 인덱스 구성이 존재하지 않습니다. | 목록에서 유효한 UUID를 다시 가져오세요. |
| 400 | ft.LogIndexCloneRelationInvalid | 원본/복제 관계가 변경됨 | 로그 인덱스 복제 관계가 유효하지 않습니다. | 연관 구성을 새로 고친 후 다시 시도하세요. |
| 400 | ft.LogIndexCloneSourceUnsupported | 복제 원본이 더 이상 내부 일반 인덱스 조건을 충족하지 않음 | 지정한 로그 인덱스는 복제 원본으로 지원되지 않습니다. | A/B 상태 및 유형을 확인하세요. |
| 403 | ft.Forbidden | 권한이 부족하거나 현재 버전에서 이 인터페이스를 허용하지 않음 | 작업 권한이 없습니다. | 해당 인덱스 권한이 있는 API Key와 지원 버전을 사용하세요. |