Example Operation API
출처: 문서
본문
예시 작업 API
1.0부터 도입됨 {: .label .label-purple }
예시 API는 ... (이 API가 수행하는 작업에 대한 설명 문장)이에요.
엔드포인트
POST /_example/endpoint/
POST /_example/endpoint/{path_parameter}
경로 파라미터
다음 표에서 사용 가능한 경로 파라미터를 확인할 수 있어요. 모든 경로 파라미터는 선택 사항이에요.
| 파라미터 | 데이터 타입 | 설명 |
|---|---|---|
path_parameter |
Type | 예시 경로 파라미터 설명이에요. 기본값은 ...이에요. |
쿼리 파라미터
다음 표에서 사용 가능한 쿼리 파라미터를 확인할 수 있어요. 모든 쿼리 파라미터는 선택 사항이에요.
| 파라미터 | 데이터 타입 | 설명 |
|---|---|---|
query_parameter |
String | 예시 쿼리 파라미터 설명이에요. 기본값은 ...이에요. |
요청 본문 필드
다음 표에서 사용 가능한 요청 본문 필드를 확인할 수 있어요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
example_object |
Object | 예시 객체 설명이에요. |
example_object.required_request_field |
Type | 필수 요청 필드 설명이에요. 필수 항목이에요. |
example_object.optional_request_field |
Type | 선택적 요청 필드 설명이에요. 선택 사항이에요. 기본값은 ...이에요. |
예시 요청
POST /_example/endpoint/
{
"example_object": {
"required_request_field": "example value",
"optional_request_field": "example value"
}
}
{% include copy-curl.html %}
예시 응답
{
"_nodes" : {
"total" : 1,
"successful" : 1,
"failed" : 0
}
}
응답 본문 필드
다음 표에서 모든 응답 본문 필드를 확인할 수 있어요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
response_field |
Type | 응답 필드 설명이에요. |
필수 권한
Security 플러그인을 사용한다면 적절한 권한을 갖고 있는지 꼭 확인하세요: cluster:example/permission/name.