InfluxDB 3 Core API 服务

InfluxData: support@influxdata.com URL: https://influxdb.org.cn 许可证: MIT

InfluxDB 3 Core 的 InfluxDB HTTP API 为与 InfluxDB 3 Core 数据库和资源交互提供了程序化接口。使用此 API 可以

将数据写入 InfluxDB 3 Core 数据库
使用 SQL 或 InfluxQL 查询数据
使用处理引擎插件处理数据
管理数据库、表和处理引擎触发器
执行管理任务和访问系统信息

API 包括以下路径下的端点

/api/v3: InfluxDB 3 Core 原生端点
/: InfluxDB v1 工作负载和客户端的兼容性端点
/api/v2/write: InfluxDB v2 工作负载和客户端的兼容性端点

快速入门

检查 InfluxDB 服务器的状态。
```
curl "http://localhost:8181/health"
```

curl "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto" \
  --data-raw "home,room=Kitchen temp=72.0
 home,room=Living\ room temp=71.5"

如果所有数据都已写入，则响应为 204 No Content。

从 InfluxDB 查询数据。

curl -G "http://localhost:8181/api/v3/query_sql" \
  --data-urlencode "db=sensors" \
  --data-urlencode "q=SELECT * FROM home WHERE room='Living room'" \
  --data-urlencode "format=jsonl"

输出

{"room":"Living room","temp":71.5,"time":"2025-02-25T20:19:34.984098"}

有关使用 InfluxDB 3 Core 的更多信息，请参阅入门指南。

身份验证

在 Beta 阶段，InfluxDB 3 Core 不需要身份验证。

兼容性端点

InfluxDB 3 为 InfluxDB 1.x 和 InfluxDB 2.x 工作负载和客户端提供兼容性端点。

使用 v1 或 v2 兼容的端点写入数据

/api/v2/write 端点，适用于 InfluxDB v2 客户端以及您将现有 InfluxDB v2 写入工作负载迁移到 InfluxDB 3 时。
/write 端点，适用于 InfluxDB v1 客户端以及您将现有 InfluxDB v1 写入工作负载迁移到 InfluxDB 3 时。

对于新的工作负载，请使用 /api/v3/write_lp 端点。

所有端点都接受相同的行协议格式。

查询数据

对于 InfluxDB v1 客户端和使用 InfluxQL 的 v1 查询工作负载，请使用 HTTP /query 端点。

对于新的工作负载，请使用以下端点之一

HTTP /api/v3/query_sql 端点，适用于使用 SQL 的新查询工作负载。
HTTP /api/v3/query_influxql 端点，适用于使用 InfluxQL 的新查询工作负载。
Flight SQL 和 InfluxDB 3 Flight+gRPC API 用于使用 SQL 或 InfluxQL 进行查询。有关使用 Flight API 的更多信息，请参阅 InfluxDB 3 客户端库。

服务器信息

服务器信息端点（如 /health 和 metrics）与 InfluxDB 1.x 和 InfluxDB 2.x 客户端兼容。

写入行协议 (v1 兼容)

将行协议写入到指定的数据库。

此端点为使用 InfluxDB 1.x 客户端库、Telegraf outputs.influxdb 输出插件或第三方工具等工具的 InfluxDB 1.x 写入工作负载提供向后兼容性。

使用此端点以行协议格式将数据发送到 InfluxDB。使用查询参数指定写入数据的选项。

授权

BearerAuth

查询参数

db 必需	string 数据库的名称。数据库的名称。如果数据库尚不存在，InfluxDB 将创建数据库，然后将批处理中的所有点写入到该数据库。
precision 必需	string (PrecisionWriteCompatibility) 枚举: "ms" "s" "us" "ns" 行协议批处理中 Unix 时间戳的精度。

头部参数

Accept	string 默认值: application/json 值: "application/json" 客户端可以理解的内容类型。仅当写入失败（部分或完全失败）时，写入才会返回响应正文，例如，由于语法问题或类型不匹配。
Content-Encoding	string (ContentEncoding) 默认值: identity 枚举: "gzip" "identity" 应用于请求负载中行协议的压缩。要发送 gzip 负载，请传递 `Content-Encoding: gzip` 标头。
Content-Length	integer (ContentLength) 发送到 InfluxDB 的实体主体的大小，以字节为单位。
Content-Type	string (LineProtocol) 默认值: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求负载的内容类型。

