HTTP API

要通过 HTTP API 向 GreptimeDB 服务器提交 SQL 查询,请使用以下格式:

  1. curl -X POST \
  2. -H 'Authorization: Basic {{authentication}}' \
  3. -H 'Content-Type: application/x-www-form-urlencoded' \
  4. -d 'sql={{SQL-statement}}' \
  5. http://{{API-host}}/v1/sql?db={{db-name}}

Method

请使用 POST 方法

Header

  • Authorization: 身份凭证。如果你使用启用了身份验证的 GreptimeDB,则此项为必需。 请参考鉴权
  • Content-Type: application/x-www-form-urlencoded
  • X-Greptime-Timezone: 当前 SQL 语句使用的时区,可选。请参考时区.

Query 参数

  • db: 数据库名称。如果你使用启用了需要身份验证的 GreptimeDB,则此项必需。如果使用默认的 public 数据库就可以省略这一项。

Body

  • sql: SQL 语句,必需。

Response

请求的响应是一个 JSON 对象。

  • code: 结果状态码,0 代表成功,其他代表失败。
  • output: SQL 的执行结果,包括 Schema 和数据。

示例

请参考用户指南中的表管理, 写入数据 and 查询数据