InfluxDB v2 OSS Docs Submit API issue

InfluxDB v1 HTTP API 用于 InfluxDB v2 OSS

License: MIT

InfluxDB v1 兼容性 API 提供了一个程序接口,用于通过 InfluxDB v1 兼容的端点与 InfluxDB v2 进行交互。

InfluxDB 1.x 兼容的 /write 和 /query 端点与 InfluxDB 1.x 客户端库以及像 Grafana 等第三方集成一起工作。

此文档由 InfluxDB OpenAPI 规范 生成。

认证

InfluxDB 1.x API 对所有请求要求身份验证。 InfluxDB Cloud 使用 InfluxDB API 令牌来验证请求。

有关更多信息,请参见以下内容:

令牌认证

使用令牌认证方案来对InfluxDB API进行认证。

在您的API请求中,发送一个 Authorization 头。 对于头部值,提供单词 Token 后跟一个空格和一个InfluxDB API令牌。 单词 Token 是区分大小写的。

语法

Authorization: Token YOUR_INFLUX_TOKEN

有关示例和更多信息,请参见以下内容:

安全方案类型API Key
头部参数名称:Authorization

基本认证

使用HTTP 基本身份验证 方案与支持InfluxDB 1.x 用户名和密码约定的客户端(不支持Authorization: Token 方案):

有关示例和更多信息,请查看如何使用用户名和密码进行身份验证

安全方案类型HTTP
HTTP 授权方案basic

查询字符串身份验证

使用查询字符串身份验证方案与InfluxDB 1.x API参数通过查询字符串提供凭据。

有关示例和更多信息,请参阅如何使用用户名和密码进行身份验证

安全方案类型API Key
查询参数名称:u=&p=

查询

使用 InfluxDB v1 HTTP API 查询

查询参数
db
必填
字符串

要查询的存储桶。

p
string

用户令牌。

q
string

定义要运行的 influxql 查询。

rp
字符串

保留策略名称。

u
字符串

用户名。

头部参数
接受
字符串
默认: application/json
枚举: "application/json" "application/csv" "text/csv" "application/x-msgpack"

指定查询结果在响应中应如何编码。 注意: 使用 application/csv 时,查询结果包括纪元时间戳,而不是RFC3339时间戳。

接受编码
字符串
默认: 身份
枚举: "gzip" "身份"

Accept-Encoding请求HTTP头部广告客户端能够理解的内容编码,通常是压缩算法。

内容类型
字符串
值: "application/vnd.influxql"
Zap-Trace-Span
字符串
示例: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span上下文

请求体架构: text/plain

要执行的InfluxQL查询。

string

响应

响应示例

Content type
No sample

以V1兼容格式将时间序列数据写入InfluxDB

查询参数
db
必填
字符串

要写入的存储桶。如果不存在,InfluxDB将创建一个默认保留策略为3天的存储桶。

p
string

用户令牌。

精度
字符串

写入精度。

rp
字符串

保留策略名称。

u
字符串

用户名。

头部参数
内容编码
字符串
默认: identity
枚举: "gzip" "identity"

当出现时,它的值向数据库指示压缩已应用于线协议主体。

Zap-Trace-Span
字符串
示例: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span上下文

请求体架构: text/plain

行协议主体

string

响应

响应示例

Content type
application/json
{
  • "code": "internal error",
  • "message": "string",
  • "op": "string",
  • "err": "string",
  • "line": 0
}