InfluxDB v1 HTTP API 为 InfluxDB v3 集群版数据库提供 v1 兼容的写入和查询功能。
InfluxDB 1.x 的 /write
和 /query
端点与 InfluxDB 1.x 客户端库以及 Grafana 等第三方集成一起工作。
本文档基于 InfluxDB OpenAPI 规范 生成。
使用 Token 身份验证 方案对 InfluxDB API 进行身份验证。
在您的 API 请求中,发送一个 Authorization
标头。对于标头值,提供单词 Token
后跟一个空格和一个 InfluxDB API 令牌。单词 Token
是区分大小写的。
Authorization: Token YOUR_INFLUX_TOKEN
有关示例和更多信息,请参阅以下内容
安全方案类型 | API 密钥 |
---|---|
标头参数名称 | Authorization |
使用支持 InfluxDB 1.x 命名约定(即不支持 Authorization: Token
方案)的用户名和密码的 HTTP 基本身份验证 方案。
有关示例和更多信息,请参阅如何 使用用户名和密码进行身份验证。
安全方案类型 | HTTP |
---|---|
HTTP 身份验证方案 | basic |
使用 查询字符串身份验证 方案,通过查询字符串提供凭据。
有关示例和更多信息,请参阅如何 使用用户名和密码进行身份验证。
安全方案类型 | API 密钥 |
---|---|
查询参数名称 | u=&p= |
db 必需 | 字符串 查询的桶。 |
p | 字符串 用户令牌。 |
q | 字符串 定义要运行的 influxql 查询。 |
rp | 字符串 保留策略名称。 |
u | 字符串 用户名。 |
Accept | 字符串 默认值: application/json 枚举: "application/json" "application/csv" "text/csv" "application/x-msgpack" 指定查询结果应在响应中如何编码。 注意:使用 |
Accept-Encoding | 字符串 默认值: identity 枚举: "gzip" "identity" Accept-Encoding 请求 HTTP 头部声明客户端能够理解的内容编码,通常是一个压缩算法。 |
Content-Type | 字符串 值: "application/vnd.influxql" |
Zap-Trace-Span | 字符串 示例: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span 上下文 |
要执行的 InfluxQL 查询。
db 必需 | 字符串 要写入的桶。如果不存在,InfluxDB 将创建一个具有默认 3 天保留策略的桶。 |
p | 字符串 用户令牌。 |
precision | 字符串 写入精度。 |
rp | 字符串 保留策略名称。 |
u | 字符串 用户名。 |
Content-Encoding | 字符串 默认值: identity 枚举: "gzip" "identity" 存在时,其值指示数据库已将压缩应用于行协议体。 |
Zap-Trace-Span | 字符串 示例: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span 上下文 |
行协议体
{- "code": "内部错误",
- "message": "string",
- "op": "string",
- "err": "string",
- "line": 0
}