105 lines
3.6 KiB
Markdown
105 lines
3.6 KiB
Markdown
---
|
|
title: Query with the InfluxDB API
|
|
description: Query InfluxDB with the InfluxDB API. Discover how to query data in InfluxDB 2.0 using the InfluxDB API.
|
|
weight: 202
|
|
menu:
|
|
influxdb_2_0:
|
|
name: Query with the InfluxDB API
|
|
parent: Execute queries
|
|
influxdb/v2.0/tags: [query]
|
|
---
|
|
|
|
The [InfluxDB v2 API](/influxdb/v2.0/reference/api) provides a programmatic interface for all interactions with InfluxDB. To query InfluxDB 2.0, do one of the following:
|
|
|
|
- Send a Flux query request to the [`/api/v2/query`](/influxdb/v2.0/api/#operation/PostQueryAnalyze) endpoint.
|
|
- Send an InfluxQL query request to the [/query 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/query/).
|
|
|
|
In your request, set the following:
|
|
|
|
- Your organization via the `org` or `orgID` URL parameters.
|
|
- `Authorization` header to `Token ` + your API token.
|
|
- `Accept` header to `application/csv`.
|
|
- `Content-type` header to `application/vnd.flux` (Flux only) or `application/json` (Flux or InfluxQL).
|
|
- Query in Flux or InfluxQL with the request's raw data.
|
|
|
|
{{% note %}}
|
|
#### Use gzip to compress the query response
|
|
|
|
To compress the query response, set the `Accept-Encoding` header to `gzip`.
|
|
This saves network bandwidth, but increases server-side load.
|
|
{{% /note %}}
|
|
|
|
#### Flux - Example query request
|
|
|
|
Below is an example `curl` request that sends a Flux query to InfluxDB 2.0:
|
|
|
|
{{< code-tabs-wrapper >}}
|
|
{{% code-tabs %}}
|
|
[Without compression](#)
|
|
[With compression](#)
|
|
{{% /code-tabs %}}
|
|
|
|
{{% code-tab-content %}}
|
|
```bash
|
|
curl --request POST \
|
|
http://localhost:8086/api/v2/query?org=my-org \
|
|
--header 'Authorization: Token YOUR_API_TOKEN' \
|
|
--header 'Accept: application/csv' \
|
|
--header 'Content-type: application/vnd.flux' \
|
|
--data 'from(bucket:"example-bucket")
|
|
|> range(start: -12h)
|
|
|> filter(fn: (r) => r._measurement == "example-measurement")
|
|
|> aggregateWindow(every: 1h, fn: mean)'
|
|
```
|
|
{{% /code-tab-content %}}
|
|
|
|
{{% code-tab-content %}}
|
|
```bash
|
|
curl --request POST \
|
|
http://localhost:8086/api/v2/query?org=my-org \
|
|
--header 'Authorization: Token YOUR_API_TOKEN' \
|
|
--header 'Accept: application/csv' \
|
|
--header 'Content-type: application/vnd.flux' \
|
|
--header 'Accept-Encoding: gzip' \
|
|
--data 'from(bucket:"example-bucket")
|
|
|> range(start: -12h)
|
|
|> filter(fn: (r) => r._measurement == "example-measurement")
|
|
|> aggregateWindow(every: 1h, fn: mean)'
|
|
```
|
|
{{% /code-tab-content %}}
|
|
{{< /code-tabs-wrapper >}}
|
|
|
|
#### InfluxQL - Example query request
|
|
|
|
Below is an example `curl` request that sends an InfluxQL query to InfluxDB 2.0:
|
|
|
|
{{< code-tabs-wrapper >}}
|
|
{{% code-tabs %}}
|
|
[Without compression](#)
|
|
[With compression](#)
|
|
{{% /code-tabs %}}
|
|
|
|
{{% code-tab-content %}}
|
|
```bash
|
|
curl --request -G http://localhost:8086/query?org=my-org?database=MyDB&retention_policy=MyRP \
|
|
--header 'Authorization: Token YOUR_API_TOKEN' \
|
|
--header 'Accept: application/csv' \
|
|
--header 'Content-type: application/json' \
|
|
--data-urlencode "q=SELECT used_percent FROM example-db.example-rp.example-measurement WHERE host=host1"
|
|
```
|
|
{{% /code-tab-content %}}
|
|
|
|
{{% code-tab-content %}}
|
|
```bash
|
|
curl --request -G http://localhost:8086/query?org=my-org?database=MyDB&retention_policy=MyRP \
|
|
--header 'Authorization: Token YOUR_API_TOKEN' \
|
|
--header 'Accept: application/csv' \
|
|
--header 'Content-type: application/json' \
|
|
--header 'Accept-Encoding: gzip' \
|
|
--data-urlencode "q=SELECT used_percent FROM example-db.example-rp.example-measurement WHERE host=host1"
|
|
```
|
|
{{% /code-tab-content %}}
|
|
{{< /code-tabs-wrapper >}}
|
|
|
|
InfluxDB returns the query results in [annotated CSV](/influxdb/v2.0/reference/syntax/annotated-csv/).
|