List Indices API
List Indices API
2.18에서 도입
list indices 작업은 다음 인덱스 정보를 페이지 단위(paginated) 형식으로 제공해요.
- 인덱스가 사용하는 디스크 공간의 양
- 인덱스에 포함된 샤드 수
- 인덱스의 건강(health) 상태
출처: 문서
본문
엔드포인트 (Endpoints)
GET _list/indices
GET _list/indices/{index}
쿼리 매개변수 (Query parameters)
| 매개변수 | 타입 | 설명 |
|---|---|---|
bytes |
Byte size | 바이트 크기의 단위를 지정해요. 예: 7kb 또는 6gb. 자세한 내용은 지원 단위를 참고해요. |
health |
String | 인덱스를 건강 상태 기준으로 제한해요. 지원 값은 green, yellow, red예요. |
include_unloaded_segments |
Boolean | 메모리에 로드되지 않은 세그먼트의 정보를 포함할지 여부예요. 기본값은 false예요. |
cluster_manager_timeout |
Time | 클러스터 매니저 노드에 연결되기를 기다리는 시간이에요. 기본값은 30s예요. |
pri |
Boolean | 기본(primary) 샤드의 정보만 반환할지 여부예요. 기본값은 false예요. |
time |
Time | 시간 단위를 지정해요. 예: 5d 또는 7h. 자세한 내용은 지원 단위를 참고해요. |
expand_wildcards |
Enum | 와일드카드 표현식을 실제 인덱스로 확장해요. 여러 값을 쉼표로 조합할 수 있어요. 지원 값은 all, open, closed, hidden, none이에요. 기본값은 open이에요. |
next_token |
String | 다음 페이지의 인덱스를 가져와요. null이면 첫 페이지의 인덱스만 제공해요. 기본값은 null이에요. |
size |
Integer | 단일 페이지에 표시할 인덱스의 최대 수예요. 응답의 한 페이지에 있는 인덱스 수는 지정한 size와 항상 같지는 않아요. 기본값은 500이고 최솟값은 1, 최댓값은 5000이에요. |
sort |
String | 인덱스가 표시되는 순서예요. desc면 가장 최근에 생성된 인덱스부터, asc면 가장 오래된 인덱스부터 표시돼요. 기본값은 asc예요. |
next_token 경로 매개변수를 쓸 때는 응답이 만들어낸 토큰을 사용해서 다음 페이지의 인덱스를 볼 수 있어요. API가 null을 반환하면 API에 포함된 모든 인덱스가 반환된 거예요.
예시 요청 (Example requests)
모든 인덱스의 정보를 얻으려면 다음 쿼리를 쓰고, 응답의 next_token이 null이 될 때까지 계속 지정해줘요:
GET _list/indices/{index}?v&next_token=token
정보를 특정 인덱스로 제한하려면 쿼리 뒤에 인덱스 이름을 붙여요:
GET /_list/indices/<index>?v
Python 클라이언트로는 이렇게 호출해요:
response = client.list.indices(
index = "<index>",
params = { "v": "true" }
)
여러 인덱스의 정보를 얻으려면 인덱스를 쉼표로 구분해요:
GET /_list/indices/index1,index2,index3?v&next_token=token
Python 클라이언트로는 이렇게 호출해요:
response = client.list.indices(
index = "index1,index2,index3",
params = { "v": "true", "next_token": "token" }
)
예시 응답 (Example response)
평문(Plain text) 형식
health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
green | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb
next_token MTcyOTE5NTQ5NjM5N3wub3BlbnNlYXJjaC1zYXAtbG9nLXR5cGVzLWNvbmZpZw==
JSON 형식
{
"next_token": "MTcyOTE5NTQ5NjM5N3wub3BlbnNlYXJjaC1zYXAtbG9nLXR5cGVzLWNvbmZpZw==",
"indices": [
{
"health": "green",
"status": "open",
"index": "movies",
"uuid": "UZbpfERBQ1-3GSH2bnM3sg",
"pri": "1",
"rep": "1",
"docs.count": "1",
"docs.deleted": "0",
"store.size": "7.7kb",
"pri.store.size": "3.8kb"
}
]
}