API 레퍼런스
API 레퍼런스 (API reference)
Pinot의 쿼리(Query) 및 컨트롤러(Controller) 엔드포인트에 대한 API 레퍼런스를 다루는 문서예요. Pinot API 면을 Broker 쿼리 API, 쿼리 응답 형식, 컨트롤러 관리 API, 컨트롤러 API 예시, Broker gRPC로 정리해서, 운영자와 클라이언트 개발자가 알아야 할 엔드포인트 수준 동작을 폭넓게 기록하는 것이 목표예요.
출처: 문서
본문
이 섹션에서는 Pinot API 면을 Broker 쿼리 API, 쿼리 응답 포맷팅, 컨트롤러 관리 API, 컨트롤러 API 예시, Broker gRPC로 재구성해요. 개요는 가볍게 유지하면서도 운영자와 클라이언트 작성자가 필요로 하는 엔드포인트 수준의 동작을 문서화하는 데 집중해요.
레퍼런스 맵 (Reference Map)
| 영역 | 용도 | 원본 페이지 |
|---|---|---|
| Broker 쿼리 API | SQL 쿼리 제출, Broker 커서, 응답 저장소 수명주기 | Broker 쿼리 API |
| 쿼리 응답 형식 | 응답 필드와 커서 페이로드 구조 | 쿼리 응답 형식 |
| 컨트롤러 관리 API | 클러스터·테이블 관리를 위한 Swagger UI 둘러보기 | 컨트롤러 관리 API |
| 컨트롤러 API 예시 | 엔드포인트 패밀리와 대표 관리 요청 | 컨트롤러 API 예시 |
| Broker gRPC | gRPC 쿼리 전송과 클라이언트 구성 | Broker gRPC API |
이 페이지에서 다룬 내용 (What this page covered)
- 주요 Pinot API 면과 각각의 의도된 용도
- 이 하위 트리에서 엔드포인트 수준 상세를 담은 페이지
- 쿼리·컨트롤러·gRPC 레퍼런스 자료를 어디서 찾을지
다음 단계 (Next step)
필요한 API 패밀리를 고른 뒤, 요청·응답 예시를 대상 컴포넌트와 교차 확인해 보세요.