请求主体模式: text/plain

string

响应

请求示例

负载

内容类型

text/plain

示例

measurement,tag=value field=1 1234567890

响应示例

400
401

内容类型

application/json

示例

"{\n \"error\": \"行协议写入失败\",\n \"data\": [\n {\n \"original_line\": \"dquote> home,room=Kitchen temp=hi\",\n \"line_number\": 2,\n \"error_message\": \"未提供任何字段\"\n }\n ]\n}\n"

写入行协议 (v2 兼容)

将行协议写入到指定的数据库。

此端点为使用 InfluxDB 2.x 客户端库、Telegraf outputs.influxdb_v2 输出插件或第三方工具等工具的 InfluxDB 2.x 写入工作负载提供向后兼容性。

使用此端点以行协议格式将数据发送到 InfluxDB。使用查询参数指定写入数据的选项。

授权

BearerAuth

查询参数

accept_partial	boolean (AcceptPartial) 默认值: true 接受部分写入。
db 必需	string 数据库名称。如果数据库尚不存在，InfluxDB 将创建数据库，然后将批处理中的所有点写入到该数据库。
precision 必需	string (PrecisionWriteCompatibility) 枚举: "ms" "s" "us" "ns" 行协议批处理中 Unix 时间戳的精度。

头部参数

Accept	string 默认值: application/json 值: "application/json" 客户端可以理解的内容类型。仅当写入失败（部分或完全失败）时，写入才会返回响应正文，例如，由于语法问题或类型不匹配。
Content-Encoding	string 默认值: identity 枚举: "gzip" "identity" 应用于请求负载中行协议的压缩。要发送 gzip 负载，请传递 `Content-Encoding: gzip` 标头。
Content-Length	integer 发送到 InfluxDB 的实体主体的大小，以字节为单位。
Content-Type	string (LineProtocol) 默认值: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求负载的内容类型。

请求主体模式: text/plain

string

响应

请求示例

负载

内容类型

text/plain

示例

measurement,tag=value field=1 1234567890

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

执行 InfluxQL 查询 (v1 兼容)

执行 InfluxQL 查询以从指定的数据库检索数据。

此端点与 InfluxDB 1.x 客户端库和第三方集成（如 Grafana）兼容。使用查询参数指定数据库和 InfluxQL 查询。

授权

BearerAuth

查询参数

chunk_size	integer 默认值: 10000 将进入一个块的记录数。仅当 `chunked=true` 时才使用此参数。
chunked	boolean 默认值: false 如果为 true，则响应将分为大小为 `chunk_size` 的块。
db	string <InfluxQL> 要查询的数据库。如果未提供，则 InfluxQL 查询字符串必须指定数据库。
epoch	string (EpochCompatibility) 枚举: "ns" "u" "µ" "ms" "s" "m" "h" 将时间戳格式化为具有指定精度的 unix（纪元）时间戳，而不是具有纳秒精度的 RFC3339 时间戳。
pretty	boolean 默认值: false 如果为 true，则 JSON 响应将以人类可读的格式格式化。
q 必需	string InfluxQL 查询字符串。

头部参数

Accept

string

默认值: application/json

枚举: "application/json" "application/csv" "text/csv"

客户端可以理解的内容类型。

如果指定 text/csv，则 Content-type 响应标头为 application/csv，并且响应格式为 CSV。

如果格式无效或非 UTF8，则返回错误。

响应

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

执行 InfluxQL 查询 (v1 兼容)

执行 InfluxQL 查询以从指定的数据库检索数据。

授权

BearerAuth

头部参数

Accept

string

默认值: application/json

枚举: "application/json" "application/csv" "text/csv"

客户端可以理解的内容类型。

如果指定 text/csv，则 Content-type 响应标头为 application/csv，并且响应格式为 CSV。

如果格式无效或非 UTF8，则返回错误。

请求主体模式: application/json

