인덱스 해석 API

인덱스 해석 API (Resolve Index API)

1.0부터 도입되었어요.

인덱스 해석(Resolve Index) API는 OpenSearch가 지정된 이름이나 와일드카드 표현식과 일치하는 별칭, 데이터 스트림, 실제 인덱스(concrete index)를 어떻게 해석하는지 이해하는 데 도움을 줘요.

출처: 문서

GET /_resolve/index/{name}

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

파라미터	데이터 타입	설명
`name`	String	해석할 이름, 별칭, 데이터 스트림, 또는 와일드카드 표현식이에요.

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

파라미터	데이터 타입	설명
`expand_wildcards`	String	와일드카드 표현식이 일치하는 인덱스로 어떻게 확장되는지 제어해요. 여러 값을 쉼표로 결합할 수 있어요. 유효한 값은 `all`(숨은 인덱스를 포함한 열린·닫힌 인덱스로 확장), `open`(열린 인덱스로만 확장), `closed`(닫힌 인덱스로만 확장), `hidden`(숨은 인덱스 포함 — `open`, `closed`, 또는 둘 다와 함께 사용해야 해요), `none`(와일드카드 표현식을 받지 않음)이에요. 기본값: `open`.

다음 섹션들은 Resolve API 요청 예시를 제공해요.

GET /_resolve/index/my-index-001

GET /_resolve/index/my-index-*

logs-app이라는 이름의 별칭이나 데이터 스트림이 있으면 다음 요청으로 해석해요:

GET /_resolve/index/logs-app

다음 예제는 와일드카드, 원격 클러스터, 그리고 hidden으로 설정된 expand_wildcards를 사용한 API 요청을 보여줘요:

GET /_resolve/index/my-index-*,remote-cluster:my-index-*?expand_wildcards=hidden

{
  "indices": [
    {
      "name": "my-index-001",
      "attributes": [
        "open"
      ]
    }
  ],
  "aliases": [],
  "data_streams": []
}

필드	데이터 타입	설명
`indices`	Array	해석된 실제 인덱스(concrete index)의 목록이에요.
`aliases`	Array	해석된 인덱스 별칭의 목록이에요.
`data_streams`	Array	일치하는 데이터 스트림의 목록이에요.

보안 플러그인을 사용한다면 이 쿼리들을 실행하는 사용자는 해석된 인덱스에 대해 최소한 read 권한이 필요해요.