4.3 KiB
title | seotitle | list_title | description | weight | menu | influxdb3/clustered/tags | metadata | related | aliases | list_code_example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Use the InfluxDB v1 HTTP query API and InfluxQL to query data | Use InfluxQL and InfluxDB v1 HTTP query API | Use the v1 query API and InfluxQL | Use the InfluxDB v1 HTTP query API to query data in InfluxDB Clustered with InfluxQL. | 301 |
|
|
|
|
|
```sh curl --get https://{{< influxdb/host >}}/query \ --header "Authorization: Token DATABASE_TOKEN" \ --data-urlencode "db=DATABASE_NAME" \ --data-urlencode "q=SELECT * FROM home" ``` |
Use the InfluxDB v1 HTTP query API to query data in {{< product-name >}} with InfluxQL.
The examples below use cURL to send HTTP requests to the InfluxDB v1 HTTP API, but you can use any HTTP client.
{{% warn %}}
InfluxQL feature support
InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine. This process is ongoing and some InfluxQL features are still being implemented. For information about the current implementation status of InfluxQL features, see InfluxQL feature support. {{% /warn %}}
Use the v1 /query
endpoint and the GET
request method to query data with InfluxQL:
{{< api-endpoint endpoint="https://{{< influxdb/host >}}/query" method="get" api-ref="/influxdb3/clustered/api/#tag/Query" >}}
Provide the following with your request:
- Headers:
- Authorization:
Bearer DATABASE_TOKEN
- Authorization:
- Query parameters:
- db: the database to query
- rp: Optional: the retention policy to query
- q: URL-encoded InfluxQL query
{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
curl --get https://{{< influxdb/host >}}/query \
--header "Authorization: Bearer DATABASE_TOKEN" \
--data-urlencode "db=DATABASE_NAME" \
--data-urlencode "q=SELECT * FROM home"
{{% /code-placeholders %}}
Replace the following configuration values:
- {{% code-placeholder-key %}}
DATABASE_NAME
{{% /code-placeholder-key %}}: the name of the database to query. - {{% code-placeholder-key %}}
DATABASE_TOKEN
{{% /code-placeholder-key %}}: a database token with read access to the specified database.
{{% note %}}
Authenticate with username and password
If using basic authentication or query string authentication (username and password) to interact with the v1 HTTP query API, provide the following credentials:
- username: an arbitrary string ({{< product-name >}} ignores the username)
- password: a database token with read access to the specified database.
{{< code-tabs-wrapper >}} {{% code-tabs %}} Basic Auth Query String Auth {{% /code-tabs %}}
{{% code-tab-content %}} {{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
curl --get https://{{< influxdb/host >}}/query \
--header "Authorization: Basic ignored:DATABASE_TOKEN" \
--data-urlencode "db=DATABASE_NAME" \
--data-urlencode "q=SELECT * FROM home"
{{% /code-placeholders %}} {{% /code-tab-content %}}
{{% code-tab-content %}} {{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
curl --get https://{{< influxdb/host >}}/query \
--data-urlencode "u=ignored" \
--data-urlencode "p=DATABASE_TOKEN" \
--data-urlencode "db=DATABASE_NAME" \
--data-urlencode "q=SELECT * FROM home"
{{% /code-placeholders %}} {{% /code-tab-content %}}
{{< /code-tabs-wrapper >}} {{% /note %}}
Return results as JSON or CSV
By default, the /query
endpoint returns results in JSON, but it can also
return results in CSV. To return results as CSV, include the Accept
header
with the application/csv
or text/csv
MIME type:
{{% code-placeholders "DATABASE_(NAME|TOKEN)" %}}
curl --get https://{{< influxdb/host >}}/query \
--header "Authorization: Token DATABASE_TOKEN" \
--header "Accept: application/csv" \
--data-urlencode "db=DATABASE_NAME" \
--data-urlencode "q=SELECT * FROM home"
{{% /code-placeholders %}}