Delete Stored Script API
Delete Stored Script API
1.0에서 도입
클러스터 상태에서 저장된 스크립트(stored script)를 삭제해요.
출처: 문서
본문
엔드포인트 (Endpoints)
DELETE _scripts/my-script
경로 매개변수 (Path parameters)
경로 매개변수는 선택 사항이에요.
| 매개변수 | 데이터 타입 | 설명 |
|---|---|---|
script-id |
String | 삭제할 스크립트의 ID예요. |
쿼리 매개변수 (Query parameters)
| 매개변수 | 데이터 타입 | 설명 |
|---|---|---|
cluster_manager_timeout |
Time | 클러스터 매니저에 연결되기를 기다리는 시간이에요. 선택 사항이며 기본값은 30s예요. |
timeout |
Time | 응답을 기다리는 시간이에요. 타임아웃 값 전에 응답을 받지 못하면 요청이 처리되지 않아요. |
예시 요청 (Example request)
다음 요청은 my-first-script 스크립트를 삭제해요.
DELETE /_scripts/my-script
Python 클라이언트로는 이렇게 호출해요:
response = client.delete_script(
id = "my-script"
)
예시 응답 (Example response)
DELETE _scripts/my-first-script 요청은 다음 필드를 반환해요:
{
"acknowledged" : true
}
저장된 스크립트가 제대로 삭제됐는지 확인하려면 Get stored script API에 script 경로 매개변수로 스크립트 이름을 넘겨 확인해요.
응답 본문 필드 (Response body fields)
요청은 다음 응답 필드를 반환해요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
acknowledged |
Boolean | 삭제 스크립트 요청을 받았는지 여부예요. |
필요한 권한 (Required permissions)
Security 플러그인을 사용한다면 적절한 권한이 있는지 확인해야 해요: cluster:admin/script/delete.