chunk_size	integer 默认值: 10000 将进入一个块的记录数。仅当 `chunked=true` 时才使用此参数。
chunked	boolean 如果为 true，则响应将分为大小为 `chunk_size` 的块。
db	string 要查询的数据库。如果未提供，则 InfluxQL 查询字符串必须指定数据库。
epoch	string 枚举: "ns" "u" "µ" "ms" "s" "m" "h" Unix 时间戳精度。 `h` 代表小时 `m` 代表分钟 `s` 代表秒 `ms` 代表毫秒 `u` 或 `µ` 代表微秒 `ns` 代表纳秒将时间戳格式化为具有指定精度的 unix（纪元）时间戳，而不是具有纳秒精度的 RFC3339 时间戳。
pretty	boolean 如果为 true，则 JSON 响应将以人类可读的格式格式化。
q 必需	string InfluxQL 查询字符串。

响应

请求示例

负载

内容类型

application/json

{"db": "string",
"q": "string",
"chunked": true,
"chunk_size": 10000,
"epoch": "ns",
"pretty": true
}

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

健康检查 (v1)

检查服务的状态。

授权

BearerAuth

响应

数据 I/O

写入和查询数据

InfluxDB 3 Core 中的数据流

传入写入：系统验证传入数据并将其存储在写入缓冲区（内存中）。如果启用 no_sync 写入选项 (no_sync=true)，服务器将发送响应以确认写入。
WAL 刷新：每秒（默认），系统将写入缓冲区刷新到预写式日志 (WAL) 以在对象存储中进行持久化。如果 no_sync=false（默认），服务器将发送响应以确认写入。
查询可用性：WAL 持久化完成后，数据将移动到可查询缓冲区，在那里它变得可用于查询。默认情况下，服务器最多保留 900 个 WAL 文件（15 分钟的数据）缓冲。
Parquet 格式的长期存储：每十分钟（默认），系统将可查询缓冲区中最旧的数据以 Parquet 格式持久化到对象存储。InfluxDB 将剩余数据（最近 5 分钟）保存在内存中。
内存缓存：InfluxDB 将 Parquet 文件放入内存缓存中，以便针对最近持久化数据的查询不必访问对象存储。

写入行协议 (v1 兼容)

将行协议写入到指定的数据库。

此端点为使用 InfluxDB 1.x 客户端库、Telegraf outputs.influxdb 输出插件或第三方工具等工具的 InfluxDB 1.x 写入工作负载提供向后兼容性。

使用此端点以行协议格式将数据发送到 InfluxDB。使用查询参数指定写入数据的选项。

授权

BearerAuth

查询参数

db 必需	string 数据库的名称。数据库的名称。如果数据库尚不存在，InfluxDB 将创建数据库，然后将批处理中的所有点写入到该数据库。
precision 必需	string (PrecisionWriteCompatibility) 枚举: "ms" "s" "us" "ns" 行协议批处理中 Unix 时间戳的精度。

头部参数

Accept	string 默认值: application/json 值: "application/json" 客户端可以理解的内容类型。仅当写入失败（部分或完全失败）时，写入才会返回响应正文，例如，由于语法问题或类型不匹配。
Content-Encoding	string (ContentEncoding) 默认值: identity 枚举: "gzip" "identity" 应用于请求负载中行协议的压缩。要发送 gzip 负载，请传递 `Content-Encoding: gzip` 标头。
Content-Length	integer (ContentLength) 发送到 InfluxDB 的实体主体的大小，以字节为单位。
Content-Type	string (LineProtocol) 默认值: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求负载的内容类型。

请求主体模式: text/plain

string

响应

请求示例

负载

内容类型

text/plain

示例

measurement,tag=value field=1 1234567890

响应示例

400
401

内容类型

application/json

示例

"{\n \"error\": \"行协议写入失败\",\n \"data\": [\n {\n \"original_line\": \"dquote> home,room=Kitchen temp=hi\",\n \"line_number\": 2,\n \"error_message\": \"未提供任何字段\"\n }\n ]\n}\n"

写入行协议 (v2 兼容)

将行协议写入到指定的数据库。

此端点为使用 InfluxDB 2.x 客户端库、Telegraf outputs.influxdb_v2 输出插件或第三方工具等工具的 InfluxDB 2.x 写入工作负载提供向后兼容性。

使用此端点以行协议格式将数据发送到 InfluxDB。使用查询参数指定写入数据的选项。

授权

