인덱스 조회 API

인덱스 조회 API (Get Index API)

1.0부터 도입되었어요.

인덱스 조회(Get index) API 작업은 하나 이상의 인덱스에 대한 정보를 반환하는데, 설정, 매핑, 별칭을 포함해요.

출처: 문서

본문

엔드포인트

GET /{index}

경로 파라미터

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

파라미터	필수	데이터 타입	설명
`index`	필수	String	가져올 인덱스의 이름이에요. 단일 인덱스, 쉼표로 구분된 인덱스 목록, 또는 와일드카드 표현식을 지정할 수 있어요. 클러스터의 모든 인덱스 정보를 가져오려면 `_all` 또는 `*`을 사용해요.

쿼리 파라미터

사용할 수 있는 쿼리 파라미터는 아래 표와 같아요. 모든 쿼리 파라미터는 선택사항이에요.

파라미터	데이터 타입	설명	기본값
`allow_no_indices`	Boolean	어떤 인덱스와도 일치하지 않는 와일드카드를 무시할지 여부를 지정해요. `false`이면 와일드카드가 어떤 인덱스와도 일치하지 않을 때 오류를 반환해요.	`true`
`expand_wildcards`	String	와일드카드 표현식이 확장될 수 있는 인덱스 유형을 지정해요. 쉼표로 구분된 값을 지원해요. 유효한 값은 다음과 같아요: `all`(숨은 인덱스를 포함한 모든 인덱스), `open`(열린 인덱스), `closed`(닫힌 인덱스), `hidden`(숨은 인덱스 — `open`, `closed`, 또는 둘 다와 함께 사용해야 해요), `none`(와일드카드 표현식을 받지 않음).	`open`
`flat_settings`	Boolean	설정을 평평한 형식으로 반환할지 여부를 지정해요. `true`면 설정이 평평한 형태로 반환되고(예: `"index.creation_date": "123456789"`), `false`면 중첩된 형태로 반환돼요(예: `"index": {"creation_date": "123456789"}`).	`false`
`include_defaults`	Boolean	응답에 기본 설정을 포함할지 여부를 지정해요. `true`면 모든 설정의 기본값이 포함되어 손쉽게 갱신할 설정 이름과 값을 파악할 수 있어요.	`false`
`ignore_unavailable`	Boolean	사용할 수 없는(누락되었거나 닫힌) 인덱스를 무시할지 지정해요. `true`면 누락되거나 닫힌 인덱스가 응답에 포함되지 않아요.	`false`
`local`	Boolean	클러스터 매니저 노드 대신 로컬 노드에서만 정보를 가져올지 지정해요.	`false`
`cluster_manager_timeout`	String	클러스터 매니저 노드에 연결될 때까지 기다리는 시간이에요.	`30s`

요청 예시

다음 예제는 books 인덱스의 정보를 가져와요:

GET /books

응답 예시

OpenSearch는 요청한 인덱스의 정보를 반환해요:

{
  "books": {
    "aliases": {},
    "mappings": {},
    "settings": {
      "index": {
        "replication": {
          "type": "DOCUMENT"
        },
        "number_of_shards": "2",
        "provided_name": "books",
        "creation_date": "1778255937147",
        "number_of_replicas": "1",
        "uuid": "Onnd4TKBQMODrfvAvNXjAg",
        "version": {
          "created": "137277827"
        }
      }
    }
  }
}

flat_settings=true 쿼리 파라미터를 사용하면 설정이 평평한 형식으로 반환돼요:

{
  "books": {
    "aliases": {},
    "mappings": {},
    "settings": {
      "index.creation_date": "1778255937147",
      "index.number_of_replicas": "1",
      "index.number_of_shards": "2",
      "index.provided_name": "books",
      "index.replication.type": "DOCUMENT",
      "index.uuid": "Onnd4TKBQMODrfvAvNXjAg",
      "index.version.created": "137277827"
    }
  }
}

응답 본문 필드

응답에는 각 인덱스마다 별도의 객체가 포함되는데, 키가 인덱스 이름이에요. 각 인덱스 객체에는 다음 필드가 있어요.

필드	데이터 타입	설명
`aliases`	Object	인덱스와 연결된 인덱스 별칭이에요. 각 키는 별칭 이름이고 각 값은 별칭 구성 객체예요. 자세한 내용은 Index aliases를 참고해요.
`mappings`	Object	인덱스에 있는 문서의 필드 매핑이에요. 각 필드의 데이터 타입과 속성을 정의해요. 자세한 내용은 Mappings를 참고해요.
`settings`	Object	샤드와 복제본 수 등 인덱스 동작을 제어하는 인덱스 설정이에요. 자세한 내용은 Index settings를 참고해요.

필요한 권한

보안 플러그인을 사용한다면 다음 권한이 필요해요: indices:admin/get.

더 알아보기 (Learn more)

OpenSearch 공식 문서