CAT 플러그인 API

CAT 플러그인 API (CAT Plugins API)

1.0 버전에서 도입되었어요. CAT plugins 작업은 설치된 플러그인의 이름, 구성 요소, 버전을 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/plugins

쿼리 파라미터 (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 request)

다음 예제 요청은 설치된 모든 플러그인을 나열해요:

GET /_cat/plugins?v

예제 응답 (Example response)

name             component                            version
opensearch-node1 analysis-icu                         3.3.2
opensearch-node1 opensearch-alerting                  3.3.2.0
opensearch-node1 opensearch-anomaly-detection         3.3.2.0
opensearch-node1 opensearch-asynchronous-search       3.3.2.0
opensearch-node1 opensearch-cross-cluster-replication 3.3.2.0
opensearch-node1 opensearch-custom-codecs             3.3.2.0
opensearch-node1 opensearch-flow-framework            3.3.2.0
opensearch-node1 opensearch-geospatial                3.3.2.0
opensearch-node1 opensearch-index-management          3.3.2.0
opensearch-node1 opensearch-job-scheduler             3.3.2.0
opensearch-node1 opensearch-knn                       3.3.2.0
opensearch-node1 opensearch-ml                        3.3.2.0
opensearch-node1 opensearch-neural-search             3.3.2.0
opensearch-node1 opensearch-notifications             3.3.2.0
opensearch-node1 opensearch-observability             3.3.2.0
opensearch-node1 opensearch-security                  3.3.2.0
opensearch-node1 opensearch-sql                       3.3.2.0

응답 열 (Response columns)

아래 표는 모든 응답 열을 정리한 거예요.

열 별칭 설명
id - 고유한 노드 식별자.
name n 노드 이름.
component c 플러그인 구성 요소 이름.
version v 플러그인 버전.
description d 플러그인 설명과 세부 정보.

특정 열만 표시하려면 h 쿼리 파라미터를 사용하세요. 예를 들어 노드 이름, 구성 요소, 버전만 보여주려면:

GET /_cat/plugins?v&h=name,component,version

필요한 권한 (Required permissions)

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

더 알아보기 (Learn more)