BearerAuth

查询参数

accept_partial	boolean (AcceptPartial) 默认值: true 接受部分写入。
db 必需	string 数据库名称。如果数据库尚不存在，InfluxDB 将创建数据库，然后将批处理中的所有点写入到该数据库。
precision 必需	string (PrecisionWriteCompatibility) 枚举: "ms" "s" "us" "ns" 行协议批处理中 Unix 时间戳的精度。

头部参数

Accept	string 默认值: application/json 值: "application/json" 客户端可以理解的内容类型。仅当写入失败（部分或完全失败）时，写入才会返回响应正文，例如，由于语法问题或类型不匹配。
Content-Encoding	string 默认值: identity 枚举: "gzip" "identity" 应用于请求负载中行协议的压缩。要发送 gzip 负载，请传递 `Content-Encoding: gzip` 标头。
Content-Length	integer 发送到 InfluxDB 的实体主体的大小，以字节为单位。
Content-Type	string (LineProtocol) 默认值: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求负载的内容类型。

请求主体模式: text/plain

string

响应

请求示例

负载

内容类型

text/plain

示例

measurement,tag=value field=1 1234567890

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

写入行协议

将行协议写入到指定的数据库。

使用此端点以行协议格式将数据发送到 InfluxDB。使用查询参数指定写入数据的选项。

授权

BearerAuth

查询参数

accept_partial	boolean (AcceptPartial) 默认值: true 接受部分写入。
db 必需	string 数据库的名称。数据库的名称。如果数据库尚不存在，InfluxDB 将创建数据库，然后将批处理中的所有点写入到该数据库。
no_sync	boolean (NoSync) 默认值: false 确认成功写入，无需等待 WAL 持久化。 InfluxDB 3 Core 中的数据流传入写入：系统验证传入数据并将其存储在写入缓冲区（内存中）。如果启用 `no_sync` 写入选项 (`no_sync=true`)，服务器将发送响应以确认写入。 WAL 刷新：每秒（默认），系统将写入缓冲区刷新到预写式日志 (WAL) 以在对象存储中进行持久化。如果 `no_sync=false`（默认），服务器将发送响应以确认写入。查询可用性：WAL 持久化完成后，数据将移动到可查询缓冲区，在那里它变得可用于查询。默认情况下，服务器最多保留 900 个 WAL 文件（15 分钟的数据）缓冲。 Parquet 格式的长期存储：每十分钟（默认），系统将可查询缓冲区中最旧的数据以 Parquet 格式持久化到对象存储。InfluxDB 将剩余数据（最近 5 分钟）保存在内存中。内存缓存：InfluxDB 将 Parquet 文件放入内存缓存中，以便针对最近持久化数据的查询不必访问对象存储。
precision 必需	string (PrecisionWrite) 枚举: "auto" "millisecond" "second" "microsecond" "nanosecond" 时间戳精度。

头部参数

Accept	string 默认值: application/json 值: "application/json" 客户端可以理解的内容类型。仅当写入失败（部分或完全失败）时，写入才会返回响应正文，例如，由于语法问题或类型不匹配。
Content-Encoding	string (ContentEncoding) 默认值: identity 枚举: "gzip" "identity" 应用于请求负载中行协议的压缩。要发送 gzip 负载，请传递 `Content-Encoding: gzip` 标头。
Content-Length	integer (ContentLength) 发送到 InfluxDB 的实体主体的大小，以字节为单位。
Content-Type	string (LineProtocol) 默认值: text/plain; charset=utf-8 枚举: "text/plain" "text/plain; charset=utf-8" 请求负载的内容类型。

请求主体模式: text/plain

string

响应

请求示例

负载

内容类型

text/plain

示例

measurement,tag=value field=1 1234567890

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

执行 SQL 查询

执行 SQL 查询以从指定的数据库检索数据。

授权

BearerAuth

查询参数

db 必需	string 数据库的名称。
format	string
q 必需	string

头部参数

Accept	string 默认值: application/json 枚举: "application/json" "application/jsonl" "application/vnd.apache.parquet" "text/csv" 客户端可以理解的内容类型。
Content-Type	string 值: "application/json" 请求主体中数据的格式。

响应

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

执行 SQL 查询

