인덱스 별칭 조회 API

인덱스 별칭 조회 API (Get Index Alias API)

1.0 버전에서 도입되었어요. 하나 이상의 별칭에 대한 정보를 반환하는 API예요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_alias
GET /_alias/{alias}
GET /{index}/_alias/{alias}

경로 파라미터 (Path parameters)

아래 표는 사용 가능한 경로 파라미터를 정리한 거예요. 모든 경로 파라미터는 선택 사항이에요.

파라미터	데이터 타입	설명
`<alias>`	String	조회할 별칭 이름의 쉼표로 구분된 목록 또는 와일드카드 표현식. 모든 인덱스 별칭에 대한 정보를 조회하려면 `_all` 또는 `*`를 사용하세요.
`<index>`	String	요청 범위를 제한하는 데 사용하는 인덱스 이름의 쉼표로 구분된 목록 또는 와일드카드 표현식.

쿼리 파라미터 (Query parameters)

아래 표는 사용 가능한 쿼리 파라미터를 정리한 거예요. 모든 쿼리 파라미터는 선택 사항이에요.

파라미터	데이터 타입	설명
`allow_no_indices`	Boolean	어떤 인덱스와도 일치하지 않는 와일드카드를 무시할지 여부. 기본값은 `true`예요.
`expand_wildcards`	String	와일드카드 표현식이 매칭할 수 있는 인덱스 타입. 쉼표로 구분된 값을 지원해요. 유효한 값은 `all`, `open`, `closed`, `hidden`, `none`이에요. 기본값은 `all`이에요.
`ignore_unavailable`	Boolean	사용할 수 없는 인덱스를 무시할지 여부. 기본값은 `false`예요.
`local`	Boolean	클러스터 매니저 노드 대신 로컬 노드에서만 정보를 반환할지 여부. 기본값은 `false`예요.

예제 요청: 인덱스의 모든 별칭 조회 (Get all aliases for an index)

create index API 요청을 사용해 인덱스 생성 중에 인덱스 별칭을 추가할 수 있어요. 다음 create index API 요청은 두 개의 별칭(current_day와 2030)을 가진 logs_20302801 인덱스를 만들어요. 여기서 2030은 logs_20302801 인덱스에서 year 필드 값이 2030인 문서만 반환해요:

PUT /logs_20302801
{
  "aliases": {
    "current_day": {},
    "2030": {
      "filter": {
        "term": {
          "year": 2030
        }
      }
    }
  }
}

다음 get index alias API 요청은 logs_20302801 인덱스의 모든 별칭을 반환해요:

GET /logs_20302801/_alias/*

예제 요청: 특정 별칭 조회 (Get a specific alias)

다음 인덱스 별칭 API 요청은 2030 별칭을 반환해요:

GET /_alias/2030

예제 요청: 와일드카드 기반 별칭 조회 (Get aliases based on a wildcard)

다음 인덱스 별칭 API 요청은 20으로 시작하는 모든 별칭을 반환해요:

GET /_alias/20*

예제 응답 (Example response)

{
 "logs_20302801" : {
   "aliases" : {
    "current_day" : {
    },
     "2030" : {
       "filter" : {
         "term" : {
           "year" : 2030
         }
       }
     }
   }
 }
}

응답 본문 필드 (Response body fields)

아래 표는 응답 본문의 모든 필드를 정리한 거예요.

필드	데이터 타입	설명
`<index>`	Object	인덱스의 별칭을 포함해요.
`<index>.aliases`	Object	인덱스의 별칭 정보를 포함해요.
`<index>.aliases.<alias>`	Object	별칭의 설정을 포함해요.
`<index>.aliases.<alias>.filter`	Object	별칭이 접근할 수 있는 문서를 제한하는 데 사용하는 쿼리.
`<index>.aliases.<alias>.index_routing`	String	인덱싱 작업에 사용되는 라우팅 값.
`<index>.aliases.<alias>.search_routing`	String	검색 작업에 사용되는 라우팅 값.
`<index>.aliases.<alias>.is_write_index`	Boolean	인덱스가 별칭의 쓰기 인덱스인지 여부.

필요한 권한 (Required permissions)

Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: indices:admin/aliases/get

인덱스 별칭에 대한 자세한 내용은 Index aliases 문서를 참고하세요.

인덱스 별칭 조회 API