콘텐츠로 이동

인덱스 정보 조회



GET /api/v1/log_index_cfg/{cfg_uuid}/get

개요

현재 워크스페이스의 특정 로그 인덱스 설정을 조회하며, 필드 매핑 반환 여부를 선택할 수 있습니다.

호출 전 및 사용 단계

로그 인덱스 목록에서 현재 워크스페이스의 인덱스 UUID를 가져오며, 기본 인덱스는 default를 사용합니다. 바인딩된 스토리지의 연결 설정은 필요할 때만 읽습니다. accessCfg에는 액세스 자격 증명 또는 가역 인코딩된 콘텐츠가 포함될 수 있으므로 자격 증명에 준하여 보호해야 합니다. 예시에는 자주 사용하는 필드만 발췌했습니다. 호출 자격 증명에는 log.indexManage 또는 log.externalIndexManage 권한이 필요합니다.

경로 파라미터

파라미터명 타입 필수 설명
cfg_uuid string Y 대상 로그 인덱스 설정 UUID이며 default를 입력할 수도 있습니다.
예: default
조회 또는 입력 방법: 로그 인덱스 목록의 content[].uuid 또는 페이지네이션된 content.data[].uuid에서 가져오며, 현재 워크스페이스의 인덱스만 사용합니다.

요청 헤더

파라미터명 타입 필수 설명
DF-API-KEY string Y 워크스페이스 호출 자격 증명입니다. 레코드 UUID와 호출 자격 증명은 서로 다른 필드입니다.
예: <DF-API-KEY>
조회 또는 입력 방법: 현재 워크스페이스의 API Key 관리에서 전체 자격 증명을 가져옵니다.

Query 요청 파라미터

파라미터명 타입 필수 설명
isShowAccessCfg boolean accessCfg 반환 여부이며 기본값은 false입니다.
예: false
조회 또는 입력 방법: 연결 설정이 실제로 필요할 때만 true를 전달합니다.
isShowFields boolean 필드 매핑 반환 여부이며 기본값은 false입니다.
예: true
조회 또는 입력 방법: 쿼리 가능한 필드의 매핑을 확인해야 할 때 true를 전달합니다.

파라미터 추가 설명

예시의 리소스 식별자는 자리 표시자이므로 대상 워크스페이스의 실제 값으로 바꾸십시오.

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  'https://openapi.guance.com/api/v1/log_index_cfg/default/get' \
  --data-urlencode "isShowFields=true"

응답

HTTP 200, application/json.

필드 타입 설명
content.uuid string 인덱스 설정 식별자입니다. 일반 행은 인덱스 상세 정보를 가져오는 데 사용되며, 기본 인덱스는 default를 사용합니다.
content.name string 로그 인덱스 이름입니다.
content.workspaceUUID string 인덱스가 속한 워크스페이스입니다.
content.duration string 로그 보존 기간(예: 14d)입니다. 외부 스토리지에 바인딩된 인덱스는 비어 있을 수 있습니다.
content.isBindCustomStore integer 또는 boolean 외부 스토리지에 바인딩된 경우 1, 일반 관리형 인덱스는 0입니다. 기본 행은 false를 반환할 수 있습니다.
content.queryType string 인덱스에서 지원할 수 있는 쿼리 유형입니다.
content.directIndex integer 일반 인덱스의 네이티브 직접 쓰기 플래그이며, 1은 예, 0은 아니요를 나타냅니다. 기본 인덱스에서는 생략할 수 있습니다.
content.sortNo string 또는 integer 인덱스 설정에서 정렬에 사용되는 값입니다. 기본 인덱스는 -1일 수 있습니다.
content.storeType string 인덱스와 연결된 스토리지 유형입니다. 기본 인덱스에서는 생략할 수 있습니다.
content.accessCfg object isShowAccessCfg=true인 경우에만 반환됩니다. 스토리지 액세스 자격 증명이 포함될 수 있습니다.
content.fields array<object> isShowFields=true인 경우에만 반환되는 매핑 목록입니다. 기본 인덱스에는 필드가 없을 수 있습니다.
content.fields[].field string 쿼리에 사용되는 필드 이름입니다.
content.fields[].originalField string 소스 스토리지의 필드 이름입니다.
content.cloneConfig object 또는 null 클론 인덱스의 설정입니다. 일반 인덱스는 비어 있을 수 있습니다.
content.sourceIndexName string 클론 인덱스와 연결된 소스 인덱스 이름입니다.
content.regionInfo object 스토리지 리전 또는 권한 부여 정보입니다. 기본 인덱스는 {}입니다.
content.declaration object 또는 null 워크스페이스 선언입니다.
{
  "code": 200,
  "content": {
    "uuid": "default",
    "name": "default",
    "workspaceUUID": "wksp_example",
    "duration": "14d",
    "isBindCustomStore": false,
    "queryType": "logging",
    "sortNo": -1,
    "declaration": null,
    "regionInfo": {},
    "fields": []
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 파라미터를 전달했거나 파라미터 값이 검증을 통과하지 못함 파라미터 검증에 실패했으며, 메시지에서 유효하지 않은 필드를 알려줍니다. 각 필드의 위치와 선택 가능한 값을 확인합니다.
404 ft.LogIndexCfgNoExists 설정이 이 워크스페이스에 속하지 않거나, 삭제되었거나, 존재하지 않거나, 클론 인덱스의 소스를 더 이상 사용할 수 없음 지정한 로그 인덱스 설정이 존재하지 않습니다. 같은 워크스페이스의 목록에서 인덱스 식별자를 다시 가져오고, 클론 소스가 여전히 존재하는지 확인합니다.

문서 평가

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