执行 SQL 查询以从指定的数据库检索数据。

授权

BearerAuth

头部参数

Accept	string 默认值: application/json 枚举: "application/json" "application/jsonl" "application/vnd.apache.parquet" "text/csv" 客户端可以理解的内容类型。
Content-Type	string 值: "application/json" 请求主体中数据的格式。

请求主体模式: application/json

database 必需	string 要查询的数据库的名称。如果查询 (`query_str`) 未指定数据库，则为必需。
format	string 枚举: "json" "csv" "parquet" "jsonl" "pretty" 查询结果的格式。
	object 查询的附加参数。使用此字段传递查询参数。
query_str 必需	string 要执行的查询。

响应

请求示例

负载

内容类型

application/json

{"database": "mydb",
"query_str": "SELECT * FROM mytable",
"format": "json",
"params": { }
}

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

执行 InfluxQL 查询

执行 InfluxQL 查询以从指定的数据库检索数据。

授权

BearerAuth

查询参数

db	string 数据库的名称。如果您提供的查询指定了数据库，则可以从请求中省略 'db' 参数。
format	string
q 必需	string

头部参数

Accept

string

默认值: application/json

枚举: "application/json" "application/jsonl" "application/vnd.apache.parquet" "text/csv"

客户端可以理解的内容类型。

响应

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

执行 InfluxQL 查询

执行 InfluxQL 查询以从指定的数据库检索数据。

授权

BearerAuth

头部参数

Accept	string 默认值: application/json 枚举: "application/json" "application/jsonl" "application/vnd.apache.parquet" "text/csv" 客户端可以理解的内容类型。
Content-Type	string 值: "application/json" 请求主体中数据的格式。

请求主体模式: application/json

database 必需	string 要查询的数据库的名称。如果查询 (`query_str`) 未指定数据库，则为必需。
format	string 枚举: "json" "csv" "parquet" "jsonl" "pretty" 查询结果的格式。
	object 查询的附加参数。使用此字段传递查询参数。
query_str 必需	string 要执行的查询。

响应

请求示例

负载

内容类型

application/json

{"database": "mydb",
"query_str": "SELECT * FROM mytable",
"format": "json",
"params": { }
}

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

执行 InfluxQL 查询 (v1 兼容)

执行 InfluxQL 查询以从指定的数据库检索数据。

此端点与 InfluxDB 1.x 客户端库和第三方集成（如 Grafana）兼容。使用查询参数指定数据库和 InfluxQL 查询。

授权

BearerAuth

查询参数

chunk_size	integer 默认值: 10000 将进入一个块的记录数。仅当 `chunked=true` 时才使用此参数。
chunked	boolean 默认值: false 如果为 true，则响应将分为大小为 `chunk_size` 的块。
db	string <InfluxQL> 要查询的数据库。如果未提供，则 InfluxQL 查询字符串必须指定数据库。
epoch	string (EpochCompatibility) 枚举: "ns" "u" "µ" "ms" "s" "m" "h" 将时间戳格式化为具有指定精度的 unix（纪元）时间戳，而不是具有纳秒精度的 RFC3339 时间戳。
pretty	boolean 默认值: false 如果为 true，则 JSON 响应将以人类可读的格式格式化。
q 必需	string InfluxQL 查询字符串。

头部参数

Accept

string

默认值: application/json

枚举: "application/json" "application/csv" "text/csv"

客户端可以理解的内容类型。

如果指定 text/csv，则 Content-type 响应标头为 application/csv，并且响应格式为 CSV。

如果格式无效或非 UTF8，则返回错误。

响应

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

执行 InfluxQL 查询 (v1 兼容)

执行 InfluxQL 查询以从指定的数据库检索数据。

授权

BearerAuth

头部参数

Accept

string

默认值: application/json

枚举: "application/json" "application/csv" "text/csv"

客户端可以理解的内容类型。

如果指定 text/csv，则 Content-type 响应标头为 application/csv，并且响应格式为 CSV。

如果格式无效或非 UTF8，则返回错误。

请求主体模式: application/json

