CAT 템플릿 API
CAT 템플릿 API (CAT Templates API)
1.0 버전에서 도입되었어요. CAT templates 작업은 인덱스 템플릿의 이름, 패턴, 순서 번호, 버전 번호를 나열해요.
출처: 문서
본문
엔드포인트 (Endpoints)
GET /_cat/templates
GET /_cat/templates/{name}
쿼리 파라미터 (Query parameters)
아래 표는 사용 가능한 쿼리 파라미터를 정리한 거예요. 모든 쿼리 파라미터는 선택 사항이에요.
| 파라미터 | 데이터 타입 | 설명 | 기본값 |
|---|---|---|---|
cluster_manager_timeout |
String | 클러스터 매니저 노드에 연결하는 데 허용되는 시간. | N/A |
format |
String | json 또는 yaml 같은 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/templates?v
특정 템플릿 또는 패턴에 대한 정보를 원한다면:
GET /_cat/templates/<template_name_or_pattern>
예제 응답 (Example response)
name | index_patterns order version composed_of
tenant_template | [opensearch-dashboards*] | 0 |
인덱스 템플릿에 대해 더 알아보려면 Index templates 문서를 참고하세요.
필요한 권한 (Required permissions)
Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: indices:admin/template/get