필드 매핑 조회 API

필드 매핑 조회 API (Get Field Mapping API)

1.0부터 도입되었어요.

필드 매핑 조회(Get Field Mapping) API는 하나 이상의 특정 필드에 대한 매핑 정의를 가져와요. 특히 필드가 많은 인덱스라면 전체 인덱스 매핑을 가져오지 않고 특정 필드가 어떻게 설정되어 있는지만 확인할 때 유용하죠.

출처: 문서

본문

엔드포인트

GET /_mapping/field/{field}
GET /{index}/_mapping/field/{field}

경로 파라미터

사용할 수 있는 경로 파라미터는 아래 표와 같아요.

파라미터 필수/선택 데이터 타입 설명
index 선택 String 인덱스 이름 또는 와일드카드 표현식의 쉼표로 구분된 목록이에요. _all을 사용하거나 생략하면 모든 인덱스를 대상으로 해요.
field 필수 String 필드 이름 또는 와일드카드 표현식의 쉼표로 구분된 목록이에요. 중첩 필드는 점 표기법을 사용해요 (예: author.name).

쿼리 파라미터

사용할 수 있는 쿼리 파라미터는 아래 표와 같아요.

파라미터 필수/선택 데이터 타입 설명
include_defaults 선택 Boolean true로 설정하면 응답에 보통 생략되는 기본 매핑 파라미터 값도 포함돼요. 기본값은 false예요.
allow_no_indices 선택 Boolean true로 설정하면 와일드카드 표현식이나 _all이 어떤 인덱스로도 해석되지 않을 때 오류를 반환하지 않아요. 기본값은 true예요.
expand_wildcards 선택 String 와일드카드 표현식이 어떤 인덱스 유형으로 확장될지를 제어해요. 유효한 값은 open, closed, hidden, none, all이에요. 기본값은 open이에요.
ignore_unavailable 선택 Boolean true로 설정하면 누락되거나 닫힌 인덱스는 오류를 반환하는 대신 무시돼요. 기본값은 false예요.

요청 예시

다음 요청은 customer_gender 필드의 매핑을 가져와요:

GET /opensearch_dashboards_sample_data_ecommerce/_mapping/field/customer_gender

응답 예시

응답에는 필드의 전체 이름과 매핑 구성이 포함돼요:

{
  "opensearch_dashboards_sample_data_ecommerce" : {
    "mappings" : {
      "customer_gender" : {
        "full_name" : "customer_gender",
        "mapping" : {
          "customer_gender" : {
            "type" : "keyword"
          }
        }
      }
    }
  }
}

응답 본문 필드

응답 본문 필드는 아래 표와 같아요.

필드 데이터 타입 설명
{index}.mappings Object 지정된 인덱스의 필드 이름과 매핑 상세 정보의 매핑(map)이에요.
{field}.full_name String 상위 객체 경로를 포함한 완전한 필드 이름이에요.
{field}.mapping Object 타입과 각종 파라미터를 포함한 필드의 매핑 구성이에요.

더 알아보기 (Learn more)