Skip to content
HTTP API

HTTP API

machbase-neo는 HTTP API를 통해 두 가지 주요 기능을 제공합니다. 하나는 모든 종류의 SQL 구문을 실행할 수 있는 query, 다른 하나는 INSERT INTO ... SQL과 동일한 기능을 제공하는 write입니다.

HTTP API의 일반적인 목적은 센서와 디바이스가 MQTT와 HTTP로 데이터를 적재하는 동안, 사용자 서비스 애플리케이션과 데이터 분석 도구가 machbase 데이터베이스에 저장된 데이터에 접근할 수 있도록 기능을 노출하는 데 있습니다.

Endpoints

애플리케이션과 센서는 HTTP API를 통해 데이터를 읽고 쓸 수 있습니다.

Database Query

MethodPathDescription
GET/db/queryq 매개변수를 사용해 쿼리를 실행합니다.
POST/db/queryJSON 또는 폼 데이터를 사용해 쿼리를 실행합니다.

Database Write

MethodPathDescription
POST/db/writeJSON 또는 CSV 형식으로 데이터를 저장합니다.
POST/metrics/writeILP(Influx Line Protocol) 형식으로 데이터를 저장합니다.

API 토큰 검증

MethodPathDescription
POST/db/token/validateAuthorization: Bearer <token>의 API 토큰을 검증하고, 유효하면 해당 토큰으로 DB 요청을 수행할 때 적용되는 사용자를 반환합니다. 토큰 인증 설정과 관계없이 Bearer 헤더가 필요합니다.

TQL Endpoints

MethodPathDescription
GET/db/tql/{tql_file_path}경로로 지정한 TQL 파일을 실행합니다.
POST/db/tql/{tql_file_path}요청 본문을 입력값으로 사용해 지정한 TQL 파일을 실행합니다.
POST/db/tql요청 본문에 포함된 TQL 스크립트를 실행합니다.
POST/db/tql?$={tql_script}쿼리 매개변수 $로 전달된 TQL 스크립트를 요청 본문과 함께 실행합니다. Since v8.0.17

Testing HTTP API

machbase-neo 웹 UI에는 REST API 클라이언트가 내장되어 있어 아래 예시처럼 워크시트의 마크다운이나 TQL에서 바로 HTTP API를 테스트할 수 있습니다.

machbase-neo의 토큰 인증은 기본적으로 활성화되어 있습니다(--http-enable-token-auth true). 이 상태에서 인증 토큰 없이 요청하면 401 Unauthorized 응답과 함께 {"reason":"missing authorization token","success":false} 메시지가 반환됩니다. 아래 예시를 실행하려면 API 보안의 안내에 따라 API 토큰을 발급받고, 요청에 Authorization: Bearer <API_TOKEN> 헤더를 추가하세요.

  • 워크시트의 마크다운
```http
GET http://127.0.0.1:5654/db/query
    ?q=select count(*) from example
    &format=ndjson
Authorization: Bearer <your token>
```
  • TQL
HTTP({
    GET http://127.0.0.1:5654/db/query
        ?q=select count(*) from example
        &format=ndjson
    Authorization: Bearer <your token>
})
TEXT()

이 장에서 안내하는 내용

최근 업데이트