Get Stored Script API
Get Stored Script API
1.0에서 도입
클러스터 상태에서 저장된 스크립트(stored script)를 조회해요.
출처: 문서
본문
엔드포인트 (Endpoints)
GET _scripts/my-first-script
경로 매개변수 (Path parameters)
| 매개변수 | 데이터 타입 | 설명 |
|---|---|---|
script |
String | 저장된 스크립트 또는 검색 템플릿 이름이에요. 필수예요. |
쿼리 매개변수 (Query parameters)
| 매개변수 | 데이터 타입 | 설명 |
|---|---|---|
cluster_manager_timeout |
Time | 클러스터 매니저에 연결되기를 기다리는 시간이에요. 선택 사항이며 기본값은 30s예요. |
예시 요청 (Example request)
다음은 my-first-script 저장된 스크립트를 조회해요.
GET /_scripts/my-first-script
Python 클라이언트로는 이렇게 호출해요:
response = client.get_script(
id = "my-first-script"
)
예시 응답 (Example response)
GET _scripts/my-first-script 요청은 다음 필드를 반환해요:
{
"_id" : "my-first-script",
"found" : true,
"script" : {
"lang" : "painless",
"source" : """
int total = 0;
for (int i = 0; i < doc['ratings'].length; ++i) {
total += doc['ratings'][i];
}
return total;
"""
}
}
응답 본문 필드 (Response body fields)
GET _scripts/my-first-script 요청은 다음 응답 필드를 반환해요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
_id |
String | 스크립트의 이름이에요. |
found |
Boolean | 요청한 스크립트가 존재하며 조회되었는지 여부예요. |
script |
Object | 스크립트 정의예요. Script 객체를 참고해요. |
Script 객체
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
lang |
String | 스크립트의 언어예요. |
source |
String | 스크립트의 본문이에요. |
필요한 권한 (Required permissions)
Security 플러그인을 사용한다면 적절한 권한이 있는지 확인해야 해요: cluster:admin/script/get.