CAT 할당 API

CAT 할당 API (CAT Allocation API)

1.0 버전에서 도입되었어요. CAT allocation 작업은 인덱스에 대한 디스크 공간 할당과 각 노드의 샤드 수를 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/allocation
GET /_cat/allocation/{node_id}

쿼리 파라미터 (Query parameters)

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

파라미터	데이터 타입	설명	기본값
`bytes`	String	바이트 값을 표시하는 데 사용하는 단위. 유효한 값은 `b`, `kb`, `k`, `mb`, `m`, `gb`, `g`, `tb`, `t`, `pb`, `p`예요.	N/A
`cluster_manager_timeout`	String	클러스터 매니저 노드에 연결하기 위한 타임아웃.	N/A
`format`	String	`json` 또는 `yaml` 같은 HTTP Accept 헤더의 짧은 버전.	N/A
`h`	List	표시할 열 이름의 쉼표로 구분된 목록.	N/A
`help`	Boolean	도움말 정보를 반환해요.	false
`local`	Boolean	로컬 정보를 반환하지만 클러스터 매니저 노드에서 상태를 가져오지 않아요.	false
`s`	List	정렬 기준이 될 열 이름 또는 열 별칭의 쉼표로 구분된 목록.	N/A
`v`	Boolean	열 머리글을 표시하는 자세한(verbose) 모드를 활성화해요.	false

예제 요청 (Example requests)

GET /_cat/allocation?v

정보를 특정 노드로 제한하려면 쿼리 뒤에 노드 이름을 추가하세요:

GET /_cat/allocation/<node_name>

둘 이상의 노드에 대한 정보를 원한다면 노드 이름을 쉼표로 구분하세요:

GET /_cat/allocation/node_name_1,node_name_2,node_name_3

예제 응답 (Example response)

다음 응답은 사용 가능한 두 노드 각각에 8개의 샤드가 할당되어 있음을 보여줘요:

shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent | host         | ip          | node
  8    |   989.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44         | 172.18.0.4   | 172.18.0.4  | odfe-node1
  8    |   962.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44         | 172.18.0.3   | 172.18.0.3  | odfe-node2

필요한 권한 (Required permissions)

Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: cluster:monitor/allocation/explain