chunk_size	integer 默认值: 10000 将进入一个块的记录数。仅当 `chunked=true` 时才使用此参数。
chunked	boolean 如果为 true，则响应将分为大小为 `chunk_size` 的块。
db	string 要查询的数据库。如果未提供，则 InfluxQL 查询字符串必须指定数据库。
epoch	string 枚举: "ns" "u" "µ" "ms" "s" "m" "h" Unix 时间戳精度。 `h` 代表小时 `m` 代表分钟 `s` 代表秒 `ms` 代表毫秒 `u` 或 `µ` 代表微秒 `ns` 代表纳秒将时间戳格式化为具有指定精度的 unix（纪元）时间戳，而不是具有纳秒精度的 RFC3339 时间戳。
pretty	boolean 如果为 true，则 JSON 响应将以人类可读的格式格式化。
q 必需	string InfluxQL 查询字符串。

响应

请求示例

负载

内容类型

application/json

{"db": "string",
"q": "string",
"chunked": true,
"chunk_size": 10000,
"epoch": "ns",
"pretty": true
}

响应示例

200
401

内容类型

{"results": [{"series": [{"name": "mytable",
"columns": ["time",
"value"
],
"values": [["2024-02-02T12:00:00Z",
42
]
]
}
]
}
]
}

数据库

创建、读取、更新和删除数据库及缓存资源

列出数据库

检索数据库列表。

授权

BearerAuth

查询参数

format

必需

string (Format)

Enum: "json" "csv" "parquet" "jsonl"

响应正文中的数据格式。

响应

响应示例

200
401

内容类型

application/json

{"databases": ["string"
]
}

创建数据库

在系统中创建新的数据库。

授权

BearerAuth

请求主体模式: application/json

db

必需

string

响应

请求示例

负载

内容类型

application/json

{"db": "string"
}

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

删除数据库

软删除数据库。数据库已计划删除且不可用于查询。

授权

BearerAuth

查询参数

db

必需

string

数据库的名称。

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

处理引擎

管理处理引擎触发器、测试插件以及发送请求以触发“按需”插件。

InfluxDB 3 Core 提供 InfluxDB 3 处理引擎，这是一个嵌入式 Python VM，可以动态加载和触发 Python 插件以响应数据库中的事件。使用处理引擎插件和触发器来运行代码并执行不同数据库事件的任务。

要开始使用处理引擎，请参阅处理引擎和 Python 插件指南。

创建处理引擎触发器

创建新的处理引擎触发器。

授权

BearerAuth

请求主体模式: application/json

db 必需	string
disabled	boolean
plugin_filename 必需	string
	object
trigger_name 必需	string
trigger_specification 必需	string

响应

请求示例

负载

内容类型

application/json

{"db": "string",
"plugin_filename": "string",
"trigger_name": "string",
"trigger_specification": "string",
"trigger_arguments": { },
"disabled": true
}

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

删除处理引擎触发器

删除处理引擎触发器。

授权

BearerAuth

查询参数

db 必需	string 数据库的名称。
force	boolean 默认值: false
trigger_name 必需	string

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

禁用处理引擎触发器

禁用处理引擎触发器。

授权

BearerAuth

头部参数

Content-Type

string

值: "application/json"

请求主体中数据的格式。

请求主体模式: application/json

db 必需	string
disabled	boolean
plugin_filename 必需	string
	object
trigger_name 必需	string
trigger_specification 必需	string

响应

请求示例

负载

内容类型

application/json

{"db": "string",
"plugin_filename": "string",
"trigger_name": "string",
"trigger_specification": "string",
"trigger_arguments": { },
"disabled": true
}

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

启用处理引擎触发器

启用处理引擎触发器。

授权

BearerAuth

头部参数

Content-Type

string

值: "application/json"

请求主体中数据的格式。

请求主体模式: application/json

db 必需	string
disabled	boolean
plugin_filename 必需	string
	object
trigger_name 必需	string
trigger_specification 必需	string

响应

请求示例

负载

内容类型

application/json

{"db": "string",
"plugin_filename": "string",
"trigger_name": "string",
"trigger_specification": "string",
"trigger_arguments": { },
"disabled": true
}

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

安装插件包

为插件环境安装包。

授权

BearerAuth

头部参数

Content-Type

string

值: "application/json"

请求主体中数据的格式。

请求主体模式: application/json

属性名称*

any

响应

请求示例

负载

内容类型

application/json

{ }

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

