HTTP API

鉴权

GreptimeDB 支持 HTTP API 内置的 Basic 鉴权机制，接收 SQL 语言和 OpenTSDB 协议语言。按照下面的步骤来设置鉴权：

  1. 使用 Base64 算法编码你的用户名和密码。
  2. 在 HTTP 请求头中写入编码后的鉴权信息：Authorization: Basic <base64-encoded-credentials>

示例如下：

  1. curl -X POST \
  2. -H 'Authorization: Basic Z3JlcHRpbWVfdXNlcjpncmVwdGltZV9wd2Q=' \
  3. -H 'Content-Type: application/x-www-form-urlencoded' \
  4. -d 'sql=show tables' \
  5. http://localhost:4000/v1/sql?db=public
  1. {
  2.   "code": 0,
  3.   "output": [
  4.     {
  5.       "records": {
  6.         "schema": {
  7.           "column_schemas": [
  8.             {
  9.               "name": "Tables",
  10.               "data_type": "String"
  11.             }
  12.           ]
  13.         },
  14.         "rows": [
  15.           ["numbers"]
  16.         ]
  17.       }
  18.     }
  19.   ],
  20.   "execution_time_ms": 1
  21. }
  • Z3JlcHRpbWVfdXNlcjpncmVwdGltZV9wd2Q= 是 greptime_user:greptime_pwd 使用 Base64 编码后的结果，请记得替换为你自己的用户名和密码使用 Base64 编码后的字符串。
  • URL 中的 public 是数据库的名称，在鉴权时必须提供。

HTTP API - 图1注意

InfluxDB 使用自己的鉴权格式，详情请参考 InfluxDB。

时区

GreptimeDB 支持 HTTP 协议中的 X-Greptime-Timezone 字段。 它用于为当前 SQL 查询指定时区。

例如，下方请求使用时区 +1:00 进行查询：

  1. curl -X POST \
  2. -H 'X-Greptime-Timezone: +1:00' \
  3. -H 'Content-Type: application/x-www-form-urlencoded' \
  4. -d 'sql=SHOW VARIABLES time_zone;' \
  5. http://localhost:4000/v1/sql?db=public

SQL 执行结果为：

  1. {
  2.   "output": [
  3.     {
  4.       "records": {
  5.         "schema": {
  6.           "column_schemas": [
  7.             {
  8.               "name": "TIME_ZONE",
  9.               "data_type": "String"
  10.             }
  11.           ]
  12.         },
  13.         "rows": [
  14.           [
  15.             "+01:00"
  16.           ]
  17.         ]
  18.       }
  19.     }
  20.   ],
  21.   "execution_time_ms": 27
  22. }

有关时区如何影响数据的插入和查询，请参考 写入数据 和 查询数据 中的 SQL 文档。

写入数据

读取数据