安装插件需求

为插件环境安装需求。

授权

BearerAuth

头部参数

Content-Type

string

值: "application/json"

请求主体中数据的格式。

请求主体模式: application/json

属性名称*

any

响应

请求示例

负载

内容类型

application/json

{ }

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

测试 WAL 插件

执行预写日志 (WAL) 插件的测试。

授权

BearerAuth

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

测试调度插件

执行调度插件的测试。

授权

BearerAuth

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

按需处理引擎插件请求

发送请求以调用按需处理引擎插件。请求可以包含请求标头、查询字符串参数和请求正文，InfluxDB 将其传递给插件。

按需插件实现以下签名

def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None)

响应取决于插件实现。

授权

BearerAuth

路径参数

plugin_path

必需

string

在插件的 trigger-spec 中配置的路径。

例如，如果您使用以下内容定义触发器

trigger-spec: "request:hello-world"

然后，HTTP API 公开以下插件端点

<INFLUXDB_HOST>/api/v3/engine/hello-world

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

按需处理引擎插件请求

发送请求以调用按需处理引擎插件。请求可以包含请求标头、查询字符串参数和请求正文，InfluxDB 将其传递给插件。

按需插件实现以下签名

def process_request(influxdb3_local, query_parameters, request_headers, request_body, args=None)

响应取决于插件实现。

授权

BearerAuth

路径参数

plugin_path

必需

string

在插件的 trigger-spec 中配置的路径。

例如，如果您使用以下内容定义触发器

trigger-spec: "request:hello-world"

然后，HTTP API 公开以下插件端点

<INFLUXDB_HOST>/api/v3/engine/hello-world

头部参数

Content-Type

string

值: "application/json"

请求主体中数据的格式。

请求主体模式: application/json

属性名称*

any

响应

请求示例

负载

内容类型

application/json

{ }

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

服务器信息

检索服务器指标、状态和版本信息

健康检查

检查服务的状态。

授权

BearerAuth

响应

健康检查 (v1)

检查服务的状态。

授权

BearerAuth

响应

Ping 服务器

返回服务器的版本信息。

授权

BearerAuth

响应

响应示例

200

内容类型

application/json

{"version": "0.1.0",
"revision": "f3d3d3d"
}

指标

检索 Prometheus 兼容的服务器指标。

授权

BearerAuth

响应

表格

管理表格模式和数据

创建表格

在数据库中创建新表格。

授权

BearerAuth

请求主体模式: application/json

db 必需	string
	Array of objects
table 必需	string
tags 必需	Array of strings

响应

请求示例

负载

内容类型

application/json

{"db": "string",
"table": "string",
"tags": ["string"
],
"fields": [{"name": "string",
"type": "utf8"
}
]
}

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

删除表格

软删除表格。表格已计划删除且不可用于查询。

授权

BearerAuth

查询参数

db 必需	string 数据库的名称。
table 必需	string

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

创建去重缓存

为表格创建去重缓存。

授权

BearerAuth

请求主体模式: application/json

columns 必需	Array of strings
db 必需	string
max_age	integer 可选的最大期限（秒）。
max_cardinality	integer 可选的最大基数。
name	string 可选的缓存名称。
table 必需	string

响应

请求示例

负载

内容类型

application/json

{"db": "mydb",
"table": "mytable",
"columns": ["tag1",
"tag2"
],
"max_cardinality": 1000,
"max_age": 3600
}

创建最后缓存

为表格创建最后缓存。

授权

BearerAuth

请求主体模式: application/json

count	integer 可选的计数。
db 必需	string
key_columns	Array of strings 可选的键列列表。
name	string 可选的缓存名称。
table 必需	string
ttl	integer 可选的生存时间（秒）。
value_columns	Array of strings 可选的值列列表。

响应

请求示例

负载

内容类型

application/json

{"db": "mydb",
"table": "mytable",
"key_columns": ["tag1"
],
"value_columns": ["field1"
],
"count": 100,
"ttl": 3600
}

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}

删除最后缓存

删除最后缓存。

授权

BearerAuth

查询参数

db 必需	string 数据库的名称。
name 必需	string
table 必需	string

响应

响应示例

401

内容类型

application/json

{"error": "string",
"data": { }
}