Merge pull request #5870 from influxdata/core-enterprise-api-ref
API reference docs (with OpenAPI specs) for Core and Enterprisepull/5879/head^2
Jason Stirnaman
GitHub
commit
3b359899a3
|
|
@ -0,0 +1,11 @@
|
|||
extends: substitution
|
||||
message: Did you mean '%s' instead of '%s'
|
||||
level: warning
|
||||
ignorecase: false
|
||||
# swap maps tokens in form of bad: good
|
||||
# NOTE: The left-hand (bad) side can match the right-hand (good) side;
|
||||
# Vale ignores alerts that match the intended form.
|
||||
swap:
|
||||
'cloud-serverless|cloud-dedicated|clustered': core
|
||||
'Cloud Serverless|Cloud Dedicated|Clustered': Core
|
||||
'API token': database token
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
extends: substitution
|
||||
message: Did you mean '%s' instead of '%s'
|
||||
level: warning
|
||||
ignorecase: false
|
||||
# swap maps tokens in form of bad: good
|
||||
# NOTE: The left-hand (bad) side can match the right-hand (good) side;
|
||||
# Vale ignores alerts that match the intended form.
|
||||
swap:
|
||||
'(?i)bucket': database
|
||||
'(?i)measurement': table
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "Title of the page"
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "Page description that supports multi-line text"
|
||||
},
|
||||
"menu": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"influxdb3_core": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Menu item name"
|
||||
}
|
||||
},
|
||||
"required": ["name"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"weight": {
|
||||
"type": "integer",
|
||||
"description": "Order weight for menu items",
|
||||
"minimum": 0
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"description": "Path to source content file",
|
||||
"pattern": "^/shared/.+\\.md$"
|
||||
}
|
||||
},
|
||||
"required": ["title", "description", "menu", "weight"]
|
||||
}
|
||||
|
|
@ -8,7 +8,7 @@ node_modules
|
|||
*.log
|
||||
/resources
|
||||
.hugo_build.lock
|
||||
/content/influxdb/*/api/**/*.html
|
||||
/content/influxdb*/**/api/**/*.html
|
||||
/api-docs/redoc-static.html*
|
||||
.vscode/*
|
||||
.idea
|
||||
|
|
|
|||
|
|
@ -1,4 +1,17 @@
|
|||
{
|
||||
"vale.valeCLI.config": " \"${workspaceFolder}/.vale.ini\"",
|
||||
"commentAnchors.tags.anchors":
|
||||
{ "SOURCE": {
|
||||
"scope": "file",
|
||||
"behavior": "link",
|
||||
"iconColor": "#FF0000",
|
||||
"highlightColor": "#FF0000",
|
||||
"style": "bold"
|
||||
}},
|
||||
"commentAnchors.workspace.matchFiles": "**/*.{md,ini,json,yaml,yml}",
|
||||
"commentAnchors.workspace.enabled": true,
|
||||
"yaml.schemas": {
|
||||
"./.frontmatter-schema.json": "${workspaceFolder}/content/**/*.md"
|
||||
},
|
||||
"vale.valeCLI.config": "${workspaceFolder}/.vale.ini",
|
||||
"vale.valeCLI.minAlertLevel": "warning",
|
||||
}
|
||||
|
|
@ -46,9 +46,10 @@ To install dependencies listed in package.json:
|
|||
4. Install the Yarn package manager and run `yarn` to install project dependencies.
|
||||
|
||||
`package.json` contains dependencies for linting and running Git hooks.
|
||||
docs-v2 uses [Lefthook](https://github.com/evilmartians/lefthook) to configure and manage pre-commit hooks for linting and testing Markdown content.
|
||||
|
||||
Other dependencies used in the project:
|
||||
|
||||
- **[husky](https://github.com/typicode/husky)**: manages Git hooks, including the pre-commit hook for linting and testing
|
||||
- **[lint-staged](https://github.com/lint-staged/lint-staged)**: passes staged files to commands
|
||||
- **[prettier](https://prettier.io/docs/en/)**: formats code, including Markdown, according to style rules for consistency
|
||||
|
||||
### Install Docker
|
||||
|
|
@ -65,13 +66,24 @@ The tests defined in `compose.yaml` use the dependencies and execution
|
|||
environment from this image.
|
||||
|
||||
```bash
|
||||
docker build -t influxdata:docs-pytest -f Dockerfile.pytest .
|
||||
docker build -t influxdata/docs-pytest:latest -f Dockerfile.pytest .
|
||||
```
|
||||
|
||||
### Run the documentation locally (optional)
|
||||
|
||||
To run the documentation locally, follow the instructions provided in the README.
|
||||
|
||||
### Install Visual Studio Code extensions
|
||||
|
||||
If you use Microsoft Visual Studio (VS) Code, you can install extensions
|
||||
to help you navigate, check, and edit files.
|
||||
|
||||
docs-v2 contains a `./.vscode/settings.json` that configures the following extensions:
|
||||
|
||||
- Comment Anchors: recognizes tags (for example, `//SOURCE`) and makes links and filepaths clickable in comments.
|
||||
- Vale: shows linter errors and suggestions in the editor.
|
||||
- YAML Schemas: validates frontmatter attributes.
|
||||
|
||||
### Make your changes
|
||||
|
||||
Make your suggested changes being sure to follow the [style and formatting guidelines](#style--formatting) outline below.
|
||||
|
|
@ -80,15 +92,15 @@ Make your suggested changes being sure to follow the [style and formatting guide
|
|||
|
||||
### Automatic pre-commit checks
|
||||
|
||||
docs-v2 uses Husky to manage Git hook scripts.
|
||||
When you try to commit your changes (for example, `git commit`), Git runs
|
||||
scripts configured in `.husky/pre-commit`, including linting and tests for your **staged** files.
|
||||
docs-v2 uses Lefthook to manage Git hooks, such as pre-commit hooks that lint Markdown and test code blocks.
|
||||
When you try to commit changes (`git commit`), Git runs
|
||||
the commands configured in `lefthook.yml` which pass your **staged** files to Vale, Prettier, and Pytest (in a Docker container).
|
||||
|
||||
### Skip pre-commit hooks
|
||||
|
||||
**We strongly recommend running linting and tests**, but you can skip them
|
||||
(and avoid installing dependencies)
|
||||
by including the `HUSKY=0` environment variable or the `--no-verify` flag with
|
||||
by including the `LEFTHOOK=0` environment variable or the `--no-verify` flag with
|
||||
your commit--for example:
|
||||
|
||||
```sh
|
||||
|
|
@ -96,11 +108,9 @@ git commit -m "<COMMIT_MESSAGE>" --no-verify
|
|||
```
|
||||
|
||||
```sh
|
||||
HUSKY=0 git commit
|
||||
LEFTHOOK=0 git commit
|
||||
```
|
||||
|
||||
For more options, see the [Husky documentation](https://typicode.github.io/husky/how-to.html#skipping-git-hooks).
|
||||
|
||||
### Set up test scripts and credentials
|
||||
|
||||
To set up your docs-v2 instance to run tests locally, do the following:
|
||||
|
|
|
|||
|
|
@ -32,7 +32,13 @@ RUN apt-get update && apt-get upgrade -y && apt-get install -y \
|
|||
python3-venv \
|
||||
rsync \
|
||||
telegraf \
|
||||
wget
|
||||
wget \
|
||||
yq
|
||||
|
||||
# Install InfluxDB 3 Core
|
||||
RUN curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& chmod +x install_influxdb3.sh \
|
||||
&& bash -c yes | ./install_influxdb3.sh
|
||||
|
||||
RUN ln -s /usr/bin/python3 /usr/bin/python
|
||||
|
||||
|
|
|
|||
|
|
@ -237,7 +237,7 @@ InfluxDB Cloud releases are frequent and not versioned, so the Cloud API spec is
|
|||
We regenerate API reference docs from `influxdata/openapi`
|
||||
**master** branch as features are released.
|
||||
|
||||
### InfluxDB OSS version
|
||||
### InfluxDB OSS v2 version
|
||||
|
||||
Given that
|
||||
`influxdata/openapi` **master** may contain OSS spec changes not implemented
|
||||
|
|
|
|||
|
|
@ -41,7 +41,6 @@ function generateHtml {
|
|||
local productName="$3"
|
||||
local api="$4"
|
||||
local configPath="$5"
|
||||
local isDefault=$6
|
||||
|
||||
# Use the product name to define the menu for the Hugo template
|
||||
local menu="$(echo $productVersion | sed 's/\./_/g;s/-/_/g;s/\//_/g;')"
|
||||
|
|
@ -55,12 +54,23 @@ function generateHtml {
|
|||
# Use the title and summary defined in the product API's info.yml file.
|
||||
local title=$(yq '.title' $productVersion/$apiName/content/info.yml)
|
||||
local menuTitle=$(yq '.x-influxdata-short-title' $productVersion/$apiName/content/info.yml)
|
||||
local description=$(yq '.summary' $productVersion/$apiName/content/info.yml)
|
||||
# Get the shortened description to use for metadata.
|
||||
local shortDescription=$(yq '.x-influxdata-short-description' $productVersion/$apiName/content/info.yml)
|
||||
# Get the aliases array from the configuration file.
|
||||
local aliases=$(yq e ".apis | .$api | .x-influxdata-docs-aliases" "$configPath")
|
||||
# If aliases is null, set it to an empty YAML array.
|
||||
if [[ "$aliases" == "null" ]]; then
|
||||
aliases='[]'
|
||||
fi
|
||||
local weight=102
|
||||
if [[ $apiName == "v1-compatibility" ]]; then
|
||||
weight=304
|
||||
fi
|
||||
# Define the file name for the Redoc HTML output.
|
||||
local specbundle=redoc-static_index.html
|
||||
# Define the temporary file for the Hugo template and Redoc HTML.
|
||||
local tmpfile="${productVersion}-${api}_index.tmp"
|
||||
|
||||
|
||||
echo "Bundling $specPath"
|
||||
|
||||
# Use npx to install and run the specified version of redoc-cli.
|
||||
|
|
@ -70,75 +80,31 @@ function generateHtml {
|
|||
npm_config_yes=true npx redoc-cli@0.12.3 bundle $specPath \
|
||||
--config $configPath \
|
||||
-t template.hbs \
|
||||
--title=$title \
|
||||
--title="$title" \
|
||||
--options.sortPropsAlphabetically \
|
||||
--options.menuToggle \
|
||||
--options.hideDownloadButton \
|
||||
--options.hideHostname \
|
||||
--options.noAutoAuth \
|
||||
--output=$specbundle \
|
||||
--templateOptions.description=$description \
|
||||
--templateOptions.description="$shortDescription" \
|
||||
--templateOptions.product="$productVersion" \
|
||||
--templateOptions.productName="$productName"
|
||||
|
||||
if [[ $apiName == "v1-compatibility" ]]; then
|
||||
frontmatter="---
|
||||
title: $title
|
||||
description: $description
|
||||
layout: api
|
||||
menu:
|
||||
$menu:
|
||||
parent: InfluxDB HTTP API
|
||||
name: $menuTitle
|
||||
identifier: api-reference-$apiName
|
||||
weight: 304
|
||||
aliases:
|
||||
- /influxdb/$versionDir/api/v1/
|
||||
local frontmatter=$(yq eval -n \
|
||||
".title = \"$title\" |
|
||||
.description = \"$shortDescription\" |
|
||||
.layout = \"api\" |
|
||||
.weight = $weight |
|
||||
.menu.[\"$menu\"].parent = \"InfluxDB HTTP API\" |
|
||||
.menu.[\"$menu\"].name = \"$menuTitle\" |
|
||||
.menu.[\"$menu\"].identifier = \"api-reference-$apiName\" |
|
||||
.aliases = \"$aliases\"")
|
||||
|
||||
frontmatter="---
|
||||
$frontmatter
|
||||
---
|
||||
"
|
||||
elif [[ $apiVersion == "0" ]]; then
|
||||
echo $productName $apiName
|
||||
frontmatter="---
|
||||
title: $title
|
||||
description: $description
|
||||
layout: api
|
||||
weight: 102
|
||||
menu:
|
||||
$menu:
|
||||
parent: InfluxDB HTTP API
|
||||
name: $menuTitle
|
||||
identifier: api-reference-$apiName
|
||||
---
|
||||
"
|
||||
elif [[ $isDefault == true ]]; then
|
||||
frontmatter="---
|
||||
title: $title
|
||||
description: $description
|
||||
layout: api
|
||||
menu:
|
||||
$menu:
|
||||
parent: InfluxDB HTTP API
|
||||
name: $menuTitle
|
||||
identifier: api-reference-$apiName
|
||||
weight: 102
|
||||
aliases:
|
||||
- /influxdb/$versionDir/api/
|
||||
---
|
||||
"
|
||||
else
|
||||
frontmatter="---
|
||||
title: $title
|
||||
description: $description
|
||||
layout: api
|
||||
menu:
|
||||
$menu:
|
||||
parent: InfluxDB HTTP API
|
||||
name: $menuTitle
|
||||
identifier: api-reference-$apiName
|
||||
weight: 102
|
||||
---
|
||||
"
|
||||
fi
|
||||
|
||||
# Create the Hugo template file with the frontmatter and Redoc HTML
|
||||
echo "$frontmatter" >> $tmpfile
|
||||
|
|
@ -174,9 +140,10 @@ function build {
|
|||
# Get the version API configuration file.
|
||||
local configPath="$version/.config.yml"
|
||||
if [ ! -f "$configPath" ]; then
|
||||
configPath=".config.yml"
|
||||
# Skip to the next version if the configuration file doesn't exist.
|
||||
continue
|
||||
fi
|
||||
echo "Using config $configPath"
|
||||
echo "Using config $version $configPath"
|
||||
# Get the product name from the configuration.
|
||||
local versionName
|
||||
versionName=$(yq e '.x-influxdata-product-name' "$configPath")
|
||||
|
|
@ -198,13 +165,7 @@ function build {
|
|||
if [ -d "$specPath" ] || [ ! -f "$specPath" ]; then
|
||||
echo "OpenAPI spec $specPath doesn't exist."
|
||||
fi
|
||||
# Get default status from the configuration.
|
||||
local isDefault=false
|
||||
local defaultStatus
|
||||
defaultStatus=$(yq e ".apis | .$api | .x-influxdata-default" "$configPath")
|
||||
if [[ $defaultStatus == "true" ]]; then
|
||||
isDefault=true
|
||||
fi
|
||||
|
||||
|
||||
# If the spec file differs from master, regenerate the HTML.
|
||||
local update=0
|
||||
|
|
@ -218,9 +179,9 @@ function build {
|
|||
|
||||
if [[ $update -eq 0 ]]; then
|
||||
echo "Regenerating $version $api"
|
||||
generateHtml "$specPath" "$version" "$versionName" "$api" "$configPath" "$isDefault"
|
||||
generateHtml "$specPath" "$version" "$versionName" "$api" "$configPath"
|
||||
fi
|
||||
echo "========Done with $version $api========"
|
||||
echo -e "========Finished $version $api========\n\n"
|
||||
done <<< "$apis"
|
||||
done
|
||||
}
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ function showHelp {
|
|||
subcommand=$1
|
||||
|
||||
case "$subcommand" in
|
||||
cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|v2|v1-compat|all)
|
||||
cloud-dedicated-v2|cloud-dedicated-management|cloud-serverless-v2|clustered-v2|cloud-v2|v2|v1-compat|core-v3|enterprise-v3|all)
|
||||
product=$1
|
||||
shift
|
||||
|
||||
|
|
@ -176,17 +176,6 @@ function updateCloudDedicatedV2 {
|
|||
postProcess $outFile 'influxdb3/cloud-dedicated/.config.yml' v2@2
|
||||
}
|
||||
|
||||
function updateClusteredV2 {
|
||||
outFile="influxdb3/clustered/v2/ref.yml"
|
||||
if [[ -z "$baseUrl" ]];
|
||||
then
|
||||
echo "Using existing $outFile"
|
||||
else
|
||||
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
|
||||
fi
|
||||
postProcess $outFile 'influxdb3/clustered/.config.yml' v2@2
|
||||
}
|
||||
|
||||
function updateCloudServerlessV2 {
|
||||
outFile="influxdb3/cloud-serverless/v2/ref.yml"
|
||||
if [[ -z "$baseUrl" ]];
|
||||
|
|
@ -198,15 +187,50 @@ function updateCloudServerlessV2 {
|
|||
postProcess $outFile 'influxdb3/cloud-serverless/.config.yml' v2@2
|
||||
}
|
||||
|
||||
function updateClusteredV2 {
|
||||
outFile="influxdb3/clustered/v2/ref.yml"
|
||||
if [[ -z "$baseUrl" ]];
|
||||
then
|
||||
echo "Using existing $outFile"
|
||||
else
|
||||
curl $UPDATE_OPTIONS ${baseUrl}/contracts/ref/cloud.yml -o $outFile
|
||||
fi
|
||||
postProcess $outFile 'influxdb3/clustered/.config.yml' v2@2
|
||||
}
|
||||
|
||||
function updateCoreV3 {
|
||||
outFile="influxdb3/core/v3/ref.yml"
|
||||
if [[ -z "$baseUrl" ]];
|
||||
then
|
||||
echo "Using existing $outFile"
|
||||
else
|
||||
local url="${baseUrl}/TO_BE_DECIDED"
|
||||
curl $UPDATE_OPTIONS $url -o $outFile
|
||||
fi
|
||||
postProcess $outFile 'influxdb3/core/.config.yml' v3@3
|
||||
}
|
||||
|
||||
function updateEnterpriseV3 {
|
||||
outFile="influxdb3/enterprise/v3/ref.yml"
|
||||
if [[ -z "$baseUrl" ]];
|
||||
then
|
||||
echo "Using existing $outFile"
|
||||
else
|
||||
local url="${baseUrl}/TO_BE_DECIDED"
|
||||
curl $UPDATE_OPTIONS $url -o $outFile
|
||||
fi
|
||||
postProcess $outFile 'influxdb3/enterprise/.config.yml' v3@3
|
||||
}
|
||||
|
||||
function updateOSSV2 {
|
||||
outFile="influxdb/v2/ref.yml"
|
||||
outFile="influxdb/v2/v2/ref.yml"
|
||||
if [[ -z "$baseUrlOSS" ]];
|
||||
then
|
||||
echo "Using existing $outFile"
|
||||
else
|
||||
curl $UPDATE_OPTIONS ${baseUrlOSS}/contracts/ref/oss.yml -o $outFile
|
||||
fi
|
||||
postProcess $outFile 'influxdb/v2/.config.yml' '@2'
|
||||
postProcess $outFile 'influxdb/v2/.config.yml' 'v2@2'
|
||||
}
|
||||
|
||||
function updateV1Compat {
|
||||
|
|
@ -220,7 +244,7 @@ function updateV1Compat {
|
|||
postProcess $outFile 'influxdb/cloud/.config.yml' 'v1-compatibility'
|
||||
|
||||
outFile="influxdb/v2/v1-compatibility/swaggerV1Compat.yml"
|
||||
cp cloud/v1-compatibility/swaggerV1Compat.yml $outFile
|
||||
cp influxdb/cloud/v1-compatibility/swaggerV1Compat.yml $outFile
|
||||
postProcess $outFile 'influxdb/v2/.config.yml' 'v1-compatibility'
|
||||
|
||||
outFile="influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml"
|
||||
|
|
@ -257,6 +281,12 @@ then
|
|||
elif [ "$product" = "clustered-v2" ];
|
||||
then
|
||||
updateClusteredV2
|
||||
elif [ "$product" = "core-v3" ];
|
||||
then
|
||||
updateCoreV3
|
||||
elif [ "$product" = "enterprise-v3" ];
|
||||
then
|
||||
updateEnterpriseV3
|
||||
elif [ "$product" = "v2" ];
|
||||
then
|
||||
updateOSSV2
|
||||
|
|
@ -270,9 +300,11 @@ then
|
|||
updateCloudDedicatedManagement
|
||||
updateCloudServerlessV2
|
||||
updateClusteredV2
|
||||
updateCoreV3
|
||||
updateEnterpriseV3
|
||||
updateOSSV2
|
||||
updateV1Compat
|
||||
else
|
||||
echo "Provide a product argument: cloud-v2, cloud-serverless-v2, cloud-dedicated-v2, clustered-v2, v2, v1-compat, or all."
|
||||
echo "Provide a product argument: cloud-v2, cloud-serverless-v2, cloud-dedicated-v2, cloud-dedicated-management, clustered-v2, core-v3, enterprise-v3, v2, v1-compat, or all."
|
||||
showHelp
|
||||
fi
|
||||
|
|
|
|||
|
|
@ -8,6 +8,9 @@ x-influxdata-product-name: InfluxDB v2 Cloud
|
|||
apis:
|
||||
v2@2:
|
||||
root: v2/ref.yml
|
||||
x-influxdata-default: true
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb/cloud/api/
|
||||
v1-compatibility@2:
|
||||
root: v1-compatibility/swaggerV1Compat.yml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb/cloud/api/v1/
|
||||
|
|
|
|||
|
|
@ -1,11 +1,17 @@
|
|||
title: InfluxDB v1 HTTP API for InfluxDB Cloud
|
||||
title: InfluxDB v1 HTTP API for InfluxDB Cloud (TSM)
|
||||
x-influxdata-short-title: v1 Compatibility API
|
||||
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints.
|
||||
x-influxdata-short-description: The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
|
||||
description: |
|
||||
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
|
||||
|
||||
The `/write` and `/query` endpoints support InfluxDB 1.x client libraries and third-party integrations such as Grafana.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
|
|||
|
|
@ -1,16 +1,21 @@
|
|||
openapi: 3.0.0
|
||||
info:
|
||||
title: InfluxDB v1 HTTP API for InfluxDB Cloud
|
||||
title: InfluxDB v1 HTTP API for InfluxDB Cloud (TSM)
|
||||
version: ''
|
||||
description: |
|
||||
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
|
||||
|
||||
The `/write` and `/query` endpoints support InfluxDB 1.x client libraries and third-party integrations such as Grafana.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
|
||||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: /
|
||||
security:
|
||||
|
|
@ -276,9 +281,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -327,12 +332,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
InfluxQLCSVResponse:
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
title: InfluxDB Cloud API Service
|
||||
x-influxdata-short-title: v2 API
|
||||
summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
|
||||
x-influxdata-short-description: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
|
||||
Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
|
||||
|
|
@ -10,3 +11,7 @@ version: 2.x
|
|||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -6,8 +6,5 @@
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- Data I/O endpoints
|
||||
- Security and access endpoints
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags: []
|
||||
|
|
|
|||
|
|
@ -3,14 +3,18 @@ info:
|
|||
title: InfluxDB Cloud API Service
|
||||
version: 2.x
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
|
||||
Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
|
||||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: https://{baseurl}
|
||||
description: InfluxDB Cloud API URL
|
||||
|
|
@ -97,8 +101,8 @@ tags:
|
|||
- name: Dashboards
|
||||
- name: Data I/O endpoints
|
||||
- description: |
|
||||
The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database)
|
||||
and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp).
|
||||
The InfluxDB 1.x data model includes [databases](/influxdb/cloud/reference/glossary/#database)
|
||||
and [retention policies](/influxdb/cloud/reference/glossary/#retention-policy-rp).
|
||||
InfluxDB 2.x replaces databases and retention policies with buckets.
|
||||
To support InfluxDB 1.x query and write patterns in InfluxDB 2.x,
|
||||
databases and retention policies are mapped to buckets using the
|
||||
|
|
@ -410,7 +414,7 @@ paths:
|
|||
Specifies an authorization by its `token` property value
|
||||
and returns the authorization.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't support this parameter. InfluxDB OSS ignores the `token=` parameter,
|
||||
applies other parameters, and then returns the result.
|
||||
|
|
@ -437,11 +441,11 @@ paths:
|
|||
token used in the request has `read-user` permission for the users (`userID` property value)
|
||||
in those authorizations.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- **Warning**: The response body contains authorizations with their
|
||||
[API token](/influxdb/cloud/reference/glossary/#token) values in clear text.
|
||||
- If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_,
|
||||
- If the request uses an _[operator token](/influxdb/v2/security/tokens/#operator-token)_,
|
||||
InfluxDB OSS returns authorizations for all organizations in the instance.
|
||||
'400':
|
||||
$ref: '#/components/responses/GeneralServerError'
|
||||
|
|
@ -593,11 +597,11 @@ paths:
|
|||
Use this endpoint to retrieve information about an API token, including
|
||||
the token's permissions and the user that the token is scoped to.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- InfluxDB OSS returns
|
||||
[API token](/influxdb/cloud/reference/glossary/#token) values in authorizations.
|
||||
- If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_,
|
||||
- If the request uses an _[operator token](/influxdb/v2/security/tokens/#operator-token)_,
|
||||
InfluxDB OSS returns authorizations for all organizations in the instance.
|
||||
|
||||
#### Related guides
|
||||
|
|
@ -710,7 +714,7 @@ paths:
|
|||
If no query parameters are passed, InfluxDB returns all buckets up to the
|
||||
default `limit`.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- If you use an _[operator token](/influxdb/cloud/security/tokens/#operator-token)_
|
||||
to authenticate your request, InfluxDB retrieves resources for _all
|
||||
|
|
@ -742,7 +746,7 @@ paths:
|
|||
- Doesn't use the `org` parameter or `orgID` parameter.
|
||||
- Lists buckets for the organization associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Lists buckets for the specified organization.
|
||||
in: query
|
||||
|
|
@ -757,7 +761,7 @@ paths:
|
|||
- Doesn't use the `org` parameter or `orgID` parameter.
|
||||
- Lists buckets for the organization associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or `orgID` parameter.
|
||||
- Lists buckets for the specified organization.
|
||||
|
|
@ -842,7 +846,7 @@ paths:
|
|||
[retention period](/influxdb/cloud/reference/glossary/#retention-period)
|
||||
is 30 days.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- A single InfluxDB OSS instance supports active writes or queries for
|
||||
approximately 20 buckets across all organizations at a given time.
|
||||
|
|
@ -985,7 +989,7 @@ paths:
|
|||
2. Returns an HTTP `204` status code if queued; _error_ otherwise.
|
||||
3. Handles the delete asynchronously.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Validates the request, handles the delete synchronously,
|
||||
and then responds with success or failure.
|
||||
|
|
@ -1016,7 +1020,7 @@ paths:
|
|||
#### InfluxDB Cloud
|
||||
- The bucket is queued for deletion.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
- The bucket is deleted.
|
||||
'400':
|
||||
content:
|
||||
|
|
@ -1153,7 +1157,7 @@ paths:
|
|||
- Requires the `retentionRules` property in the request body. If you don't
|
||||
provide `retentionRules`, InfluxDB responds with an HTTP `403` status code.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't require `retentionRules`.
|
||||
|
||||
|
|
@ -3452,7 +3456,7 @@ paths:
|
|||
schema:
|
||||
type: string
|
||||
- description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp).
|
||||
A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp).
|
||||
Specifies the 1.x retention policy to filter on.
|
||||
in: query
|
||||
name: rp
|
||||
|
|
@ -3857,7 +3861,7 @@ paths:
|
|||
Because writes and deletes are asynchronous, your change might not yet be readable
|
||||
when you receive the response.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Validates the request, handles the delete synchronously,
|
||||
and then responds with success or failure.
|
||||
|
|
@ -3891,7 +3895,7 @@ paths:
|
|||
- Deletes data from the bucket in the organization
|
||||
associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or the `orgID` parameter.
|
||||
- Deletes data from the bucket in the specified organization.
|
||||
|
|
@ -3919,7 +3923,7 @@ paths:
|
|||
- Deletes data from the bucket in the organization
|
||||
associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or the `orgID` parameter.
|
||||
- Deletes data from the bucket in the specified organization.
|
||||
|
|
@ -3973,7 +3977,7 @@ paths:
|
|||
Because writes are asynchronous, data might not yet be written
|
||||
when you receive the response.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Deleted the data.
|
||||
'400':
|
||||
|
|
@ -3991,7 +3995,7 @@ paths:
|
|||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization.
|
||||
'401':
|
||||
|
|
@ -4031,16 +4035,12 @@ paths:
|
|||
|
||||
1. Use [token authentication](#section/Authentication/TokenAuthentication) or a [user session](#tag/Signin) with this endpoint to retrieve
|
||||
feature flags and their values.
|
||||
2. Follow the instructions to [enable, disable, or override values for feature flags](/influxdb/cloud/reference/config-options/#feature-flags).
|
||||
2. Follow the instructions to enable, disable, or override values for feature flags.
|
||||
3. **Optional**: To confirm that your change is applied, do one of the following:
|
||||
|
||||
- Send a request to this endpoint to retrieve the current feature flag values.
|
||||
- Send a request to the [`GET /api/v2/config` endpoint](#operation/GetConfig) to retrieve the
|
||||
current runtime server configuration.
|
||||
|
||||
#### Related guides
|
||||
|
||||
- [InfluxDB configuration options](/influxdb/cloud/reference/config-options/)
|
||||
operationId: GetFlags
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TraceSpan'
|
||||
|
|
@ -4262,7 +4262,7 @@ paths:
|
|||
#### Related guides
|
||||
|
||||
- [InfluxDB Cloud - Change your password](/influxdb/cloud/account-management/change-password/)
|
||||
- [InfluxDB OSS - Change your password](/influxdb/latest/users/change-password/)
|
||||
- [InfluxDB OSS - Change your password](/influxdb/v2/users/change-password/)
|
||||
operationId: PutMePassword
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TraceSpan'
|
||||
|
|
@ -4298,7 +4298,7 @@ paths:
|
|||
|
||||
- Doesn't let you manage user passwords through the API; always responds with this status.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't understand a value passed in the request.
|
||||
'401':
|
||||
|
|
@ -5111,7 +5111,7 @@ paths:
|
|||
2. Returns an HTTP `204` status code if queued; _error_ otherwise.
|
||||
3. Handles the delete asynchronously.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Validates the request, handles the delete synchronously,
|
||||
and then responds with success or failure.
|
||||
|
|
@ -5141,7 +5141,7 @@ paths:
|
|||
#### InfluxDB Cloud
|
||||
- The organization is queued for deletion.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
- The organization is deleted.
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequestError'
|
||||
|
|
@ -6076,7 +6076,7 @@ paths:
|
|||
- Doesn't use the `org` parameter or `orgID` parameter.
|
||||
- Queries the bucket in the organization associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or `orgID` parameter.
|
||||
- Queries the bucket in the specified organization.
|
||||
|
|
@ -6092,7 +6092,7 @@ paths:
|
|||
- Doesn't use the `org` parameter or `orgID` parameter.
|
||||
- Queries the bucket in the organization associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or `orgID` parameter.
|
||||
- Queries the bucket in the specified organization.
|
||||
|
|
@ -6156,7 +6156,7 @@ paths:
|
|||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization.
|
||||
'401':
|
||||
|
|
@ -6172,7 +6172,7 @@ paths:
|
|||
[global limit](/influxdb/cloud/account-management/limits/#global-limits)
|
||||
- returns `Retry-After` header that describes when to try the write again.
|
||||
|
||||
#### InfluxDB OSS:
|
||||
#### InfluxDB OSS v2:
|
||||
- doesn't return this error.
|
||||
headers:
|
||||
Retry-After:
|
||||
|
|
@ -8508,7 +8508,7 @@ paths:
|
|||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter.
|
||||
'401':
|
||||
|
|
@ -9857,7 +9857,7 @@ paths:
|
|||
|
||||
- Always returns this error; doesn't support cancelling tasks.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't return this error.
|
||||
'500':
|
||||
|
|
@ -11184,7 +11184,7 @@ paths:
|
|||
#### Related guides
|
||||
|
||||
- [InfluxDB Cloud - Change your password](/influxdb/cloud/account-management/change-password/)
|
||||
- [InfluxDB OSS - Change your password](/influxdb/latest/users/change-password/)
|
||||
- [InfluxDB OSS - Change your password](/influxdb/v2/users/change-password/)
|
||||
operationId: PostUsersIDPassword
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TraceSpan'
|
||||
|
|
@ -11222,7 +11222,7 @@ paths:
|
|||
|
||||
- Doesn't allow you to manage passwords through the API; always responds with this status.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't understand a value passed in the request.
|
||||
default:
|
||||
|
|
@ -11259,7 +11259,7 @@ paths:
|
|||
#### Related guides
|
||||
|
||||
- [InfluxDB Cloud - Change your password](/influxdb/cloud/account-management/change-password/)
|
||||
- [InfluxDB OSS - Change your password](/influxdb/latest/users/change-password/)
|
||||
- [InfluxDB OSS - Change your password](/influxdb/v2/users/change-password/)
|
||||
operationId: PutUsersIDPassword
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TraceSpan'
|
||||
|
|
@ -11297,7 +11297,7 @@ paths:
|
|||
|
||||
- Doesn't allow you to manage passwords through the API; always responds with this status.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't understand a value passed in the request.
|
||||
default:
|
||||
|
|
@ -11600,7 +11600,7 @@ paths:
|
|||
Because writes and deletes are asynchronous, your change might not yet be readable
|
||||
when you receive the response.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Validates the request and handles the write synchronously.
|
||||
- If all points were written successfully, responds with HTTP `2xx` status code;
|
||||
|
|
@ -11671,7 +11671,7 @@ paths:
|
|||
- Returns only `application/json` for format and limit errors.
|
||||
- Returns only `text/html` for some quota limit errors.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Returns only `application/json` for format and limit errors.
|
||||
|
||||
|
|
@ -11695,7 +11695,7 @@ paths:
|
|||
- Writes data to the bucket in the organization
|
||||
associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or the `orgID` parameter.
|
||||
- If you pass both `orgID` and `org`, they must both be valid.
|
||||
|
|
@ -11715,7 +11715,7 @@ paths:
|
|||
- Writes data to the bucket in the organization
|
||||
associated with the authorization (API token).
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Requires either the `org` parameter or the `orgID` parameter.
|
||||
- If you pass both `orgID` and `org`, they must both be valid.
|
||||
|
|
@ -11772,7 +11772,7 @@ paths:
|
|||
- Validated and queued the request.
|
||||
- Handles the write asynchronously - the write might not have completed yet.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Successfully wrote all points in the batch.
|
||||
|
||||
|
|
@ -11807,7 +11807,7 @@ paths:
|
|||
|
||||
- Returns this error for bucket schema conflicts.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization.
|
||||
'401':
|
||||
|
|
@ -11848,7 +11848,7 @@ paths:
|
|||
- Returns this error if the payload exceeds the 50MB size limit.
|
||||
- Returns `Content-Type: text/html` for this error.
|
||||
|
||||
#### InfluxDB OSS:
|
||||
#### InfluxDB OSS v2:
|
||||
|
||||
- Returns this error only if the [Go (golang) `ioutil.ReadAll()`](https://pkg.go.dev/io/ioutil#ReadAll) function raises an error.
|
||||
- Returns `Content-Type: application/json` for this error.
|
||||
|
|
@ -11866,7 +11866,7 @@ paths:
|
|||
Rates (data-in (writes), queries (reads), and deletes) accrue within a fixed five-minute window.
|
||||
Once a rate limit is exceeded, InfluxDB returns an error response until the current five-minute window resets.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't return this error.
|
||||
headers:
|
||||
|
|
@ -12186,7 +12186,7 @@ paths:
|
|||
- description: |
|
||||
The database to query data from.
|
||||
This is mapped to an InfluxDB [bucket](/influxdb/cloud/reference/glossary/#bucket).
|
||||
For more information, see [Database and retention policy mapping](/influxdb/cloud/api/influxdb-1x/dbrp/).
|
||||
For more information, see [Database and retention policy mapping](/influxdb/cloud/api-guide/influxdb-1x/dbrp/).
|
||||
in: query
|
||||
name: db
|
||||
required: true
|
||||
|
|
@ -12195,7 +12195,7 @@ paths:
|
|||
- description: |
|
||||
The retention policy to query data from.
|
||||
This is mapped to an InfluxDB [bucket](/influxdb/cloud/reference/glossary/#bucket).
|
||||
For more information, see [Database and retention policy mapping](/influxdb/cloud/api/influxdb-1x/dbrp/).
|
||||
For more information, see [Database and retention policy mapping](/influxdb/cloud/api-guide/influxdb-1x/dbrp/).
|
||||
in: query
|
||||
name: rp
|
||||
schema:
|
||||
|
|
@ -12208,7 +12208,7 @@ paths:
|
|||
type: string
|
||||
- description: |
|
||||
A unix timestamp precision.
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud/reference/glossary/#unix-timestamp) the specified precision
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb/cloud/reference/glossary/#unix-timestamp) with the specified precision
|
||||
instead of [RFC3339 timestamps](/influxdb/cloud/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
|
||||
in: query
|
||||
name: epoch
|
||||
|
|
@ -12271,7 +12271,7 @@ paths:
|
|||
[global limit](/influxdb/cloud/account-management/limits/#global-limits)
|
||||
- returns `Retry-After` header that describes when to try the write again.
|
||||
|
||||
#### InfluxDB OSS:
|
||||
#### InfluxDB OSS v2:
|
||||
- doesn't return this error.
|
||||
headers:
|
||||
Retry-After:
|
||||
|
|
@ -12550,7 +12550,7 @@ components:
|
|||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter.
|
||||
GeneralServerError:
|
||||
|
|
@ -13448,7 +13448,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
virtual:
|
||||
|
|
@ -13491,7 +13491,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
required:
|
||||
|
|
@ -13515,7 +13515,7 @@ components:
|
|||
type: boolean
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
DBRPs:
|
||||
|
|
@ -14600,9 +14600,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -14651,12 +14651,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
IntegerLiteral:
|
||||
|
|
@ -15997,7 +15997,7 @@ components:
|
|||
|
||||
- Doesn't use `shardGroupDurationsSeconds`.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Default value depends on the [bucket retention period](/influxdb/cloud/reference/internals/shards/#shard-group-duration).
|
||||
|
||||
|
|
@ -16130,7 +16130,7 @@ components:
|
|||
If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property;
|
||||
otherwise, see the `retentionRules` property.
|
||||
|
||||
[Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp)
|
||||
[Retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp)
|
||||
is an InfluxDB 1.x concept.
|
||||
The InfluxDB 2.x and Cloud equivalent is
|
||||
[retention period](/influxdb/cloud/reference/glossary/#retention-period).
|
||||
|
|
@ -16147,7 +16147,7 @@ components:
|
|||
- Use `explicit` to enforce column names, tags, fields, and data types for
|
||||
your data.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Doesn't support `explicit` bucket schemas.
|
||||
required:
|
||||
|
|
@ -16440,7 +16440,7 @@ components:
|
|||
|
||||
- Does not use `shardGroupDurationsSeconds`.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- Default value depends on the
|
||||
[bucket retention period](/influxdb/cloud/reference/internals/shards/#shard-group-duration).
|
||||
|
|
@ -16463,7 +16463,7 @@ components:
|
|||
|
||||
- `retentionRules` is required.
|
||||
|
||||
#### InfluxDB OSS
|
||||
#### InfluxDB OSS v2
|
||||
|
||||
- `retentionRules` isn't required.
|
||||
items:
|
||||
|
|
@ -19156,9 +19156,6 @@ x-tagGroups:
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- Data I/O endpoints
|
||||
- Security and access endpoints
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Authorizations (API tokens)
|
||||
|
|
|
|||
|
|
@ -6,8 +6,11 @@ extends:
|
|||
x-influxdata-product-name: InfluxDB v2 OSS
|
||||
|
||||
apis:
|
||||
'@2':
|
||||
root: ref.yml
|
||||
x-influxdata-default: true
|
||||
v2@2:
|
||||
root: v2/ref.yml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb/v2/api/
|
||||
v1-compatibility@2:
|
||||
root: v1-compatibility/swaggerV1Compat.yml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb/v2/api/v1/
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
title: InfluxDB OSS API Service
|
||||
x-influxdata-short-title: v2 API
|
||||
summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance.
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.7.0/contracts/ref/oss.yml).
|
||||
version: 2.x
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
|
|
@ -1,12 +1,15 @@
|
|||
title: InfluxDB v1 HTTP API for InfluxDB v2 OSS
|
||||
x-influxdata-short-title: v1 Compatibility API
|
||||
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints.
|
||||
description: |
|
||||
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
|
||||
The InfluxDB 1.x compatibility `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
|
||||
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -3,14 +3,18 @@ info:
|
|||
title: InfluxDB v1 HTTP API for InfluxDB v2 OSS
|
||||
version: ''
|
||||
description: |
|
||||
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
|
||||
The InfluxDB 1.x compatibility `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
|
||||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: /
|
||||
security:
|
||||
|
|
@ -276,9 +280,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -327,12 +331,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
InfluxQLCSVResponse:
|
||||
|
|
@ -463,19 +467,3 @@ components:
|
|||
|
||||
|
||||
For examples and more information, see how to [authenticate with a username and password](/influxdb/cloud/reference/api/influxdb-1x/).
|
||||
x-tagGroups:
|
||||
- name: Using the InfluxDB HTTP API
|
||||
tags:
|
||||
- Quick start
|
||||
- Authentication
|
||||
- Supported operations
|
||||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- Data I/O endpoints
|
||||
- Security and access endpoints
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Query
|
||||
- Write
|
||||
|
|
|
|||
|
|
@ -0,0 +1,17 @@
|
|||
title: InfluxDB OSS API Service
|
||||
x-influxdata-short-title: v2 API
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance.
|
||||
|
||||
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with an InfluxDB v2 instance. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://github.com/influxdata/openapi/blob/influxdb-oss-v2.7.0/contracts/ref/oss.yml).
|
||||
version: 2.x
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -6,8 +6,5 @@
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- Data I/O endpoints
|
||||
- Security and access endpoints
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags: []
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -10,6 +10,9 @@ apis:
|
|||
root: management/openapi.yml
|
||||
v2@2:
|
||||
root: v2/ref.yml
|
||||
x-influxdata-default: true
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/cloud-dedicated/api/
|
||||
v1-compatibility@2:
|
||||
root: v1-compatibility/swaggerV1Compat.yml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/cloud-dedicated/api/v1/
|
||||
|
|
|
|||
|
|
@ -1,12 +1,15 @@
|
|||
title: InfluxDB 3 Cloud Dedicated Management API
|
||||
x-influxdata-short-title: Management API
|
||||
summary: |
|
||||
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
|
||||
description: |
|
||||
The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
|
||||
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated cluster.
|
||||
The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
|
||||
|
||||
This documentation is generated from the
|
||||
InfluxDB OpenAPI specification.
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -2,16 +2,19 @@ openapi: 3.1.0
|
|||
info:
|
||||
title: InfluxDB 3 Cloud Dedicated Management API
|
||||
description: |
|
||||
The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
|
||||
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated cluster.
|
||||
The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
|
||||
|
||||
This documentation is generated from the
|
||||
InfluxDB OpenAPI specification.
|
||||
summary: |
|
||||
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
|
||||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
version: ''
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: https://{baseurl}/api/v0
|
||||
description: InfluxDB 3 Cloud Dedicated Management API URL
|
||||
|
|
@ -37,8 +40,6 @@ tags:
|
|||
See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
|
||||
|
||||
By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
|
||||
|
||||
|
||||
- name: Database tokens
|
||||
description: Manage database read/write tokens for a cluster
|
||||
- name: Databases
|
||||
|
|
@ -1020,7 +1021,6 @@ paths:
|
|||
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
|
||||
|
||||
If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one.
|
||||
|
||||
parameters:
|
||||
- name: accountId
|
||||
in: path
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated
|
||||
x-influxdata-short-title: v1 Compatibility API
|
||||
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database.
|
||||
x-influxdata-short-description: The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database using InfluxDB v1 endpoints.
|
||||
description: |
|
||||
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database using InfluxDB v1 endpoints.
|
||||
|
||||
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -13,3 +15,7 @@ description: |
|
|||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ info:
|
|||
title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Dedicated
|
||||
version: ''
|
||||
description: |
|
||||
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database using InfluxDB v1 endpoints.
|
||||
|
||||
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -14,7 +16,10 @@ info:
|
|||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Dedicated database.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: /
|
||||
security:
|
||||
|
|
@ -35,6 +40,7 @@ tags:
|
|||
|
||||
<!-- ReDoc-Inject: <security-definitions> -->
|
||||
x-traitTag: true
|
||||
- name: Ping
|
||||
- name: Query
|
||||
- name: Write
|
||||
paths:
|
||||
|
|
@ -244,7 +250,7 @@ paths:
|
|||
get:
|
||||
description: |
|
||||
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
|
||||
|
||||
|
||||
The response is a HTTP `204` status code to inform you the querier is available.
|
||||
|
||||
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
|
||||
|
|
@ -282,7 +288,7 @@ paths:
|
|||
head:
|
||||
description: |
|
||||
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
|
||||
|
||||
|
||||
The response is a HTTP `204` status code to inform you the querier is available.
|
||||
|
||||
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
|
||||
|
|
@ -290,7 +296,6 @@ paths:
|
|||
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb3/cloud-dedicated/api/v2/#tag/Write).
|
||||
|
||||
This endpoint doesn't require authentication.
|
||||
|
||||
operationId: HeadPing
|
||||
responses:
|
||||
'204':
|
||||
|
|
@ -357,9 +362,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -408,12 +413,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
InfluxQLCSVResponse:
|
||||
|
|
|
|||
|
|
@ -1,12 +1,17 @@
|
|||
title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated
|
||||
x-influxdata-short-title: v2 API
|
||||
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database.
|
||||
|
||||
x-influxdata-short-description: The InfluxDB v2 HTTP API provides a v2-compatible programmatic interface for writing and managing data stored in an InfluxDB 3 Cloud Dedicated database.
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
The InfluxDB v2 HTTP API provides a v2-compatible programmatic interface for writing and managing data stored in an InfluxDB 3 Cloud Dedicated database.
|
||||
|
||||
Use the InfluxDB v2 HTTP API `/api/v2` endpoints to manage retention policy mappings and write data to an InfluxDB 3 instance.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -6,7 +6,6 @@
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Ping
|
||||
|
|
|
|||
|
|
@ -2,15 +2,20 @@ openapi: 3.0.0
|
|||
info:
|
||||
title: InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
The InfluxDB v2 HTTP API provides a v2-compatible programmatic interface for writing and managing data stored in an InfluxDB 3 Cloud Dedicated database.
|
||||
|
||||
Use the InfluxDB v2 HTTP API `/api/v2` endpoints to manage retention policy mappings and write data to an InfluxDB 3 instance.
|
||||
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
|
||||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Dedicated provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Cloud Dedicated database.
|
||||
version: ''
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: https://{baseurl}
|
||||
description: InfluxDB 3 Cloud Dedicated API URL
|
||||
|
|
@ -150,7 +155,7 @@ paths:
|
|||
get:
|
||||
description: |
|
||||
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
|
||||
|
||||
|
||||
The response is a HTTP `204` status code to inform you the querier is available.
|
||||
|
||||
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
|
||||
|
|
@ -188,7 +193,7 @@ paths:
|
|||
head:
|
||||
description: |
|
||||
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
|
||||
|
||||
|
||||
The response is a HTTP `204` status code to inform you the querier is available.
|
||||
|
||||
For InfluxDB 3 Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
|
||||
|
|
@ -499,7 +504,7 @@ paths:
|
|||
type: string
|
||||
- description: |
|
||||
A unix timestamp precision.
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) the specified precision
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-dedicated/reference/glossary/#unix-timestamp) with the specified precision
|
||||
instead of [RFC3339 timestamps](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
|
||||
in: query
|
||||
name: epoch
|
||||
|
|
@ -932,7 +937,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/cloud-dedicated/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
virtual:
|
||||
|
|
@ -975,7 +980,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/cloud-dedicated/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
required:
|
||||
|
|
@ -999,7 +1004,7 @@ components:
|
|||
type: boolean
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/cloud-dedicated/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
DBRPs:
|
||||
|
|
@ -1243,9 +1248,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -1294,12 +1299,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
IntegerLiteral:
|
||||
|
|
@ -2138,7 +2143,6 @@ x-tagGroups:
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Ping
|
||||
|
|
|
|||
|
|
@ -8,6 +8,9 @@ x-influxdata-product-name: InfluxDB 3 Serverless
|
|||
apis:
|
||||
v2@2:
|
||||
root: v2/ref.yml
|
||||
x-influxdata-default: true
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/cloud-serverless/api/
|
||||
v1-compatibility@2:
|
||||
root: v1-compatibility/swaggerV1Compat.yml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/cloud-serverless/api/v1/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless
|
||||
x-influxdata-short-title: v1 Compatibility API
|
||||
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
|
||||
x-influxdata-short-description: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
|
||||
description: |
|
||||
The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
|
||||
|
||||
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -13,3 +15,7 @@ description: |
|
|||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -3,6 +3,8 @@ info:
|
|||
title: InfluxDB v1 HTTP API for InfluxDB 3 Cloud Serverless
|
||||
version: ''
|
||||
description: |
|
||||
The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
|
||||
|
||||
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -14,7 +16,10 @@ info:
|
|||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Cloud Serverless bucket.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: /
|
||||
security:
|
||||
|
|
@ -280,9 +285,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -331,12 +336,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
InfluxQLCSVResponse:
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
title: InfluxDB 3 Cloud Serverless API Service
|
||||
x-influxdata-short-title: v2 API
|
||||
summary: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
x-influxdata-short-description: The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -10,3 +11,7 @@ description: |
|
|||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -6,9 +6,6 @@
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- Data I/O endpoints
|
||||
- Security and access endpoints
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Authorizations (API tokens)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@ openapi: 3.0.0
|
|||
info:
|
||||
title: InfluxDB 3 Cloud Serverless API Service
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -9,9 +11,11 @@ info:
|
|||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Cloud Serverless provides a programmatic interface for writing data stored in an InfluxDB 3 Cloud Serverless bucket.
|
||||
version: ''
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: https://{baseurl}
|
||||
description: InfluxDB 3 Cloud Serverless API URL
|
||||
|
|
@ -122,16 +126,16 @@ tags:
|
|||
|:------------------------ |:--------------------- |:-------------------------------------------|
|
||||
| `bucket` | string | The bucket name or ID ([find your bucket](/influxdb3/cloud-serverless/admin/buckets/view-buckets/). |
|
||||
| `bucketID` | string | The bucket ID ([find your bucket](/influxdb3/cloud-serverless/admin/buckets/view-buckets/). |
|
||||
| `org` | string | The organization name or ID ([find your organization](/influxdb3/cloud-serverless/organizations/view-orgs/). |
|
||||
| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb3/cloud-serverless/organizations/view-orgs/). |
|
||||
| `org` | string | The organization name or ID ([find your organization](/influxdb3/cloud-serverless/admin/organizations/view-orgs/). |
|
||||
| `orgID` | 16-byte string | The organization ID ([find your organization](/influxdb3/cloud-serverless/admin/organizations/view-orgs/). |
|
||||
name: Common parameters
|
||||
x-traitTag: true
|
||||
- name: Config
|
||||
- name: Dashboards
|
||||
- name: Data I/O endpoints
|
||||
- description: |
|
||||
The InfluxDB 1.x data model includes [databases](/influxdb/v1.8/concepts/glossary/#database)
|
||||
and [retention policies](/influxdb/v1.8/concepts/glossary/#retention-policy-rp).
|
||||
The InfluxDB 1.x data model includes [databases](/influxdb3/cloud-serverless/reference/glossary/#database)
|
||||
and [retention policies](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp).
|
||||
InfluxDB 2.x replaces databases and retention policies with buckets.
|
||||
To support InfluxDB 1.x query and write patterns in InfluxDB 2.x,
|
||||
databases and retention policies are mapped to buckets using the
|
||||
|
|
@ -439,11 +443,6 @@ paths:
|
|||
Specifies an authorization by its `token` property value
|
||||
and returns the authorization.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Doesn't support this parameter. InfluxDB OSS ignores the `token=` parameter,
|
||||
applies other parameters, and then returns the result.
|
||||
|
||||
#### Limitations
|
||||
|
||||
- The parameter is non-repeatable. If you specify more than one,
|
||||
|
|
@ -465,13 +464,6 @@ paths:
|
|||
If the response body is missing authorizations that you expect, check that the API
|
||||
token used in the request has `read-user` permission for the users (`userID` property value)
|
||||
in those authorizations.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- **Warning**: The response body contains authorizations with their
|
||||
[API token](/influxdb3/cloud-serverless/reference/glossary/#token) values in clear text.
|
||||
- If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_,
|
||||
InfluxDB OSS returns authorizations for all organizations in the instance.
|
||||
'400':
|
||||
$ref: '#/components/responses/GeneralServerError'
|
||||
description: Invalid request
|
||||
|
|
@ -621,14 +613,6 @@ paths:
|
|||
|
||||
Use this endpoint to retrieve information about an API token, including
|
||||
the token's permissions and the user that the token is scoped to.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- InfluxDB OSS returns
|
||||
[API token](/influxdb3/cloud-serverless/reference/glossary/#token) values in authorizations.
|
||||
- If the request uses an _[operator token](/influxdb/latest/security/tokens/#operator-token)_,
|
||||
InfluxDB OSS returns authorizations for all organizations in the instance.
|
||||
|
||||
#### Related guides
|
||||
|
||||
- [View tokens](/influxdb3/cloud-serverless/security/tokens/view-tokens/)
|
||||
|
|
@ -736,14 +720,6 @@ paths:
|
|||
If no query parameters are passed, InfluxDB returns all buckets up to the
|
||||
default `limit`.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- If you use an _[operator token](/influxdb3/cloud-serverless/security/tokens/#operator-token)_
|
||||
to authenticate your request, InfluxDB retrieves resources for _all
|
||||
organizations_ in the instance.
|
||||
To retrieve resources for only a specific organization, use the
|
||||
`org` parameter or the `orgID` parameter to specify the organization.
|
||||
|
||||
#### Required permissions
|
||||
|
||||
| Action | Permission required |
|
||||
|
|
@ -859,13 +835,6 @@ paths:
|
|||
[retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period)
|
||||
is 30 days.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- A single InfluxDB OSS instance supports active writes or queries for
|
||||
approximately 20 buckets across all organizations at a given time.
|
||||
Reading or writing to more than 20 buckets at a time can adversely affect
|
||||
performance.
|
||||
|
||||
#### Limitations
|
||||
|
||||
- InfluxDB Cloud Free Plan allows users to create up to two buckets.
|
||||
|
|
@ -2381,7 +2350,7 @@ paths:
|
|||
schema:
|
||||
type: string
|
||||
- description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp).
|
||||
A [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp).
|
||||
Specifies the 1.x retention policy to filter on.
|
||||
in: query
|
||||
name: rp
|
||||
|
|
@ -2851,10 +2820,6 @@ paths:
|
|||
description: |
|
||||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization.
|
||||
'401':
|
||||
$ref: '#/components/responses/AuthorizationError'
|
||||
'404':
|
||||
|
|
@ -2906,7 +2871,7 @@ paths:
|
|||
|
||||
#### Related guides
|
||||
|
||||
- [View organizations](/influxdb3/cloud-serverless/organizations/view-orgs/)
|
||||
- [View organizations](/influxdb3/cloud-serverless/admin/organizations/view-orgs/)
|
||||
operationId: GetOrgs
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TraceSpan'
|
||||
|
|
@ -3071,11 +3036,6 @@ paths:
|
|||
2. Returns an HTTP `204` status code if queued; _error_ otherwise.
|
||||
3. Handles the delete asynchronously.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Validates the request, handles the delete synchronously,
|
||||
and then responds with success or failure.
|
||||
|
||||
#### Limitations
|
||||
|
||||
- Only one organization can be deleted per request.
|
||||
|
|
@ -3100,9 +3060,6 @@ paths:
|
|||
|
||||
#### InfluxDB Cloud
|
||||
- The organization is queued for deletion.
|
||||
|
||||
#### InfluxDB OSS
|
||||
- The organization is deleted.
|
||||
'400':
|
||||
$ref: '#/components/responses/BadRequestError'
|
||||
'401':
|
||||
|
|
@ -3141,7 +3098,7 @@ paths:
|
|||
|
||||
#### Related guides
|
||||
|
||||
- [View organizations](/influxdb3/cloud-serverless/organizations/view-orgs/)
|
||||
- [View organizations](/influxdb3/cloud-serverless/admin/organizations/view-orgs/)
|
||||
operationId: GetOrgsID
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TraceSpan'
|
||||
|
|
@ -3905,10 +3862,6 @@ paths:
|
|||
description: |
|
||||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Returns this error if the `org` parameter or `orgID` parameter doesn't match an organization.
|
||||
'401':
|
||||
$ref: '#/components/responses/AuthorizationError'
|
||||
'404':
|
||||
|
|
@ -4890,10 +4843,6 @@ paths:
|
|||
description: |
|
||||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter.
|
||||
'401':
|
||||
$ref: '#/components/responses/AuthorizationError'
|
||||
'500':
|
||||
|
|
@ -6230,10 +6179,6 @@ paths:
|
|||
#### InfluxDB Cloud
|
||||
|
||||
- Always returns this error; doesn't support cancelling tasks.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Doesn't return this error.
|
||||
'500':
|
||||
$ref: '#/components/responses/InternalServerError'
|
||||
default:
|
||||
|
|
@ -7823,7 +7768,7 @@ paths:
|
|||
type: string
|
||||
- description: |
|
||||
A unix timestamp precision.
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp) the specified precision
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb3/cloud-serverless/reference/glossary/#unix-timestamp) with the specified precision
|
||||
instead of [RFC3339 timestamps](/influxdb3/cloud-serverless/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
|
||||
in: query
|
||||
name: epoch
|
||||
|
|
@ -8229,10 +8174,6 @@ components:
|
|||
description: |
|
||||
Bad request.
|
||||
The response body contains detail about the error.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Returns this error if an incorrect value is passed in the `org` parameter or `orgID` parameter.
|
||||
GeneralServerError:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -9128,7 +9069,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
virtual:
|
||||
|
|
@ -9171,7 +9112,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
required:
|
||||
|
|
@ -9195,7 +9136,7 @@ components:
|
|||
type: boolean
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
DBRPs:
|
||||
|
|
@ -11677,10 +11618,6 @@ components:
|
|||
|
||||
- Doesn't use `shardGroupDurationsSeconds`.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- Default value depends on the [bucket retention period](/influxdb3/cloud-serverless/reference/internals/shards/#shard-group-duration).
|
||||
|
||||
#### Related guides
|
||||
|
||||
- InfluxDB [shards and shard groups](/influxdb3/cloud-serverless/reference/internals/shards/)
|
||||
|
|
@ -11810,7 +11747,7 @@ components:
|
|||
If you need compatibility with InfluxDB 1.x, specify a value for the `rp` property;
|
||||
otherwise, see the `retentionRules` property.
|
||||
|
||||
[Retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp)
|
||||
[Retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp)
|
||||
is an InfluxDB 1.x concept.
|
||||
The InfluxDB 2.x and Cloud equivalent is
|
||||
[retention period](/influxdb3/cloud-serverless/reference/glossary/#retention-period).
|
||||
|
|
@ -12128,10 +12065,6 @@ components:
|
|||
#### InfluxDB 3 Cloud Serverless
|
||||
|
||||
- `retentionRules` is required.
|
||||
|
||||
#### InfluxDB OSS
|
||||
|
||||
- `retentionRules` isn't required.
|
||||
items:
|
||||
$ref: '#/components/schemas/RetentionRule'
|
||||
type: array
|
||||
|
|
@ -13396,7 +13329,7 @@ components:
|
|||
The organization owns all resources created by the template.
|
||||
|
||||
To find your organization, see how to
|
||||
[view organizations](/influxdb3/cloud-serverless/organizations/view-orgs/).
|
||||
[view organizations](/influxdb3/cloud-serverless/admin/organizations/view-orgs/).
|
||||
type: string
|
||||
remotes:
|
||||
description: |
|
||||
|
|
@ -14813,9 +14746,6 @@ x-tagGroups:
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- Data I/O endpoints
|
||||
- Security and access endpoints
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Authorizations (API tokens)
|
||||
|
|
|
|||
|
|
@ -8,6 +8,9 @@ x-influxdata-product-name: InfluxDB 3 Clustered
|
|||
apis:
|
||||
v2@2:
|
||||
root: v2/ref.yml
|
||||
x-influxdata-default: true
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/clustered/api/
|
||||
v1-compatibility@2:
|
||||
root: v1-compatibility/swaggerV1Compat.yml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/clustered/api/v1/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered
|
||||
x-influxdata-short-title: v1 Compatibility API
|
||||
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
|
||||
x-influxdata-short-description: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
|
||||
description: |
|
||||
The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
|
||||
|
||||
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -13,3 +15,7 @@ description: |
|
|||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -3,6 +3,8 @@ info:
|
|||
title: InfluxDB v1 HTTP API for InfluxDB 3 Clustered
|
||||
version: ''
|
||||
description: |
|
||||
The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
|
||||
|
||||
The InfluxDB 1.x `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -14,7 +16,10 @@ info:
|
|||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v1 HTTP API provides v1 compatibility for writing and querying data in an InfluxDB 3 Clustered database.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: /
|
||||
security:
|
||||
|
|
@ -280,9 +285,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -331,12 +336,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
InfluxQLCSVResponse:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
title: InfluxDB 3 Clustered API Service
|
||||
x-influxdata-short-title: v2 API
|
||||
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
|
||||
x-influxdata-short-description: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
|
||||
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -9,3 +11,7 @@ description: |
|
|||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -5,7 +5,6 @@
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Ping
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ info:
|
|||
title: InfluxDB 3 Clustered API Service
|
||||
version: ''
|
||||
description: |
|
||||
The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
|
||||
|
||||
The InfluxDB v2 HTTP API lets you use `/api/v2` endpoints for managing retention policy mappings and writing data stored in an InfluxDB 3 instance.
|
||||
|
||||
This documentation is generated from the
|
||||
|
|
@ -10,7 +12,10 @@ info:
|
|||
license:
|
||||
name: MIT
|
||||
url: https://opensource.org/licenses/MIT
|
||||
summary: The InfluxDB v2 HTTP API for InfluxDB 3 Clustered provides a v2-compatible programmatic interface for writing data stored in an InfluxDB 3 Clustered database.
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
servers:
|
||||
- url: https://{baseurl}
|
||||
description: InfluxDB 3 Clustered API URL
|
||||
|
|
@ -412,16 +417,6 @@ paths:
|
|||
'429':
|
||||
description: |
|
||||
Too many requests.
|
||||
|
||||
#### InfluxDB Cloud
|
||||
|
||||
- Returns this error if a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb3/clustered/account-management/limits/#adjustable-service-quotas)
|
||||
or if a **delete** request exceeds the maximum [global limit](/influxdb3/clustered/account-management/limits/#global-limits).
|
||||
- For rate limits that reset automatically, returns a `Retry-After` header that describes when to try the write again.
|
||||
- For limits that can't reset (for example, **cardinality limit**), doesn't return a `Retry-After` header.
|
||||
|
||||
Rates (data-in (writes), queries (reads), and deletes) accrue within a fixed five-minute window.
|
||||
Once a rate limit is exceeded, InfluxDB returns an error response until the current five-minute window resets.
|
||||
headers:
|
||||
Retry-After:
|
||||
description: Non-negative decimal integer indicating seconds to wait before retrying the request.
|
||||
|
|
@ -517,7 +512,7 @@ paths:
|
|||
type: string
|
||||
- description: |
|
||||
A unix timestamp precision.
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb3/clustered/reference/glossary/#unix-timestamp) the specified precision
|
||||
Formats timestamps as [unix (epoch) timestamps](/influxdb3/clustered/reference/glossary/#unix-timestamp) with the specified precision
|
||||
instead of [RFC3339 timestamps](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp) with nanosecond precision.
|
||||
in: query
|
||||
name: epoch
|
||||
|
|
@ -573,12 +568,7 @@ paths:
|
|||
type: string
|
||||
'429':
|
||||
description: |
|
||||
#### InfluxDB Cloud:
|
||||
- returns this error if a **read** or **write** request exceeds your
|
||||
plan's [adjustable service quotas](/influxdb3/clustered/account-management/limits/#adjustable-service-quotas)
|
||||
or if a **delete** request exceeds the maximum
|
||||
[global limit](/influxdb3/clustered/account-management/limits/#global-limits)
|
||||
- returns `Retry-After` header that describes when to try the write again.
|
||||
Token is temporarily over quota. The Retry-After header describes when to try the write again.
|
||||
headers:
|
||||
Retry-After:
|
||||
description: A non-negative decimal integer indicating the seconds to delay after the response is received.
|
||||
|
|
@ -924,7 +914,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/clustered/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
virtual:
|
||||
|
|
@ -967,7 +957,7 @@ components:
|
|||
type: string
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/clustered/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
required:
|
||||
|
|
@ -991,7 +981,7 @@ components:
|
|||
type: boolean
|
||||
retention_policy:
|
||||
description: |
|
||||
A [retention policy](/influxdb/v1.8/concepts/glossary/#retention-policy-rp) name.
|
||||
A [retention policy](/influxdb3/clustered/reference/glossary/#retention-policy-rp) name.
|
||||
Identifies the InfluxDB v1 retention policy mapping.
|
||||
type: string
|
||||
DBRPs:
|
||||
|
|
@ -1235,9 +1225,9 @@ components:
|
|||
properties:
|
||||
results:
|
||||
description: |
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
A resultset object that contains the `statement_id` and the `series` array.
|
||||
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
|
||||
items:
|
||||
properties:
|
||||
error:
|
||||
|
|
@ -1286,12 +1276,12 @@ components:
|
|||
type: integer
|
||||
type: object
|
||||
oneOf:
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
- required:
|
||||
- statement_id
|
||||
- error
|
||||
- required:
|
||||
- statement_id
|
||||
- series
|
||||
type: array
|
||||
type: object
|
||||
IntegerLiteral:
|
||||
|
|
@ -2129,7 +2119,6 @@ x-tagGroups:
|
|||
- Headers
|
||||
- Pagination
|
||||
- Response codes
|
||||
- System information endpoints
|
||||
- name: All endpoints
|
||||
tags:
|
||||
- Ping
|
||||
|
|
|
|||
|
|
@ -0,0 +1,34 @@
|
|||
title: InfluxDB 3 Core API Service
|
||||
x-influxdata-short-title: InfluxDB 3 API
|
||||
x-influxdata-version-matrix:
|
||||
v1: Compatibility layer for InfluxDB 1.x clients (supported)
|
||||
v2: Compatibility layer for InfluxDB 2.x clients (supported)
|
||||
v3: Native API for InfluxDB 3.x (current)
|
||||
x-influxdata-short-description: The InfluxDB 3 HTTP API provides a programmatic interface for interactions with InfluxDB, including writing, querying, and processing data, and managing an InfluxDB 3 instance.
|
||||
description: |
|
||||
The InfluxDB HTTP API for InfluxDB 3 Core provides a programmatic interface for
|
||||
interacting with InfluxDB 3 Core databases and resources.
|
||||
Use this API to:
|
||||
|
||||
- Write data to InfluxDB 3 Core databases
|
||||
- Query data using SQL or InfluxQL
|
||||
- Process data using Processing engine plugins
|
||||
- Manage databases, tables, and Processing engine triggers
|
||||
- Perform administrative tasks and access system information
|
||||
|
||||
The API includes endpoints under the following paths:
|
||||
- `/api/v3`: InfluxDB 3 Core native endpoints
|
||||
- `/`: Compatibility endpoints for InfluxDB v1 workloads and clients
|
||||
- `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients
|
||||
|
||||
<!-- TODO: verify where to host the spec that users can download.
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/).
|
||||
-->
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
- url: https://{baseurl}
|
||||
description: InfluxDB 3 Core API URL
|
||||
variables:
|
||||
baseurl:
|
||||
enum:
|
||||
- 'localhost:8181'
|
||||
default: 'localhost:8181'
|
||||
description: InfluxDB 3 Core URL
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
- name: Using the InfluxDB HTTP API
|
||||
tags:
|
||||
- Quick start
|
||||
- Authentication
|
||||
- Common parameters
|
||||
- Response codes
|
||||
- Compatibility endpoints
|
||||
- Data I/O
|
||||
- Databases
|
||||
- Processing engine
|
||||
- Server information
|
||||
- Tables
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,34 @@
|
|||
title: InfluxDB 3 Enterprise API Service
|
||||
x-influxdata-short-title: InfluxDB 3 API
|
||||
x-influxdata-version-matrix:
|
||||
v1: Compatibility layer for InfluxDB 1.x clients (supported)
|
||||
v2: Compatibility layer for InfluxDB 2.x clients (supported)
|
||||
v3: Native API for InfluxDB 3.x (current)
|
||||
x-influxdata-short-description: The InfluxDB 3 HTTP API provides a programmatic interface for interactions with InfluxDB, including writing, querying, and processing data, and managing an InfluxDB 3 instance.
|
||||
description: |
|
||||
The InfluxDB HTTP API for InfluxDB 3 Enterprise provides a programmatic interface for
|
||||
interacting with InfluxDB 3 Enterprise databases and resources.
|
||||
Use this API to:
|
||||
|
||||
- Write data to InfluxDB 3 Enterprise databases
|
||||
- Query data using SQL or InfluxQL
|
||||
- Process data using Processing engine plugins
|
||||
- Manage databases, tables, and Processing engine triggers
|
||||
- Perform administrative tasks and access system information
|
||||
|
||||
The API includes endpoints under the following paths:
|
||||
- `/api/v3`: InfluxDB 3 Enterprise native endpoints
|
||||
- `/`: Compatibility endpoints for InfluxDB v1 workloads and clients
|
||||
- `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients
|
||||
|
||||
<!-- TODO: verify where to host the spec that users can download.
|
||||
This documentation is generated from the
|
||||
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/).
|
||||
-->
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
contact:
|
||||
name: InfluxData
|
||||
url: https://www.influxdata.com
|
||||
email: support@influxdata.com
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
- url: https://{baseurl}
|
||||
description: InfluxDB 3 Enterprise API URL
|
||||
variables:
|
||||
baseurl:
|
||||
enum:
|
||||
- 'localhost:8181'
|
||||
default: 'localhost:8181'
|
||||
description: InfluxDB 3 Enterprise URL
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
- name: Using the InfluxDB HTTP API
|
||||
tags:
|
||||
- Quick start
|
||||
- Authentication
|
||||
- Common parameters
|
||||
- Response codes
|
||||
- Compatibility endpoints
|
||||
- Data I/O
|
||||
- Databases
|
||||
- Processing engine
|
||||
- Server information
|
||||
- Tables
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -16,6 +16,10 @@ function SetInfo(data) {
|
|||
}
|
||||
if(data.hasOwnProperty('summary')) {
|
||||
info.summary = data.summary;
|
||||
} else {
|
||||
// Remove summary if not provided.
|
||||
// info.summary isn't a valid OpenAPI 3.0 property, but it's used by Redocly.
|
||||
info['summary'] = undefined;
|
||||
}
|
||||
if(data.hasOwnProperty('description')) {
|
||||
info.description = data.description;
|
||||
|
|
@ -23,6 +27,9 @@ function SetInfo(data) {
|
|||
if(data.hasOwnProperty('license')) {
|
||||
info.license = data.license;
|
||||
}
|
||||
if(data.hasOwnProperty('contact')) {
|
||||
info.contact = data.contact;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,5 +6,8 @@
|
|||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"js-yaml": "^4.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"spectral": "^0.0.0"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,59 +1,118 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<!-- Google Tag Manager -->
|
||||
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
|
||||
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
|
||||
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
|
||||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||||
})(window,document,'script','dataLayer','GTM-WXRH9C');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<head>
|
||||
<!-- Google Tag Manager -->
|
||||
<script>window.location.hostname.endsWith('influxdata.com') &&
|
||||
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new
|
||||
Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
|
||||
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
|
||||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||||
})(window,document,'script','dataLayer','GTM-WXRH9C');</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
|
||||
<meta charset="utf8" />
|
||||
<title>{{title}}</title>
|
||||
<meta name="description" content="{{templateOptions.description}}.">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="shortcut icon" href="/img/favicon.png" type="image/png" sizes="32x32">
|
||||
<meta charset='utf8' />
|
||||
<title>{{title}}</title>
|
||||
<meta name='description' content='{{templateOptions.description}}' />
|
||||
<meta name='viewport' content='width=device-width, initial-scale=1' />
|
||||
<link
|
||||
rel='shortcut icon'
|
||||
href='/img/favicon.png'
|
||||
type='image/png'
|
||||
sizes='32x32'
|
||||
/>
|
||||
|
||||
<meta name="google-site-verification" content="_V6CNhaIIgVsTO9max_ECw7DUfPL-ZGE7G03MQgEGMU" />
|
||||
<meta
|
||||
name='google-site-verification'
|
||||
content='_V6CNhaIIgVsTO9max_ECw7DUfPL-ZGE7G03MQgEGMU'
|
||||
/>
|
||||
|
||||
<style>
|
||||
body {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
</style>
|
||||
{{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Roboto+Mono:500,500i,700,700i|Roboto:400,400i,700,700i|Rubik:400,400i,500,500i,700,700i" rel="stylesheet">{{/unless}}
|
||||
{{{redocHead}}}
|
||||
<link rel="stylesheet" type="text/css" href="/api.css">
|
||||
</head>
|
||||
<style>
|
||||
body {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
</style>
|
||||
{{#unless disableGoogleFont}}<link
|
||||
href="https://fonts.googleapis.com/css?family=Roboto+Mono:500,500i,700,700i|Roboto:400,400i,700,700i|Rubik:400,400i,500,500i,700,700i"
|
||||
rel="stylesheet"
|
||||
/>{{/unless}}
|
||||
{{{redocHead}}}
|
||||
<link rel="stylesheet" type="text/css" href="/api.css" />
|
||||
<script type="text/javascript"
|
||||
async="true"
|
||||
src="https://widget.kapa.ai/kapa-widget.bundle.js"
|
||||
data-website-id="a02bca75-1dd3-411e-95c0-79ee1139be4d"
|
||||
data-project-name="InfluxDB"
|
||||
data-project-color="#d30971"
|
||||
data-project-logo="/img/influx-logo-cubo-white.png"
|
||||
data-modal-disclaimer="This AI can access [documentation for InfluxDB, clients, and related tools](https://docs.influxdata.com). Information you submit is used in accordance with our [Privacy Policy](https://www.influxdata.com/legal/privacy-policy/)."
|
||||
data-modal-example-questions="How do I write and query data with the {{title}}?, How do I use client libraries for the {{title}}?" data-button-height="65px" data-button-width="65px"
|
||||
data-button-text="Ask AI" data-conversation-button-icons-only="true"
|
||||
data-font-family="Proxima Nova, sans-serif"
|
||||
data-modal-example-questions-col-span="8"
|
||||
data-modal-full-screen-on-mobile="true"
|
||||
data-modal-header-bg-color="#d30971"
|
||||
data-modal-header-border-bottom="none" data-modal-header-padding=".5rem"
|
||||
data-modal-header-text-color="#ffffff" data-modal-x-offset="0"
|
||||
data-modal-y-offset="0" data-modal-with-overlay="false"
|
||||
data-modal-inner-flex-direction="column"
|
||||
data-modal-inner-justify-content="end" data-modal-inner-max-width="600px"
|
||||
data-modal-inner-position-left="auto"
|
||||
data-modal-inner-position-right="20px"
|
||||
data-modal-inner-position-bottom="calc(2.5rem + 25px)"
|
||||
data-modal-size="640px"
|
||||
data-modal-title-color="#fff"
|
||||
data-modal-title-font-size="1.25rem"
|
||||
data-modal-lock-scroll="false" ></script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript>
|
||||
<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WXRH9C" height="0" width="0" style="display:none;visibility:hidden"></iframe>
|
||||
</noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<div id="loading">
|
||||
<div class="spinner"></div>
|
||||
</div>
|
||||
<div id="influx-header">
|
||||
<a class="back" href="/{{templateOptions.product}}/"><span class="version">{{templateOptions.productName}}</span> Docs</a>
|
||||
<a class="btn" href="https://github.com/influxdata/influxdb/issues/new/choose/" target="_blank">Submit API issue</a>
|
||||
</div>
|
||||
{{{redocHTML}}}
|
||||
<script type="text/javascript">
|
||||
function removeFadeOut( el, speed ) {
|
||||
var seconds = speed/1000;
|
||||
el.style.transition = "opacity "+seconds+"s ease";
|
||||
el.style.opacity = 0;
|
||||
setTimeout(function() {
|
||||
el.parentNode.removeChild(el);
|
||||
}, speed);
|
||||
}
|
||||
removeFadeOut(document.getElementById('loading'), 500);
|
||||
</script>
|
||||
</body>
|
||||
<body>
|
||||
{{! <script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
// Prevent throwing errors when the Google Tag Manager script is blocked
|
||||
if (!window.hasOwnProperty('fcdsc')) {
|
||||
window.fcdsc = (function() {
|
||||
// Return nothing for any function call chained off of fcdsc
|
||||
return new Proxy({}, {
|
||||
get: function(target, prop) {
|
||||
return function() {};
|
||||
}
|
||||
});
|
||||
})();
|
||||
}
|
||||
});
|
||||
</script> }}
|
||||
<!-- Google Tag Manager (noscript) -->
|
||||
<noscript>
|
||||
<iframe
|
||||
src='https://www.googletagmanager.com/ns.html?id=GTM-WXRH9C'
|
||||
height='0'
|
||||
width='0'
|
||||
style='display:none;visibility:hidden'
|
||||
></iframe>
|
||||
</noscript>
|
||||
<!-- End Google Tag Manager (noscript) -->
|
||||
<div id='loading'>
|
||||
<div class='spinner'></div>
|
||||
</div>
|
||||
<div id='influx-header'>
|
||||
<a class='back' href='/{{templateOptions.product}}/'><span
|
||||
class='version'
|
||||
>{{templateOptions.productName}}</span>
|
||||
Docs</a>
|
||||
<a
|
||||
class='btn'
|
||||
href='https://github.com/influxdata/influxdb/issues/new/choose/'
|
||||
target='_blank'
|
||||
>Submit API issue</a>
|
||||
</div>
|
||||
{{{redocHTML}}}
|
||||
<script type='text/javascript'>
|
||||
function removeFadeOut( el, speed ) { var seconds = speed/1000;
|
||||
el.style.transition = "opacity "+seconds+"s ease"; el.style.opacity = 0;
|
||||
setTimeout(function() { el.parentNode.removeChild(el); }, speed); }
|
||||
removeFadeOut(document.getElementById('loading'), 500);
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
</html>
|
||||
|
|
@ -2,14 +2,90 @@
|
|||
# yarn lockfile v1
|
||||
|
||||
|
||||
ansi-regex@^2.0.0:
|
||||
version "2.1.1"
|
||||
resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df"
|
||||
integrity sha512-TIGnTpdo+E3+pCyAluZvtED5p5wCqLdezCyhPZzKPcxvFplEt4i+W7OONCKgeZFT3+y5NZZfOOS/Bdcanm1MYA==
|
||||
|
||||
ansi-styles@^2.2.1:
|
||||
version "2.2.1"
|
||||
resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe"
|
||||
integrity sha512-kmCevFghRiWM7HB5zTPULl4r9bVFSWjz62MhqizDGUrq2NWuNMQyuv4tHHoKJHs69M/MF64lEcHdYIocrdWQYA==
|
||||
|
||||
argparse@^2.0.1:
|
||||
version "2.0.1"
|
||||
resolved "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz"
|
||||
integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
|
||||
|
||||
chalk@^1.0.0:
|
||||
version "1.1.3"
|
||||
resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98"
|
||||
integrity sha512-U3lRVLMSlsCfjqYPbLyVv11M9CPW4I728d6TCKMAOJueEeB9/8o+eSsMnxPJD+Q+K909sdESg7C+tIkoH6on1A==
|
||||
dependencies:
|
||||
ansi-styles "^2.2.1"
|
||||
escape-string-regexp "^1.0.2"
|
||||
has-ansi "^2.0.0"
|
||||
strip-ansi "^3.0.0"
|
||||
supports-color "^2.0.0"
|
||||
|
||||
commander@^2.8.1:
|
||||
version "2.20.3"
|
||||
resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
|
||||
integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==
|
||||
|
||||
escape-string-regexp@^1.0.2:
|
||||
version "1.0.5"
|
||||
resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
|
||||
integrity sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==
|
||||
|
||||
extend@^2.0.1:
|
||||
version "2.0.2"
|
||||
resolved "https://registry.yarnpkg.com/extend/-/extend-2.0.2.tgz#1b74985400171b85554894459c978de6ef453ab7"
|
||||
integrity sha512-AgFD4VU+lVLP6vjnlNfF7OeInLTyeyckCNPEsuxz1vi786UuK/nk6ynPuhn/h+Ju9++TQyr5EpLRI14fc1QtTQ==
|
||||
|
||||
has-ansi@^2.0.0:
|
||||
version "2.0.0"
|
||||
resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91"
|
||||
integrity sha512-C8vBJ8DwUCx19vhm7urhTuUsr4/IyP6l4VzNQDv+ryHQObW3TTTp9yB68WpYgRe2bbaGuZ/se74IqFeVnMnLZg==
|
||||
dependencies:
|
||||
ansi-regex "^2.0.0"
|
||||
|
||||
js-yaml@^4.1.0:
|
||||
version "4.1.0"
|
||||
resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz"
|
||||
integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
|
||||
dependencies:
|
||||
argparse "^2.0.1"
|
||||
|
||||
moment@^2.10.3:
|
||||
version "2.30.1"
|
||||
resolved "https://registry.yarnpkg.com/moment/-/moment-2.30.1.tgz#f8c91c07b7a786e30c59926df530b4eac96974ae"
|
||||
integrity sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==
|
||||
|
||||
spectral@^0.0.0:
|
||||
version "0.0.0"
|
||||
resolved "https://registry.yarnpkg.com/spectral/-/spectral-0.0.0.tgz#a244b28c0726a7907374ad39c58024f934b9e8a1"
|
||||
integrity sha512-tJamrVCLdpHt3geQn9ypWLlcS7K02+TZV5hj1bnPjGcjQs5N0dtxzJVitcmHbR9tZQgjwj2hAO1f8v1fzzwF1Q==
|
||||
dependencies:
|
||||
chalk "^1.0.0"
|
||||
commander "^2.8.1"
|
||||
extend "^2.0.1"
|
||||
moment "^2.10.3"
|
||||
string-etc "^0.2.0"
|
||||
|
||||
string-etc@^0.2.0:
|
||||
version "0.2.0"
|
||||
resolved "https://registry.yarnpkg.com/string-etc/-/string-etc-0.2.0.tgz#a0f84a2d8816082266384a3c7229acbb8064eda5"
|
||||
integrity sha512-J9RfI2DvBDlnISBhfOBOAXPFxE4cpEgNC6zJTjULmagQaMuu2sYrE44H8h5Paxf3Bm9Wcer92DJv9n77OAHIRg==
|
||||
|
||||
strip-ansi@^3.0.0:
|
||||
version "3.0.1"
|
||||
resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-3.0.1.tgz#6a385fb8853d952d5ff05d0e8aaf94278dc63dcf"
|
||||
integrity sha512-VhumSSbBqDTP8p2ZLKj40UjBCV4+v8bUSEpUb4KjRgWk9pbqGF4REFj6KEagidb2f/M6AzC0EmFyDNGaw9OCzg==
|
||||
dependencies:
|
||||
ansi-regex "^2.0.0"
|
||||
|
||||
supports-color@^2.0.0:
|
||||
version "2.0.0"
|
||||
resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-2.0.0.tgz#535d045ce6b6363fa40117084629995e9df324c7"
|
||||
integrity sha512-KKNVtd6pCYgPIKU4cp2733HWYCpplQhddZLBUryaAHou723x+FRzQ5Df824Fj+IyyuiQTRoub4SnIFfIcrp70g==
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@ function initializeChat({onChatLoad, chatAttributes}) {
|
|||
* available configuration options.
|
||||
* All values are strings.
|
||||
*/
|
||||
// If you make changes to data attributes here, you also need to port the changes to the api-docs/template.hbs API reference template.
|
||||
const requiredAttributes = {
|
||||
websiteId: 'a02bca75-1dd3-411e-95c0-79ee1139be4d',
|
||||
projectName: 'InfluxDB',
|
||||
|
|
@ -27,6 +28,7 @@ function initializeChat({onChatLoad, chatAttributes}) {
|
|||
}
|
||||
|
||||
const optionalAttributes = {
|
||||
|
||||
modalDisclaimer: 'This AI can access [documentation for InfluxDB, clients, and related tools](https://docs.influxdata.com). Information you submit is used in accordance with our [Privacy Policy](https://www.influxdata.com/legal/privacy-policy/).',
|
||||
modalExampleQuestions: 'Use Python to write data to InfluxDB 3,How do I query using SQL?,How do I use MQTT with Telegraf?',
|
||||
buttonHide: 'true',
|
||||
|
|
|
|||
65
compose.yaml
65
compose.yaml
|
|
@ -84,6 +84,9 @@ services:
|
|||
- type: volume
|
||||
source: test-content
|
||||
target: /app/content
|
||||
- type: bind
|
||||
source: ./test/shared/influxdb-templates
|
||||
target: /root/influxdb-templates
|
||||
working_dir: /app
|
||||
cloud-dedicated-pytest:
|
||||
container_name: cloud-dedicated-pytest
|
||||
|
|
@ -245,6 +248,68 @@ services:
|
|||
source: test-content
|
||||
target: /app/content
|
||||
working_dir: /app
|
||||
influxdb3-core-pytest:
|
||||
container_name: influxdb3-core-pytest
|
||||
image: influxdata/docs-pytest
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile.pytest
|
||||
entrypoint:
|
||||
- /bin/bash
|
||||
- /src/test/scripts/run-tests.sh
|
||||
- pytest
|
||||
command:
|
||||
# In the command, pass file paths to test.
|
||||
# The container preprocesses the files for testing and runs the tests.
|
||||
- content/influxdb3/core/**/*.md
|
||||
- content/shared/**/*.md
|
||||
environment:
|
||||
- CONTENT_PATH=content/influxdb3/core
|
||||
profiles:
|
||||
- test
|
||||
- influxdb3
|
||||
stdin_open: true
|
||||
tty: true
|
||||
volumes:
|
||||
# Site configuration files.
|
||||
- type: bind
|
||||
source: .
|
||||
target: /src
|
||||
read_only: true
|
||||
# Files shared between host and container and writeable by both.
|
||||
- type: bind
|
||||
source: ./test/shared
|
||||
target: /shared
|
||||
- type: bind
|
||||
source: ./content/influxdb3/core/.env.test
|
||||
target: /app/.env.test
|
||||
read_only: true
|
||||
# In your code samples, use `/app/data/<FILE.lp>` or `data/<FILE.lp>` to access sample data files from the `static/downloads` directory.
|
||||
- type: bind
|
||||
source: ./static/downloads
|
||||
target: /app/data
|
||||
read_only: true
|
||||
# In your code samples, use `/app/iot-starter` to store example modules or project files.
|
||||
- type: volume
|
||||
source: influxdb3-core-tmp
|
||||
target: /app/iot-starter
|
||||
# Target directory for the content under test.
|
||||
# Files are copied from /src/content/<productpath> to /app/content/<productpath> before running tests.
|
||||
- type: volume
|
||||
source: test-content
|
||||
target: /app/content
|
||||
working_dir: /app
|
||||
influxdb3-core:
|
||||
container_name: influxdb3-core
|
||||
image: quay.io/influxdb/influxdb3-core:latest
|
||||
ports:
|
||||
- 8181:8181
|
||||
command:
|
||||
- serve
|
||||
- --node-id=sensors_node0
|
||||
- --log-filter=debug
|
||||
- --object-store=file
|
||||
- --data-dir=/var/lib/influxdb3
|
||||
telegraf-pytest:
|
||||
container_name: telegraf-pytest
|
||||
image: influxdata/docs-pytest
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ curl -XGET "localhost:8086/health"
|
|||
|
||||
### `/api/v2/buckets/` HTTP endpoint
|
||||
|
||||
The [/api/v2/buckets](/influxdb/latest/api/#tag/Buckets) endpoint accepts `GET`, `POST` and `DELETE` HTTP requests. Use this endpoint to [create](/influxdb/latest/api/#operation/PostBuckets), [delete](/influxdb/latest/api/#operation/DeleteBucketsID), [list](/influxdb/latest/api/#operation/GetBuckets), [update](/influxdb/latest/api/#operation/PatchBucketsID) and [retrieve](/influxdb/latest/api/#operation/GetBucketsID) buckets in your InfluxDB instance. Note that InfluxDB 2.x uses organizations and buckets instead of databases and retention policies.
|
||||
The [/api/v2/buckets](/influxdb/v2/api/#tag/Buckets) endpoint accepts `GET`, `POST` and `DELETE` HTTP requests. Use this endpoint to [create](/influxdb/v2/api/#operation/PostBuckets), [delete](/influxdb/v2/api/#operation/DeleteBucketsID), [list](/influxdb/v2/api/#operation/GetBuckets), [update](/influxdb/v2/api/#operation/PatchBucketsID) and [retrieve](/influxdb/v2/api/#operation/GetBucketsID) buckets in your InfluxDB instance. Note that InfluxDB 2.x uses organizations and buckets instead of databases and retention policies.
|
||||
|
||||
**Include the following URL parameters:**
|
||||
|
||||
|
|
@ -201,7 +201,7 @@ curl --request DELETE "http://localhost:8086/api/v2/buckets/test/autogen"
|
|||
|
||||
### `/api/v2/delete/` HTTP endpoint
|
||||
|
||||
The [`/api/v2/delete`](/influxdb/latest/api/#tag/Delete) endpoint accepts `POST` HTTP requests. Use this endpoint to delete points from InfluxDB, including points with specific tag values, timestamps and measurements.
|
||||
The [`/api/v2/delete`](/influxdb/v2/api/#tag/Delete) endpoint accepts `POST` HTTP requests. Use this endpoint to delete points from InfluxDB, including points with specific tag values, timestamps and measurements.
|
||||
|
||||
**Include the following URL parameters:**
|
||||
|
||||
|
|
@ -353,8 +353,12 @@ curl http://localhost:8086/debug/requests
|
|||
##### Track requests over a ten-second interval
|
||||
|
||||
```bash
|
||||
$ curl http://localhost:8086/debug/requests
|
||||
curl http://localhost:8086/debug/requests
|
||||
```
|
||||
|
||||
The response body contains data in JSON format:
|
||||
|
||||
```JSON
|
||||
{
|
||||
"user1:123.45.678.91": {"writes":1,"queries":0},
|
||||
}
|
||||
|
|
@ -365,8 +369,12 @@ The response shows that, over the past ten seconds, the `user1` user sent one re
|
|||
##### Track requests over a one-minute interval
|
||||
|
||||
```bash
|
||||
$ curl http://localhost:8086/debug/requests?seconds=60
|
||||
curl http://localhost:8086/debug/requests?seconds=60
|
||||
```
|
||||
|
||||
The response body contains data in JSON format:
|
||||
|
||||
```JSON
|
||||
{
|
||||
"user1:123.45.678.91": {"writes":3,"queries":0},
|
||||
"user1:000.0.0.0": {"writes":0,"queries":16},
|
||||
|
|
@ -468,8 +476,12 @@ Those `SELECT` queries require a `POST` request.
|
|||
###### Query data with a `SELECT` statement
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
```
|
||||
|
||||
The response body contains data in JSON format:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:16:18Z",33.1,null,null],["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}
|
||||
```
|
||||
|
||||
|
|
@ -490,8 +502,12 @@ time myfield mytag1 mytag2
|
|||
##### Query data with a `SELECT` statement and an `INTO` clause
|
||||
|
||||
```bash
|
||||
$ curl -XPOST 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * INTO "newmeas" FROM "mymeas"'
|
||||
curl -XPOST 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * INTO "newmeas" FROM "mymeas"'
|
||||
```
|
||||
|
||||
The response body contains data in JSON format:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0,"series":[{"name":"result","columns":["time","written"],"values":[["1970-01-01T00:00:00Z",2]]}]}]}
|
||||
```
|
||||
|
||||
|
|
@ -503,8 +519,12 @@ Note that the system uses epoch 0 (`1970-01-01T00:00:00Z`) as a [null timestamp
|
|||
##### Create a database
|
||||
|
||||
```bash
|
||||
$ curl -XPOST 'http://localhost:8086/query' --data-urlencode 'q=CREATE DATABASE "mydb"'
|
||||
curl -XPOST 'http://localhost:8086/query' --data-urlencode 'q=CREATE DATABASE "mydb"'
|
||||
```
|
||||
|
||||
The response data is similar to the following:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0}]}
|
||||
```
|
||||
|
||||
|
|
@ -536,7 +556,7 @@ See below for an [example](#create-a-database-using-basic-authentication) of bas
|
|||
##### Query data with a `SELECT` statement and return pretty-printed JSON
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb&pretty=true' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
curl -G 'http://localhost:8086/query?db=mydb&pretty=true' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
|
||||
{
|
||||
"results": [
|
||||
|
|
@ -575,8 +595,12 @@ $ curl -G 'http://localhost:8086/query?db=mydb&pretty=true' --data-urlencode 'q=
|
|||
##### Query data with a `SELECT` statement and return second precision epoch timestamps
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb&epoch=s' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
curl -G 'http://localhost:8086/query?db=mydb&epoch=s' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
```
|
||||
|
||||
The response body data is similar to the following:
|
||||
|
||||
```bash
|
||||
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[[1488327378,33.1,null,null],[1488327438,12.4,"12","14"]]}]}]}
|
||||
```
|
||||
|
||||
|
|
@ -586,7 +610,7 @@ The following example shows how to authenticate with v1.x credentials in the que
|
|||
create a database:
|
||||
|
||||
```bash
|
||||
$ curl -XPOST 'http://localhost:8086/query?u=myusername&p=mypassword' --data-urlencode 'q=CREATE DATABASE "mydb"'
|
||||
curl -XPOST 'http://localhost:8086/query?u=myusername&p=mypassword' --data-urlencode 'q=CREATE DATABASE "mydb"'
|
||||
```
|
||||
|
||||
The response body contains the following:
|
||||
|
|
@ -698,26 +722,37 @@ Delimit multiple placeholder key-value pairs with comma `,`.
|
|||
##### Send multiple queries
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb&epoch=s' --data-urlencode 'q=SELECT * FROM "mymeas";SELECT mean("myfield") FROM "mymeas"'
|
||||
curl -G 'http://localhost:8086/query?db=mydb&epoch=s' --data-urlencode 'q=SELECT * FROM "mymeas";SELECT mean("myfield") FROM "mymeas"'
|
||||
```
|
||||
|
||||
The response body contains results for both queries:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[[1488327378,33.1,null,null],[1488327438,12.4,"12","14"]]}]},{"statement_id":1,"series":[{"name":"mymeas","columns":["time","mean"],"values":[[0,22.75]]}]}]}
|
||||
```
|
||||
|
||||
The request includes two queries: `SELECT * FROM "mymeas"` and `SELECT mean("myfield") FROM "mymeas"'`.
|
||||
In the results, the system assigns a statement identifier to each query return.
|
||||
The first query's result has a `statement_id` of `0` and the second query's result has a `statement_id` of `1`.
|
||||
- The request includes two queries: `SELECT * FROM "mymeas"` and `SELECT mean("myfield") FROM "mymeas"'`.
|
||||
- In the results, InfluxDB assigns a statement identifier to each query:
|
||||
- `"statement_id": 0`: the first query
|
||||
- `"statement_id": 1`: the second query
|
||||
|
||||
##### Request query results in CSV format
|
||||
|
||||
```bash
|
||||
$ curl -H "Accept: application/csv" -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
To format results in CSV, specify `application/csv` in the HTTP `Accept` header--for example:
|
||||
|
||||
```bash
|
||||
curl -H "Accept: application/csv" -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
```
|
||||
|
||||
The response body contains data in CSV format:
|
||||
|
||||
```csv
|
||||
name,tags,time,myfield,mytag1,mytag2
|
||||
mymeas,,1488327378000000000,33.1,mytag1,mytag2
|
||||
mymeas,,1488327438000000000,12.4,12,14
|
||||
```
|
||||
|
||||
The first point has no [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) for the `mytag1` and `mytag2` [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key).
|
||||
- In the sample data, the first point doesn't contain [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) for the `mytag1` and `mytag2` [tag keys](/enterprise_influxdb/v1/concepts/glossary/#tag-key).
|
||||
|
||||
##### Submit queries from a file
|
||||
|
||||
|
|
@ -734,57 +769,77 @@ CREATE RETENTION POLICY four_weeks ON mydb DURATION 4w REPLICATION 1;
|
|||
|
||||
##### Bind a parameter in the `WHERE` clause to specific tag value
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "mytag1" = $tag_value' --data-urlencode 'params={"tag_value":"12"}'
|
||||
Use the `params` option to pass arguments for a parameterized query--for example:
|
||||
|
||||
```bash
|
||||
curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "mytag1" = $tag_value' --data-urlencode 'params={"tag_value":"12"}'
|
||||
```
|
||||
|
||||
The response data is similar to the following:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}
|
||||
```
|
||||
|
||||
The request maps `$tag_value` to `12`.
|
||||
InfluxDB stores [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) as strings they and must be double quoted in the request.
|
||||
- In the request, `params` maps `$tag_value` to `"12"`.
|
||||
Because InfluxDB stores [tag values](/enterprise_influxdb/v1/concepts/glossary/#tag-value) as strings, you must double-quote them in parameter values.
|
||||
- During query execution, InfluxDB substitutes the parameter values for the associated keys in the query.
|
||||
|
||||
##### Bind a parameter in the `WHERE` clause to a numerical field value
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "myfield" > $field_value' --data-urlencode 'params={"field_value":30}'
|
||||
curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "myfield" > $field_value' --data-urlencode 'params={"field_value":30}'
|
||||
```
|
||||
|
||||
The response data is similar to the following:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:16:18Z",33.1,null,null]]}]}]}
|
||||
```
|
||||
|
||||
The request maps `$field_value` to `30`.
|
||||
The value `30` does not require double quotes because `myfield` stores numerical [field values](/enterprise_influxdb/v1/concepts/glossary/#field-value).
|
||||
- In the request, `params` maps `$field_value` to `30`. Because `myfield` stores numerical [field values](/enterprise_influxdb/v1/concepts/glossary/#field-value), the parameter value `30` does not require double quotes.
|
||||
- During query execution, InfluxDB substitutes the parameter values for the associated keys in the query.
|
||||
|
||||
##### Bind two parameters in the `WHERE` clause to a specific tag value and numerical field value
|
||||
|
||||
```bash
|
||||
$ curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "mytag1" = $tag_value AND "myfield" < $field_value' --data-urlencode 'params={"tag_value":"12","field_value":30}'
|
||||
curl -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas" WHERE "mytag1" = $tag_value AND "myfield" < $field_value' --data-urlencode 'params={"tag_value":"12","field_value":30}'
|
||||
```
|
||||
|
||||
The response data is similar to the following:
|
||||
|
||||
```JSON
|
||||
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag1","mytag2"],"values":[["2017-03-01T00:17:18Z",12.4,"12","14"]]}]}]}
|
||||
```
|
||||
|
||||
The request maps `$tag_value` to `12` and `$field_value` to `30`.
|
||||
- In the request, `params` maps `$tag_value` to `12` and `$field_value` to `30`.
|
||||
- During query execution, InfluxDB substitutes the parameter values for the associated keys in the query.
|
||||
|
||||
#### Status codes and responses
|
||||
|
||||
The API response body contains results or error messages in JSON format.
|
||||
To pretty-print JSON for viewing, include the query string parameter `pretty=true`
|
||||
or pipe the response to a JSON-processor like [**jq**](https://stedolan.github.io/jq/).
|
||||
or pipe the response to a JSON-processor, such as [**jq**](https://stedolan.github.io/jq/).
|
||||
|
||||
##### Summary table
|
||||
|
||||
| HTTP status code | Description |
|
||||
| :--------------- | :---------- |
|
||||
| 200 OK | Success. Response body contains data in JSON format. |
|
||||
| 400 Bad Request | Unacceptable request. Can occur with a syntactically incorrect query. Response body contains an error message with additional information in JSON format. |
|
||||
| 401 Unauthorized | Unacceptable request. Can occur with invalid authentication credentials. |
|
||||
| `200 OK` | Success. Response body contains data in JSON format. |
|
||||
| `400 Bad Request` | Unacceptable request. Can occur with a syntactically incorrect query. Response body contains an error message with additional information in JSON format. |
|
||||
| `401 Unauthorized` | Unacceptable request. Can occur with invalid authentication credentials. |
|
||||
|
||||
#### Examples
|
||||
|
||||
##### A successful request that returns data
|
||||
|
||||
```bash
|
||||
$ curl -i -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
curl -i -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
```
|
||||
|
||||
The response is HTTP status `200 OK` and the body contains data in JSON format:
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Type: application/json
|
||||
|
|
@ -799,8 +854,11 @@ Transfer-Encoding: chunked
|
|||
##### A query that contains an error
|
||||
|
||||
```bash
|
||||
$ curl -i -G 'http://localhost:8086/query?db=mydb1' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
curl -i -G 'http://localhost:8086/query?db=mydb1' --data-urlencode 'q=SELECT * FROM "mymeas"'
|
||||
|
||||
The response body contains details about the error:
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Connection: close
|
||||
Content-Type: application/json
|
||||
|
|
@ -815,8 +873,13 @@ Transfer-Encoding: chunked
|
|||
##### An incorrectly formatted query
|
||||
|
||||
```bash
|
||||
$ curl -i -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT *'
|
||||
curl -i -G 'http://localhost:8086/query?db=mydb' --data-urlencode 'q=SELECT *'
|
||||
```
|
||||
|
||||
The response is HTTP status `400 Bad Request` and the body contains details
|
||||
about the error:
|
||||
|
||||
```
|
||||
HTTP/1.1 400 Bad Request
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
|
|
@ -830,8 +893,12 @@ Content-Length: 76
|
|||
##### A request with invalid authentication credentials
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST 'http://localhost:8086/query?u=myusername&p=notmypassword' --data-urlencode 'q=CREATE DATABASE "mydb"'
|
||||
curl -i -XPOST 'http://localhost:8086/query?u=myusername&p=notmypassword' --data-urlencode 'q=CREATE DATABASE "mydb"'
|
||||
```
|
||||
|
||||
The response is HTTP status `401 Unauthorized` and the body contains the error message.
|
||||
|
||||
```
|
||||
HTTP/1.1 401 Unauthorized
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
|
|
@ -878,8 +945,12 @@ in significant improvements in compression.
|
|||
##### Write a point to the database `mydb` with a timestamp in seconds
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb&precision=s" --data-binary 'mymeas,mytag=1 myfield=90 1463683075'
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb&precision=s" --data-binary 'mymeas,mytag=1 myfield=90 1463683075'
|
||||
```
|
||||
|
||||
A successful write returns HTTP status `204 No Content`--for example:
|
||||
|
||||
```
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
|
|
@ -890,13 +961,7 @@ Date: Wed, 08 Nov 2017 17:33:23 GMT
|
|||
##### Write a point to the database `mydb` and the retention policy `myrp`
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb&rp=myrp" --data-binary 'mymeas,mytag=1 myfield=90'
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 17:34:31 GMT
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb&rp=myrp" --data-binary 'mymeas,mytag=1 myfield=90'
|
||||
```
|
||||
|
||||
##### Write a point to the database `mydb` using HTTP authentication
|
||||
|
|
@ -904,20 +969,25 @@ Date: Wed, 08 Nov 2017 17:34:31 GMT
|
|||
Valid credentials:
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb&u=myusername&p=mypassword" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb&u=myusername&p=mypassword" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
```
|
||||
|
||||
A successful write returns HTTP status `204 No Content`.
|
||||
|
||||
```
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 17:34:56 GMT
|
||||
```
|
||||
|
||||
Invalid credentials:
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb&u=myusername&p=notmypassword" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb&u=myusername&p=notmypassword" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
```
|
||||
|
||||
If the username or password is incorrect, the response status is `401 Unauthorized`
|
||||
and the response body contains the error message--for example:
|
||||
|
||||
```
|
||||
HTTP/1.1 401 Unauthorized
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
|
|
@ -931,23 +1001,20 @@ Content-Length: 33
|
|||
|
||||
##### Write a point to the database `mydb` using basic authentication
|
||||
|
||||
Valid credentials:
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST -u myusername:mypassword "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 17:36:40 GMT
|
||||
curl -i -XPOST -u myusername:mypassword "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
```
|
||||
|
||||
Invalid credentials:
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST -u myusername:notmypassword "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
curl -i -XPOST -u myusername:notmypassword "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=91'
|
||||
```
|
||||
|
||||
If the username or password is incorrect, the response status is `401 Unauthorized`
|
||||
and the response body contains the error message--for example:
|
||||
|
||||
```
|
||||
HTTP/1.1 401 Unauthorized
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
|
|
@ -965,79 +1032,65 @@ Content-Length: 33
|
|||
--data-binary '<Data in InfluxDB line protocol format>'
|
||||
```
|
||||
|
||||
All data must be binary encoded and in the
|
||||
Data to write must be binary encoded and in the
|
||||
[InfluxDB line protocol](/enterprise_influxdb/v1/concepts/glossary/#influxdb-line-protocol) format.
|
||||
Our example shows the `--data-binary` parameter from curl, which we will use in
|
||||
all examples on this page.
|
||||
|
||||
Examples in this page use `curl` with the `--data-binary` parameter to encode
|
||||
line protocol in the request.
|
||||
Using any encoding method other than `--data-binary` will likely lead to issues;
|
||||
`-d`, `--data-urlencode`, and `--data-ascii` may strip out newlines or
|
||||
introduce new, unintended formatting.
|
||||
introduce unintended formatting.
|
||||
|
||||
Options:
|
||||
|
||||
* Write several points to the database with one request by separating each point
|
||||
- Write several points to the database with one request by separating each point
|
||||
by a new line.
|
||||
* Write points from a file with the `@` flag.
|
||||
The file should contain a batch of points in the InfluxDB line protocol format.
|
||||
- Write points from a file with the `@` flag.
|
||||
The file should contain a batch of points in line protocol format.
|
||||
Individual points must be on their own line and separated by newline characters
|
||||
(`\n`).
|
||||
Files containing carriage returns will cause parser errors.
|
||||
Files containing carriage returns cause parser errors.
|
||||
|
||||
We recommend writing points in batches of 5,000 to 10,000 points.
|
||||
Smaller batches, and more HTTP requests, will result in sub-optimal performance.
|
||||
> [!Important]
|
||||
> #### Batch writes for optimal performance
|
||||
> Write points in batches of 5,000 to 10,000 points.
|
||||
> Smaller batches, and more HTTP requests, will result in sub-optimal performance.
|
||||
|
||||
#### Examples
|
||||
|
||||
##### Write a point to the database `mydb` with a nanosecond timestamp
|
||||
##### Write a point with a nanosecond timestamp to the `mydb` database
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=90 1463683075000000000'
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 18:02:57 GMT
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=90 1463683075000000000'
|
||||
```
|
||||
|
||||
##### Write a point to the database `mydb` with the local server's nanosecond timestamp
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=90'
|
||||
If successful, the response status is HTTP `204 No Content`.
|
||||
|
||||
```
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 18:03:44 GMT
|
||||
```
|
||||
|
||||
##### Write several points to the database `mydb` by separating points with a new line
|
||||
##### Write a point with the local server's nanosecond timestamp to the `mydb` database
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=3 myfield=89 1463689152000000000
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=1 myfield=90'
|
||||
```
|
||||
|
||||
##### Write several points to the database by separating points with a new line
|
||||
|
||||
```bash
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary 'mymeas,mytag=3 myfield=89 1463689152000000000
|
||||
mymeas,mytag=2 myfield=34 1463689152000000000'
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 18:04:02 GMT
|
||||
```
|
||||
|
||||
##### Write several points to the database `mydb` from the file `data.txt`
|
||||
|
||||
```bash
|
||||
$ curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary @data.txt
|
||||
|
||||
HTTP/1.1 204 No Content
|
||||
Content-Type: application/json
|
||||
Request-Id: [...]
|
||||
X-Influxdb-Version: {{< latest-patch >}}
|
||||
Date: Wed, 08 Nov 2017 18:08:11 GMT
|
||||
curl -i -XPOST "http://localhost:8086/write?db=mydb" --data-binary @data.txt
|
||||
```
|
||||
|
||||
A sample of the data in `data.txt`:
|
||||
`data.txt` contains the following sample data:
|
||||
|
||||
```
|
||||
mymeas,mytag1=1 value=21 1463689680000000000
|
||||
mymeas,mytag1=1 value=34 1463689690000000000
|
||||
|
|
@ -1132,7 +1185,7 @@ Requests to `/shard-status` return the following information in JSON format:
|
|||
- `size`: the size on disk of the shard in bytes
|
||||
- `is_hot`: whether the time range from the shard includes `now`
|
||||
{{% note %}}
|
||||
An *idle* shard is fully compacted and not receiving new (potentially historical) writes.
|
||||
An _idle_ shard is fully compacted and not receiving new (potentially historical) writes.
|
||||
A hot shard may or may not be idle.
|
||||
{{% /note %}}
|
||||
- `state`: the anti-entropy status of the shard can be one of the following:
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ description: >
|
|||
Use [`join.time()`](/flux/v0/stdlib/join/time/) to join two streams of data
|
||||
based on time values in the `_time` column.
|
||||
This type of join operation is common when joining two streams of
|
||||
[time series data](/influxdb/latest/reference/glossary/#time-series-data).
|
||||
[time series data](/influxdb/v2/reference/glossary/#time-series-data).
|
||||
menu:
|
||||
flux_v0:
|
||||
parent: Join data
|
||||
|
|
@ -31,7 +31,7 @@ list_code_example: |
|
|||
Use [`join.time()`](/flux/v0/stdlib/join/time/) to join two streams of data
|
||||
based on time values in the `_time` column.
|
||||
This type of join operation is common when joining two streams of
|
||||
[time series data](/influxdb/latest/reference/glossary/#time-series-data).
|
||||
[time series data](/influxdb/v2/reference/glossary/#time-series-data).
|
||||
|
||||
`join.time()` can use any of the available join methods.
|
||||
Which method you use depends on your desired behavior:
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ Durations are relative to `now()`.
|
|||
|
||||
URL of the InfluxDB instance to query.
|
||||
|
||||
See [InfluxDB OSS URLs](/influxdb/latest/reference/urls/)
|
||||
See [InfluxDB OSS URLs](/influxdb/v2/reference/urls/)
|
||||
or [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/).
|
||||
|
||||
### org
|
||||
|
|
@ -97,7 +97,7 @@ Organization name.
|
|||
|
||||
### token
|
||||
|
||||
InfluxDB [API token](/influxdb/latest/security/tokens/).
|
||||
InfluxDB [API token](/influxdb/v2/security/tokens/).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -119,7 +119,7 @@ Records that evaluate to _null_ or `false` are not included in the output tables
|
|||
|
||||
URL of the InfluxDB instance to query.
|
||||
|
||||
See [InfluxDB OSS URLs](/influxdb/latest/reference/urls/)
|
||||
See [InfluxDB OSS URLs](/influxdb/v2/reference/urls/)
|
||||
or [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/).
|
||||
|
||||
### org
|
||||
|
|
@ -130,7 +130,7 @@ Organization name.
|
|||
|
||||
### token
|
||||
|
||||
InfluxDB [API token](/influxdb/latest/security/tokens/).
|
||||
InfluxDB [API token](/influxdb/v2/security/tokens/).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: csv.from() function
|
||||
description: >
|
||||
`csv.from()` retrieves [annotated CSV](/influxdb/latest/reference/syntax/annotated-csv/) **from a URL**.
|
||||
`csv.from()` retrieves [annotated CSV](/influxdb/v2/reference/syntax/annotated-csv/) **from a URL**.
|
||||
menu:
|
||||
flux_v0_ref:
|
||||
name: csv.from
|
||||
|
|
@ -26,7 +26,7 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
|
|||
|
||||
------------------------------------------------------------------------------->
|
||||
|
||||
`csv.from()` retrieves [annotated CSV](/influxdb/latest/reference/syntax/annotated-csv/) **from a URL**.
|
||||
`csv.from()` retrieves [annotated CSV](/influxdb/v2/reference/syntax/annotated-csv/) **from a URL**.
|
||||
|
||||
{{% warn %}}
|
||||
#### Deprecated
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ Geometry Library to generate `s2_cell_id` tags.
|
|||
Specify your [S2 Cell ID level](https://s2geometry.io/resources/s2cell_statistics.html).
|
||||
|
||||
**Note:** To filter more quickly, use higher S2 Cell ID levels, but know that
|
||||
higher levels increase [series cardinality](/influxdb/latest/reference/glossary/#series-cardinality).
|
||||
higher levels increase [series cardinality](/influxdb/v2/reference/glossary/#series-cardinality).
|
||||
|
||||
Language-specific implementations of the S2 Geometry Library provide methods for
|
||||
generating S2 Cell ID tokens. For example:
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
|
|||
|
||||
`prometheus.histogramQuantile()` calculates a quantile on a set of Prometheus histogram values.
|
||||
|
||||
This function supports [Prometheus metric parsing formats](/influxdb/latest/reference/prometheus-metrics/)
|
||||
This function supports [Prometheus metric parsing formats](/influxdb/v2/reference/prometheus-metrics/)
|
||||
used by `prometheus.scrape()`, the Telegraf `promtheus` input plugin, and
|
||||
InfluxDB scrapers available in InfluxDB OSS.
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ Quantile to compute. Must be a float value between 0.0 and 1.0.
|
|||
|
||||
### metricVersion
|
||||
|
||||
[Prometheus metric parsing format](/influxdb/latest/reference/prometheus-metrics/)
|
||||
[Prometheus metric parsing format](/influxdb/v2/reference/prometheus-metrics/)
|
||||
used to parse queried Prometheus data.
|
||||
Available versions are `1` and `2`.
|
||||
Default is `2`.
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ _`bucket` and `bucketID` are mutually exclusive_.
|
|||
URL of the InfluxDB instance to write to.
|
||||
|
||||
See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/latest/reference/urls/).
|
||||
or [InfluxDB OSS URLs](/influxdb/v2/reference/urls/).
|
||||
`host` is required when writing to a remote InfluxDB instance.
|
||||
If specified, `token` is also required.
|
||||
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ _`org` and `orgID` are mutually exclusive_.
|
|||
URL of the InfluxDB instance.
|
||||
|
||||
See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/latest/reference/urls/).
|
||||
or [InfluxDB OSS URLs](/influxdb/v2/reference/urls/).
|
||||
_`host` is required when `org` or `orgID` are specified._
|
||||
|
||||
### token
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ String-encoded organization ID.
|
|||
URL of the InfluxDB instance to query.
|
||||
|
||||
See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/latest/reference/urls/).
|
||||
or [InfluxDB OSS URLs](/influxdb/v2/reference/urls/).
|
||||
|
||||
### token
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ _`bucket` and `bucketID` are mutually exclusive_.
|
|||
URL of the InfluxDB instance to query.
|
||||
|
||||
See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/latest/reference/urls/).
|
||||
or [InfluxDB OSS URLs](/influxdb/v2/reference/urls/).
|
||||
|
||||
### org
|
||||
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ _`bucket` and `bucketID` are mutually exclusive_.
|
|||
URL of the InfluxDB instance to write to.
|
||||
|
||||
See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/latest/reference/urls/).
|
||||
or [InfluxDB OSS URLs](/influxdb/v2/reference/urls/).
|
||||
`host` is required when writing to a remote InfluxDB instance.
|
||||
If specified, `token` is also required.
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ _`bucket` and `bucketID` are mutually exclusive_.
|
|||
URL of the InfluxDB instance to write to.
|
||||
|
||||
See [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/latest/reference/urls/).
|
||||
or [InfluxDB OSS URLs](/influxdb/v2/reference/urls/).
|
||||
`host` is required when writing to a remote InfluxDB instance.
|
||||
If specified, `token` is also required.
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ UI and export the resources as a template.
|
|||
{{< youtube 714uHkxKM6U >}}
|
||||
|
||||
{{% note %}}
|
||||
#### InfluxDB OSS for creating templates
|
||||
#### InfluxDB OSS v2 for creating templates
|
||||
Templatable resources are scoped to a single organization, so the simplest way to create a
|
||||
template is to create a new organization, build the template within the organization,
|
||||
and then [export all resources](#export-all-resources) as a template.
|
||||
|
|
@ -54,15 +54,21 @@ Provide the following:
|
|||
**JSON** (`.json`) are supported.
|
||||
|
||||
###### Export all resources to a template
|
||||
```sh
|
||||
# Syntax
|
||||
influx export all -o <INFLUX_ORG> -f <FILE_PATH> -t <INFLUX_TOKEN>
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
# Syntax
|
||||
influx export all --org <INFLUX_ORG> --file <FILE_PATH> --token <INFLUX_TOKEN>
|
||||
```
|
||||
|
||||
<!--The following fails due to an apparent missing task query in the account-->
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
# Example
|
||||
influx export all \
|
||||
-o my-org \
|
||||
-f ~/templates/awesome-template.yml \
|
||||
-t $INFLUX_TOKEN
|
||||
--org $INFLUX_ORG \
|
||||
--file /path/to/TEMPLATE_FILE.yml \
|
||||
--token $INFLUX_TOKEN
|
||||
```
|
||||
|
||||
#### Export resources filtered by labelName or resourceKind
|
||||
|
|
@ -81,9 +87,9 @@ and
|
|||
|
||||
```sh
|
||||
influx export all \
|
||||
-o my-org \
|
||||
-f ~/templates/awesome-template.yml \
|
||||
-t $INFLUX_TOKEN \
|
||||
--org $INFLUX_ORG \
|
||||
--file /path/to/TEMPLATE_FILE.yml \
|
||||
--token $INFLUX_TOKEN \
|
||||
--filter=resourceKind=Bucket \
|
||||
--filter=resourceKind=Dashboard \
|
||||
--filter=labelName=Example1 \
|
||||
|
|
@ -94,12 +100,14 @@ For information about flags, see the
|
|||
[`influx export all` documentation](/influxdb/cloud/reference/cli/influx/export/all/).
|
||||
|
||||
### Export specific resources
|
||||
|
||||
To export specific resources within an organization to a template manifest,
|
||||
use the `influx export` with resource flags for each resource to include.
|
||||
The command uses the API token to filter resources for the organization.
|
||||
|
||||
Provide the following:
|
||||
|
||||
- **Organization name** or **ID**
|
||||
- **API token** with read access to the organization
|
||||
- **API token** with read access to the organization.
|
||||
- **Destination path and filename** for the template manifest.
|
||||
The filename extension determines the template format—both **YAML** (`.yml`) and
|
||||
**JSON** (`.json`) are supported.
|
||||
|
|
@ -108,15 +116,20 @@ Provide the following:
|
|||
[`influx export` documentation](/influxdb/cloud/reference/cli/influx/export/).
|
||||
|
||||
###### Export specific resources to a template
|
||||
```sh
|
||||
# Syntax
|
||||
influx export all -o <INFLUX_ORG> -f <FILE_PATH> -t <INFLUX_TOKEN> [resource-flags]
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
# Syntax
|
||||
influx export --file <FILE_PATH> --token <INFLUX_TOKEN> [resource-flags]
|
||||
```
|
||||
|
||||
<!-- Fails due to resource ID placeholders -->
|
||||
<!--pytest.mark.xfail-->
|
||||
```bash
|
||||
# Example
|
||||
influx export all \
|
||||
-o my-org \
|
||||
-f ~/templates/awesome-template.yml \
|
||||
-t $INFLUX_TOKEN \
|
||||
influx export \
|
||||
--file /path/to/TEMPLATE_FILE.yml \
|
||||
--token $INFLUX_TOKEN \
|
||||
--buckets=00x000ooo0xx0xx,o0xx0xx00x000oo \
|
||||
--dashboards=00000xX0x0X00x000 \
|
||||
--telegraf-configs=00000x0x000X0x0X0
|
||||
|
|
@ -125,9 +138,10 @@ influx export all \
|
|||
### Export a stack
|
||||
To export a stack and all its associated resources as a template, use the
|
||||
`influx export stack` command.
|
||||
The command uses the API token to filter resources for the organization.
|
||||
|
||||
Provide the following:
|
||||
|
||||
- **Organization name** or **ID**
|
||||
- **API token** with read access to the organization
|
||||
- **Destination path and filename** for the template manifest.
|
||||
The filename extension determines the template format—both **YAML** (`.yml`) and
|
||||
|
|
@ -135,19 +149,23 @@ Provide the following:
|
|||
- **Stack ID**
|
||||
|
||||
###### Export a stack as a template
|
||||
```sh
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
# Syntax
|
||||
influx export stack \
|
||||
-o <INFLUX_ORG> \
|
||||
-t <INFLUX_TOKEN> \
|
||||
-f <FILE_PATH> \
|
||||
--token <INFLUX_TOKEN> \
|
||||
--file <FILE_PATH> \
|
||||
<STACK_ID>
|
||||
```
|
||||
|
||||
<!-- Fails due to non-existent STACK_ID -->
|
||||
<!--pytest.mark.xfail-->
|
||||
```bash
|
||||
# Example
|
||||
influx export stack \
|
||||
-o my-org \
|
||||
-t mYSuP3RS3CreTt0K3n
|
||||
-f ~/templates/awesome-template.yml \
|
||||
-t $INFLUX_TOKEN \
|
||||
-f /path/to/TEMPLATE_FILE.yml \
|
||||
05dbb791a4324000
|
||||
```
|
||||
|
||||
|
|
@ -206,11 +224,47 @@ when [applying the template](/influxdb/cloud/tools/influxdb-templates/use/#apply
|
|||
Users can also include the `--env-ref` flag with the appropriate key-value pair
|
||||
when installing the template.
|
||||
|
||||
<!-- //REVIEW I can't get this to work with environment reference substitution
|
||||
-- Skipping the test for now, but we should review it and fix it.
|
||||
-->
|
||||
<!--pytest.mark.skip-->
|
||||
<!--test:setup
|
||||
```sh
|
||||
# Set bucket-name-1 to "myBucket"
|
||||
jq -n '{
|
||||
apiVersion: "influxdata.com/v2alpha1",
|
||||
kind: "Bucket",
|
||||
metadata: {
|
||||
name: {
|
||||
envRef: {
|
||||
key: "bucket-name-1"
|
||||
}
|
||||
}
|
||||
}
|
||||
}' > /path/to/TEMPLATE_FILE.json
|
||||
chmod +rx /path/to/TEMPLATE_FILE.json
|
||||
# View formatted JSON
|
||||
jq '.' /path/to/TEMPLATE_FILE.json
|
||||
```
|
||||
-->
|
||||
|
||||
For example, to set a custom bucket name when applying a template with an environment reference:
|
||||
|
||||
<!--pytest-codeblocks:cont-->
|
||||
```sh
|
||||
# The template, edited to include an environment reference:
|
||||
# apiVersion: influxdata.com/v2alpha1
|
||||
# kind: Bucket
|
||||
# metadata:
|
||||
# name:
|
||||
# envRef: bucket-name-1
|
||||
|
||||
# Apply template, set bucket-name-1 to "myBucket", and skip verification
|
||||
influx apply \
|
||||
-f /path/to/template.yml \
|
||||
--env-ref=bucket-name-1=myBucket
|
||||
--file /path/to/TEMPLATE_FILE.json \
|
||||
--env-ref bucket-name-1=myBucket \
|
||||
--force yes
|
||||
--org $INFLUX_ORG
|
||||
--token $INFLUX_TOKEN
|
||||
```
|
||||
|
||||
_If sharing your template, we recommend documenting what environment references
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ menu:
|
|||
weight: 70
|
||||
parent: Concepts
|
||||
aliases:
|
||||
- /influxdb/latest/concepts/time-series-index/
|
||||
- /influxdb/v2/concepts/time-series-index/
|
||||
---
|
||||
|
||||
Find overview and background information on Time Series Index (TSI) in this topic. For detail, including how to enable and configure TSI, see [Time Series Index (TSI) details](/influxdb/v1/concepts/tsi-details/).
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ aliases:
|
|||
- /influxdb/v2/introduction/getting_started/
|
||||
- /influxdb/v2/introduction/getting_started/
|
||||
- /influxdb/v2/introduction/getting_started/
|
||||
- /influxdb/latest/introduction/getting-started/
|
||||
- /influxdb/v2/introduction/getting-started/
|
||||
|
||||
menu:
|
||||
influxdb_v1:
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ menu:
|
|||
weight: 70
|
||||
identifier: InfluxQL
|
||||
aliases:
|
||||
- /influxdb/latest/query_language/_index
|
||||
- /influxdb/v2/query_language/_index
|
||||
---
|
||||
|
||||
This section introduces InfluxQL, the InfluxDB SQL-like query language for
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ aliases:
|
|||
- /influxdb/v2/query_language/spec/
|
||||
- /influxdb/v2/query_language/spec/
|
||||
- /influxdb/v2/query_language/spec/
|
||||
- /influxdb/latest/query_language/spec/
|
||||
- /influxdb/v2/query_language/spec/
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
|
@ -234,12 +234,13 @@ regex_lit = "/" { unicode_char } "/" .
|
|||
`=~` matches against
|
||||
`!~` doesn't match against
|
||||
|
||||
> **Note:** InfluxQL supports using regular expressions when specifying:
|
||||
> [!Note]
|
||||
> InfluxQL supports using regular expressions when specifying:
|
||||
>
|
||||
* [field keys](/influxdb/v1/concepts/glossary/#field-key) and [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement)
|
||||
* [measurements](/influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement)
|
||||
* [tag values](/influxdb/v1/concepts/glossary/#tag-value) and string [field values](/influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/influxdb/v1/query_language/explore-data/#the-where-clause).
|
||||
* [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/influxdb/v1/query_language/explore-data/#group-by-tags)
|
||||
> * [field keys](/influxdb/v1/concepts/glossary/#field-key) and [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`SELECT` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement)
|
||||
> * [measurements](/influxdb/v1/concepts/glossary/#measurement) in the [`FROM` clause](/influxdb/v1/query_language/explore-data/#the-basic-select-statement)
|
||||
> * [tag values](/influxdb/v1/concepts/glossary/#tag-value) and string [field values](/influxdb/v1/concepts/glossary/#field-value) in the [`WHERE` clause](/influxdb/v1/query_language/explore-data/#the-where-clause).
|
||||
> * [tag keys](/influxdb/v1/concepts/glossary/#tag-key) in the [`GROUP BY` clause](/influxdb/v1/query_language/explore-data/#group-by-tags)
|
||||
>
|
||||
>Currently, InfluxQL does not support using regular expressions to match
|
||||
>non-string field values in the
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ including buckets, organizations, users, tasks, etc.
|
|||
{{% oss-only %}}
|
||||
|
||||
{{% note %}}
|
||||
#### InfluxDB OSS and influx CLI versions
|
||||
#### InfluxDB OSS v2 and influx CLI versions
|
||||
Beginning with **InfluxDB 2.1**, the `influx` CLI is packaged and versioned separately
|
||||
from InfluxDB.
|
||||
InfluxDB and `influx` CLI versions may differ, but compatibility is noted for each command.
|
||||
|
|
@ -69,6 +69,8 @@ Do one of the following:
|
|||
- [Manually download and install](#manually-download-and-install)
|
||||
|
||||
### Use Homebrew
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```sh
|
||||
brew install influxdb-cli
|
||||
```
|
||||
|
|
@ -80,6 +82,7 @@ If you used Homebrew to install **InfluxDB {{< current-version >}}**, the `influ
|
|||
formula was downloaded as a dependency and should already be installed.
|
||||
If installed, `influxdb-cli` will appear in the output of the following command:
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```sh
|
||||
brew list | grep influxdb-cli
|
||||
```
|
||||
|
|
@ -91,40 +94,49 @@ brew list | grep influxdb-cli
|
|||
|
||||
1. **Download the `influx` CLI package.**
|
||||
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz" download>influx CLI v{{< latest-patch cli=true >}} (macOS)</a>
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz" download>influx CLI v{{< latest-patch cli=true >}} (macOS)</a>
|
||||
|
||||
<!--test:previous
|
||||
```sh
|
||||
curl -s -o ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz \
|
||||
https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz
|
||||
```
|
||||
-->
|
||||
|
||||
2. **Unpackage the downloaded package.**
|
||||
|
||||
Do one of the following:
|
||||
Do one of the following:
|
||||
|
||||
- Double-click the downloaded package file in **Finder**.
|
||||
- Run the following command in a macOS command prompt application such
|
||||
**Terminal** or **[iTerm2](https://www.iterm2.com/)**:
|
||||
|
||||
```sh
|
||||
# Unpackage contents to the current working directory
|
||||
tar zxvf ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz
|
||||
```
|
||||
- Double-click the downloaded package file in **Finder**.
|
||||
- Run the following command in a macOS command prompt application such
|
||||
**Terminal** or **[iTerm2](https://www.iterm2.com/)**:
|
||||
|
||||
<!--pytest-codeblocks:cont-->
|
||||
```sh
|
||||
# Unpackage contents to the current working directory
|
||||
tar zxvf ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz
|
||||
```
|
||||
|
||||
3. **(Optional) Place the binary in your `$PATH`.**
|
||||
|
||||
```sh
|
||||
# (Optional) Copy the influx binary to your $PATH
|
||||
sudo cp ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64/influx /usr/local/bin/
|
||||
```
|
||||
<!--pytest.mark.skip-->
|
||||
```sh
|
||||
# (Optional) Copy the influx binary to your $PATH
|
||||
sudo cp ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64/influx /usr/local/bin/
|
||||
```
|
||||
|
||||
If you do not move the `influx` binary into your `$PATH`, prefix the executable
|
||||
`./` to run it in place.
|
||||
If you do not move the `influx` binary into your `$PATH`, prefix the executable
|
||||
`./` to run it in place.
|
||||
|
||||
4. **(macOS Catalina and newer) Authorize the `influx` binary.**
|
||||
|
||||
macOS requires downloaded binaries to be signed by registered Apple developers.
|
||||
When you first attempt to run `influx`, macOS will prevent it from running.
|
||||
To authorize the `influx` binary:
|
||||
macOS requires downloaded binaries to be signed by registered Apple developers.
|
||||
When you first attempt to run `influx`, macOS will prevent it from running.
|
||||
To authorize the `influx` binary:
|
||||
|
||||
1. Attempt to run an `influx` command.
|
||||
2. Open **System Preferences** and click **Security & Privacy**.
|
||||
3. Under the **General** tab, there is a message about `influx` being blocked.
|
||||
1. Attempt to run an `influx` command.
|
||||
2. Open **System Preferences** and click **Security & Privacy**.
|
||||
3. Under the **General** tab, there is a message about `influx` being blocked.
|
||||
Click **Open Anyway**.
|
||||
|
||||
{{% /tab-content %}}
|
||||
|
|
@ -135,48 +147,54 @@ brew list | grep influxdb-cli
|
|||
|
||||
1. **Download the influx CLI package.**
|
||||
|
||||
Download the `influx` CLI package [from your browser](#download-from-your-browser)
|
||||
or [from the command line](#download-from-the-command-line).
|
||||
Download the `influx` CLI package [from your browser](#download-from-your-browser)
|
||||
or [from the command line](#download-from-the-command-line).
|
||||
|
||||
#### Download from your browser
|
||||
#### Download from your browser
|
||||
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz" download >influx CLI v{{< latest-patch cli=true >}} (amd64)</a>
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz" download >influx CLI v{{< latest-patch cli=true >}} (arm)</a>
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz" download >influx CLI v{{< latest-patch cli=true >}} (amd64)</a>
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz" download >influx CLI v{{< latest-patch cli=true >}} (arm)</a>
|
||||
|
||||
#### Download from the command line
|
||||
#### Download from the command line
|
||||
|
||||
```sh
|
||||
# amd64
|
||||
wget https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
|
||||
```bash
|
||||
# amd64
|
||||
curl -O \
|
||||
https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
# arm
|
||||
wget https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz
|
||||
```
|
||||
<!--python-codeblocks:cont-->
|
||||
```bash
|
||||
# arm
|
||||
curl -O \
|
||||
https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz \
|
||||
```
|
||||
|
||||
4. **Unpackage the downloaded package.**
|
||||
2. **Unpackage the downloaded package.**
|
||||
|
||||
_**Note:** The following commands are examples. Adjust the filenames, paths, and utilities if necessary._
|
||||
_**Note:** The following commands are examples. Adjust the filenames, paths, and utilities if necessary._
|
||||
|
||||
```sh
|
||||
# amd64
|
||||
tar xvzf path/to/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
|
||||
<!--python-codeblocks:cont-->
|
||||
```bash
|
||||
# amd64
|
||||
tar xvzf influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
# arm
|
||||
tar xvzf path/to/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz
|
||||
```
|
||||
<!--python-codeblocks:cont-->
|
||||
```bash
|
||||
# arm
|
||||
tar xvzf influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz
|
||||
```
|
||||
|
||||
3. **(Optional) Place the unpackaged `influx` executable in your system `$PATH`.**
|
||||
|
||||
```sh
|
||||
# amd64
|
||||
sudo cp influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64/influx /usr/local/bin/
|
||||
<!--python-codeblocks:cont-->
|
||||
```bash
|
||||
sudo cp ./influx /usr/local/bin/
|
||||
```
|
||||
|
||||
# arm
|
||||
sudo cp influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64/influx /usr/local/bin/
|
||||
```
|
||||
|
||||
If you do not move the `influx` binary into your `$PATH`, prefix the executable
|
||||
`./` to run it in place.
|
||||
If you do not move the `influx` binary into your `$PATH`, prefix the executable
|
||||
`./` to run it in place.
|
||||
|
||||
{{% /tab-content %}}
|
||||
<!--------------------------------- END Linux --------------------------------->
|
||||
|
|
@ -185,34 +203,36 @@ brew list | grep influxdb-cli
|
|||
{{% tab-content %}}
|
||||
|
||||
{{% note %}}
|
||||
We recommend running `influx` CLI commands in Powershell.
|
||||
#### Use Powershell for Windows
|
||||
|
||||
Use Powershell for running `influx` CLI commands.
|
||||
Command Prompt is not fully compatible.
|
||||
{{% /note %}}
|
||||
|
||||
1. **Download the `influx` CLI package.**
|
||||
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64.zip" download>influx CLI v{{< latest-patch cli=true >}} (Windows)</a>
|
||||
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64.zip" download>influx CLI v{{< latest-patch cli=true >}} (Windows)</a>
|
||||
|
||||
2. **Expand the downloaded archive.**
|
||||
|
||||
Expand the downloaded archive into `C:\Program Files\InfluxData\` and rename it if desired.
|
||||
Expand the downloaded archive into `C:\Program Files\InfluxData\` and rename it if desired.
|
||||
|
||||
```powershell
|
||||
> Expand-Archive .\influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64.zip -DestinationPath 'C:\Program Files\InfluxData\'
|
||||
> mv 'C:\Program Files\InfluxData\influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64' 'C:\Program Files\InfluxData\influx'
|
||||
```
|
||||
```powershell
|
||||
> Expand-Archive .\influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64.zip -DestinationPath 'C:\Program Files\InfluxData\'
|
||||
> mv 'C:\Program Files\InfluxData\influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64' 'C:\Program Files\InfluxData\influx'
|
||||
```
|
||||
|
||||
3. **Grant network access to the `influx` CLI.**
|
||||
|
||||
When using the `influx` CLI for the first time, **Windows Defender** displays
|
||||
the following message:
|
||||
When using the `influx` CLI for the first time, **Windows Defender** displays
|
||||
the following message:
|
||||
|
||||
> Windows Defender Firewall has blocked some features of this app.
|
||||
> Windows Defender Firewall has blocked some features of this app.
|
||||
|
||||
To grant the `influx` CLI the required access, do the following:
|
||||
To grant the `influx` CLI the required access, do the following:
|
||||
|
||||
1. Select **Private networks, such as my home or work network**.
|
||||
2. Click **Allow access**.
|
||||
1. Select **Private networks, such as my home or work network**.
|
||||
2. Click **Allow access**.
|
||||
|
||||
{{% /tab-content %}}
|
||||
<!--------------------------------- END Windows --------------------------------->
|
||||
|
|
@ -229,10 +249,10 @@ Use the [`influx config create` command](/influxdb/v2/reference/cli/influx/confi
|
|||
to create an `influx` CLI config and set it as active:
|
||||
|
||||
```sh
|
||||
influx config create --config-name <config-name> \
|
||||
influx config create --config-name CONFIG_NAME \
|
||||
--host-url http://localhost:8086 \
|
||||
--org <your-org> \
|
||||
--token <your-auth-token> \
|
||||
--org ORG_NAME \
|
||||
--token API_TOKEN \
|
||||
--active
|
||||
```
|
||||
|
||||
|
|
@ -241,13 +261,15 @@ For more information about managing CLI configurations, see the
|
|||
|
||||
### Credential precedence
|
||||
|
||||
There are three ways to provide the necessary credentials to the `influx` CLI,
|
||||
which uses the following precedence when retrieving credentials:
|
||||
Provide credentials using any of the following supported methods.
|
||||
The `influx` CLI uses the following precedence when retrieving credentials:
|
||||
|
||||
1. Command line flags (`--host`, `--org -o`, `--token -t`)
|
||||
2. Environment variables (`INFLUX_HOST`, `INFLUX_ORG`, `INFLUX_TOKEN`)
|
||||
3. CLI configuration file
|
||||
|
||||
Command line flags override environment variables, which override configuration file values.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ updated_in: CLI 2.5.0
|
|||
The `influx auth create` command creates an API token in InfluxDB.
|
||||
|
||||
{{% warn %}}
|
||||
**Issue resolved**: Using influx CLI 2.4 prevented you from creating an **all-access** or **operator** token using the `influx auth create` command. This issue is resolved in the influx 2.5 CLI release. Please [upgrade to the latest version](/influxdb/latest/tools/influx-cli/) of the influx cli.
|
||||
**Issue resolved**: Using influx CLI 2.4 prevented you from creating an **all-access** or **operator** token using the `influx auth create` command. This issue is resolved in the influx 2.5 CLI release. Please [upgrade to the latest version](/influxdb/v2/tools/influx-cli/) of the influx cli.
|
||||
{{% /warn %}}
|
||||
|
||||
## Usage
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,22 @@
|
|||
# Custom Vale configuration for InfluxDB 3.x Core documentation.
|
||||
# Custom styles are defined in .ci/vale/styles/InfluxDB3-Core:
|
||||
# // SOURCE .ci/vale/styles/InfluxDB3-Core/Branding.yml
|
||||
# // SOURCE .ci/vale/styles/InfluxDB3-Core/v3Schema.yml
|
||||
|
||||
StylesPath = "../../../.ci/vale/styles"
|
||||
|
||||
Vocab = InfluxDataDocs
|
||||
|
||||
MinAlertLevel = warning
|
||||
|
||||
Packages = Google, write-good, Hugo
|
||||
|
||||
[*.md]
|
||||
BasedOnStyles = Vale, InfluxDataDocs, InfluxDB3-Core, Google, write-good
|
||||
|
||||
Google.Acronyms = NO
|
||||
Google.DateFormat = NO
|
||||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
Vale.Spelling = NO
|
||||
|
|
@ -42,7 +42,7 @@ Use the InfluxDB 3 quick install script to install {{< product-name >}} on
|
|||
|
||||
1. Use the following command to download and install the appropriate
|
||||
{{< product-name >}} package on your local machine:
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& sh install_influxdb3.sh
|
||||
|
|
@ -72,6 +72,7 @@ source ~/.bashrc
|
|||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
source ~/.zshrc
|
||||
```
|
||||
|
|
@ -134,6 +135,9 @@ Use the `influxdb3-core` Docker image to deploy {{< product-name >}} in a
|
|||
Docker container.
|
||||
The image is available for x86_64 (AMD64) and ARM64 architectures.
|
||||
|
||||
### Use Docker CLI
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
docker pull quay.io/influxdb/influxdb3-core:latest
|
||||
```
|
||||
|
|
@ -159,4 +163,47 @@ quay.io/influxdb/influxdb3-core:latest
|
|||
> The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections.
|
||||
> To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/).
|
||||
|
||||
### Use Docker Compose
|
||||
|
||||
1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example:
|
||||
|
||||
```yaml
|
||||
# compose.yaml
|
||||
services
|
||||
influxdb3-core:
|
||||
container_name: influxdb3-core
|
||||
image: quay.io/influxdb/influxdb3-{{% product-key %}}:latest
|
||||
ports:
|
||||
- 9999:9999
|
||||
command:
|
||||
- serve
|
||||
- --node-id=node0
|
||||
- --log-filter=debug
|
||||
- --object-store=file
|
||||
- --data-dir=/var/lib/influxdb3
|
||||
```
|
||||
|
||||
2. Use the Docker Compose CLI to start the server.
|
||||
|
||||
Optional: to make sure you have the latest version of the image before you
|
||||
start the server, run `docker compose pull`.
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
docker compose pull && docker compose run influxdb3-core
|
||||
```
|
||||
|
||||
> [!Note]
|
||||
> #### Stopping an InfluxDB 3 container
|
||||
>
|
||||
> To stop a running InfluxDB 3 container, find and terminate the process--for example:
|
||||
>
|
||||
> <!--pytest.mark.skip-->
|
||||
> ```bash
|
||||
> ps -ef | grep influxdb3
|
||||
> kill -9 <PROCESS_ID>
|
||||
> ```
|
||||
>
|
||||
> Currently, a bug prevents using `Ctrl-c` in the terminal to stop an InfluxDB 3 container.
|
||||
|
||||
{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: InfluxDB HTTP API
|
||||
description: >
|
||||
The InfluxDB HTTP API for {{% product-name %}} provides a programmatic interface
|
||||
for interactions with InfluxDB,
|
||||
including writing, querying, and processing data, and managing an InfluxDB 3
|
||||
instance.
|
||||
menu:
|
||||
influxdb3_core:
|
||||
parent: Reference
|
||||
name: InfluxDB HTTP API
|
||||
weight: 104
|
||||
influxdb3/core/tags: [api]
|
||||
source: /shared/influxdb3-api-reference/_index.md
|
||||
---
|
||||
|
||||
<!--
|
||||
The content for this page is at
|
||||
// SOURCE /content/shared/influxdb3-api-reference/_index.md
|
||||
->
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: InfluxDB HTTP API
|
||||
description: >
|
||||
The InfluxDB HTTP API for {{% product-name %}} provides a programmatic interface
|
||||
for interactions with InfluxDB,
|
||||
including writing, querying, and processing data, and managing an InfluxDB 3
|
||||
instance.
|
||||
menu:
|
||||
influxdb3_enterprise:
|
||||
parent: Reference
|
||||
name: InfluxDB HTTP API
|
||||
weight: 104
|
||||
influxdb3/enterprise/tags: [api]
|
||||
source: /shared/influxdb3-api-reference/_index.md
|
||||
---
|
||||
|
||||
<!--
|
||||
The content for this page is at
|
||||
// SOURCE /content/shared/influxdb3-api-reference/_index.md
|
||||
->
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: API Invokable Scripts
|
||||
description: >
|
||||
InfluxDB lets you [invoke scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) using the InfluxDB APIs ([InfluxDB Cloud API](/influxdb/cloud/api/) and [InfluxDB OSS (open source) API](/influxdb/latest/api/)). Here, Jay Clifford explains how to use this feature with custom endpoints to improve the functionality, efficiency, and security of your applications.
|
||||
InfluxDB lets you [invoke scripts](/influxdb/cloud/api-guide/api-invokable-scripts/) using the InfluxDB APIs ([InfluxDB Cloud API](/influxdb/cloud/api/) and [InfluxDB OSS (open source) API](/influxdb/v2/api/)). Here, Jay Clifford explains how to use this feature with custom endpoints to improve the functionality, efficiency, and security of your applications.
|
||||
menu:
|
||||
resources:
|
||||
parent: Videos
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Intro to Client Libraries
|
||||
description: >
|
||||
[Client libraries](/influxdb/latest/api-guide/client-libraries/) are a powerful way to harness the power of InfluxDB's API using familiar programming languages. Here, Jay Clifford explains what client libraries are, how they work, and why you should use them when working with InfluxDB.
|
||||
[Client libraries](/influxdb/v2/api-guide/client-libraries/) are a powerful way to harness the power of InfluxDB's API using familiar programming languages. Here, Jay Clifford explains what client libraries are, how they work, and why you should use them when working with InfluxDB.
|
||||
menu:
|
||||
resources:
|
||||
parent: Videos
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Optimizing Flux Functions
|
||||
description: >
|
||||
Flux queries are scripts that let you work with your data in InfluxDB. Here, Scott Anderson provides some tips for [optimizing Flux queries](/influxdb/latest/query-data/optimize-queries/), so that your data and applications are more performant.
|
||||
Flux queries are scripts that let you work with your data in InfluxDB. Here, Scott Anderson provides some tips for [optimizing Flux queries](/influxdb/v2/query-data/optimize-queries/), so that your data and applications are more performant.
|
||||
menu:
|
||||
resources:
|
||||
parent: Videos
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
The InfluxDB HTTP API provides a programmatic interface for interactions with
|
||||
{{% product-name %}}, such as writing and querying data, triggering Processing
|
||||
engine plugins, and managing an InfluxDB 3 instance.
|
||||
The API includes endpoints for backward compatibility with
|
||||
InfluxDB v1 and v2 workloads, clients, and third-party tools.
|
||||
|
||||
<a class="btn" href="/influxdb3/{{% product-key %}}/api/v3/">{{% product-name %}} HTTP API</a>
|
||||
|
|
@ -68,6 +68,8 @@ This guide covers InfluxDB 3 Core (the open source release), including the follo
|
|||
<!--------------- BEGIN LINUX AND MACOS -------------->
|
||||
To get started quickly, download and run the install script--for example, using [curl](https://curl.se/download.html):
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
|
||||
```bash
|
||||
curl -O https://www.influxdata.com/d/install_influxdb3.sh \
|
||||
&& sh install_influxdb3.sh
|
||||
|
|
@ -106,6 +108,8 @@ is available for x86_64 (AMD64) and ARM64 architectures.
|
|||
|
||||
Pull the image:
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
|
||||
```bash
|
||||
docker pull quay.io/influxdb/influxdb3-core:latest
|
||||
```
|
||||
|
|
@ -126,6 +130,8 @@ influxdb3 --version
|
|||
|
||||
If your system doesn't locate `influxdb3`, then `source` the configuration file (for example, .bashrc, .zshrc) for your shell--for example:
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
|
||||
```zsh
|
||||
source ~/.zshrc
|
||||
```
|
||||
|
|
@ -145,13 +151,13 @@ and provide the following:
|
|||
The following examples show how to start InfluxDB 3 with different object store configurations:
|
||||
|
||||
```bash
|
||||
# MEMORY
|
||||
# Memory object store
|
||||
# Stores data in RAM; doesn't persist data
|
||||
influxdb3 serve --node-id=local01 --object-store=memory
|
||||
```
|
||||
|
||||
```bash
|
||||
# FILESYSTEM
|
||||
# Filesystem object store
|
||||
# Provide the filesystem directory
|
||||
influxdb3 serve \
|
||||
--node-id=local01 \
|
||||
|
|
@ -169,10 +175,12 @@ To run the [Docker image](/influxdb3/core/install/#docker-image) and persist dat
|
|||
> The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections.
|
||||
> To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/).
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
```bash
|
||||
# FILESYSTEM USING DOCKER
|
||||
# Filesystem object store with Docker
|
||||
# Create a mount
|
||||
# Provide the mount path
|
||||
|
||||
docker run -it \
|
||||
-v /path/on/host:/path/in/container \
|
||||
quay.io/influxdb/influxdb3-core:latest serve \
|
||||
|
|
@ -182,15 +190,29 @@ docker run -it \
|
|||
```
|
||||
|
||||
```bash
|
||||
# S3 (defaults to us-east-1 for region)
|
||||
# S3 object store (default is the us-east-1 region)
|
||||
# Specify the Object store type and associated options
|
||||
influxdb3 serve --node-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY]
|
||||
|
||||
```bash
|
||||
influxdb3 serve \
|
||||
--node-id=local01 \
|
||||
--object-store=s3 \
|
||||
--bucket=BUCKET \
|
||||
--aws-access-key=AWS_ACCESS_KEY \
|
||||
--aws-secret-access-key=AWS_SECRET_ACCESS_KEY
|
||||
```
|
||||
|
||||
```bash
|
||||
# Minio/Open Source Object Store (Uses the AWS S3 API, with additional parameters)
|
||||
# Specify the Object store type and associated options
|
||||
influxdb3 serve --node-id=local01 --object-store=s3 --bucket=[BUCKET] --aws-access-key=[AWS ACCESS KEY] --aws-secret-access-key=[AWS SECRET ACCESS KEY] --aws-endpoint=[ENDPOINT] --aws-allow-http
|
||||
# Minio or other open source object store
|
||||
# (using the AWS S3 API with additional parameters)
|
||||
# Specify the object store type and associated options
|
||||
|
||||
```bash
|
||||
influxdb3 serve --node-id=local01 --object-store=s3 --bucket=BUCKET \
|
||||
--aws-access-key=AWS_ACCESS_KEY \
|
||||
--aws-secret-access-key=AWS_SECRET_ACCESS_KEY \
|
||||
--aws-endpoint=ENDPOINT \
|
||||
--aws-allow-http
|
||||
```
|
||||
|
||||
_For more information about server options, run `influxdb3 serve --help`._
|
||||
|
|
@ -202,15 +224,17 @@ _For more information about server options, run `influxdb3 serve --help`._
|
|||
> Use the `docker kill` command to stop the container:
|
||||
>
|
||||
> 1. Enter the following command to find the container ID:
|
||||
> <!--pytest.mark.skip-->
|
||||
> ```bash
|
||||
> docker ps -a
|
||||
> ```
|
||||
> 2. Enter the command to stop the container:
|
||||
> <!--pytest.mark.skip-->
|
||||
> ```bash
|
||||
> docker kill <CONTAINER_ID>
|
||||
> ```
|
||||
|
||||
### Data Model
|
||||
### Data model
|
||||
|
||||
The database server contains logical databases, which have tables, which have columns. Compared to previous versions of InfluxDB you can think of a database as a `bucket` in v2 or as a `db/retention_policy` in v1. A `table` is equivalent to a `measurement`, which has columns that can be of type `tag` (a string dictionary), `int64`, `float64`, `uint64`, `bool`, or `string` and finally every table has a `time` column that is a nanosecond precision timestamp.
|
||||
|
||||
|
|
@ -219,7 +243,7 @@ This is the sort order used for all Parquet files that get created. When you cre
|
|||
|
||||
Tags should hold unique identifying information like `sensor_id`, or `building_id` or `trace_id`. All other data should be kept in fields. You will be able to add fast last N value and distinct value lookups later for any column, whether it is a field or a tag.
|
||||
|
||||
### Write Data
|
||||
### Write data
|
||||
|
||||
InfluxDB is a schema-on-write database. You can start writing data and InfluxDB creates the logical database, tables, and their schemas on the fly.
|
||||
After a schema is created, InfluxDB validates future write requests against it before accepting the data.
|
||||
|
|
@ -227,23 +251,43 @@ Subsequent requests can add new fields on-the-fly, but can't add new tags.
|
|||
|
||||
{{% product-name %}} is optimized for recent data, but accepts writes from any time period. It persists that data in Parquet files for access by third-party systems for longer term historical analysis and queries. If you require longer historical queries with a compactor that optimizes data organization, consider using [InfluxDB 3 Enterprise](/influxdb3/enterprise/get-started/).
|
||||
|
||||
The database provides three write API endpoints that respond to HTTP `POST` requests:
|
||||
|
||||
The database has three write API endpoints that respond to HTTP `POST` requests:
|
||||
#### /api/v3/write_lp endpoint
|
||||
|
||||
* `/write?db=mydb&precision=ns`
|
||||
* `/api/v2/write?bucket=mydb&precision=ns`
|
||||
* `/api/v3/write_lp?db=mydb&precision=nanosecond&accept_partial=true`
|
||||
{{% product-name %}} adds the `/api/v3/write_lp` endpoint.
|
||||
|
||||
{{% product-name %}} provides the `/write` and `/api/v2/write` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB.
|
||||
However, these APIs differ from the APIs in the previous versions in the following ways:
|
||||
{{<api-endpoint endpoint="/api/v3/write_lp?db=mydb&precision=nanosecond&accept_partial=true" method="post" >}}
|
||||
|
||||
This endpoint accepts the same line protocol syntax as previous versions,
|
||||
and supports the `?accept_partial=<BOOLEAN>` parameter, which
|
||||
lets you accept or reject partial writes (default is `true`).
|
||||
|
||||
#### /api/v2/write InfluxDB v2 compatibility endpoint
|
||||
|
||||
Provides backwards compatibility with clients that can write data to InfluxDB OSS v2.x and Cloud 2 (TSM).
|
||||
{{<api-endpoint endpoint="/api/v2/write?bucket=mydb&precision=ns" method="post" >}}
|
||||
|
||||
#### /write InfluxDB v1 compatibility endpoint
|
||||
|
||||
Provides backwards compatibility for clients that can write data to InfluxDB v1.x
|
||||
{{<api-endpoint endpoint="/write?db=mydb&precision=ns" method="post" >}}
|
||||
|
||||
Keep in mind that these compatibility APIs differ from the v1 and v2 APIs in previous versions in the following ways:
|
||||
|
||||
- Tags in a table (measurement) are _immutable_
|
||||
- A tag and a field can't have the same name within a table.
|
||||
|
||||
{{% product-name %}} adds the `/api/v3/write_lp` endpoint, which accepts the same line protocol syntax as previous versions, and supports an `?accept_partial=<BOOLEAN>` parameter, which
|
||||
lets you accept or reject partial writes (default is `true`).
|
||||
#### Write line protocol
|
||||
|
||||
The following code block is an example of [line protocol](/influxdb3/core/reference/syntax/line-protocol/), which shows the table name followed by tags, which are an ordered, comma-separated list of key/value pairs where the values are strings, followed by a comma-separated list of key/value pairs that are the fields, and ending with an optional timestamp. The timestamp by default is a nanosecond epoch, but you can specify a different precision through the `precision` query parameter.
|
||||
The following code block is an example of time series data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) syntax:
|
||||
|
||||
- `cpu`: the table name.
|
||||
- `host`, `region`, `applications`: the tags. A tag set is an ordered, comma-separated list of key/value pairs where the values are strings.
|
||||
- `val`, `usage_percent`, `status`: the fields. A field set is a comma-separated list of key/value pairs.
|
||||
- timestamp: If you don't specify a timestamp, InfluxData uses the time when data is written.
|
||||
The default precision is a nanosecond epoch.
|
||||
To specify a different precision, pass the `precision` query parameter.
|
||||
|
||||
```
|
||||
cpu,host=Alpha,region=us-west,application=webserver val=1i,usage_percent=20.5,status="OK"
|
||||
|
|
@ -254,16 +298,20 @@ cpu,host=Bravo,region=us-central,application=database val=5i,usage_percent=80.5,
|
|||
cpu,host=Alpha,region=us-west,application=webserver val=6i,usage_percent=25.3,status="Warn"
|
||||
```
|
||||
|
||||
##### Example: write data using the influxdb3 CLI
|
||||
|
||||
If you save the preceding line protocol to a file (for example, `server_data`), then you can use the `influxdb3` CLI to write the data--for example:
|
||||
|
||||
```bash
|
||||
influxdb3 write --database=mydb --file=server_data
|
||||
```
|
||||
|
||||
##### Example: write data using the /api/v3 HTTP API
|
||||
|
||||
The following examples show how to write data using `curl` and the `/api/3/write_lp` HTTP endpoint.
|
||||
To show the difference between accepting and rejecting partial writes, line `2` in the example contains a `string` value for a `float` field (`temp=hi`).
|
||||
|
||||
##### Partial write of line protocol occurred
|
||||
###### Partial write of line protocol occurred
|
||||
|
||||
With `accept_partial=true`:
|
||||
|
||||
|
|
@ -289,7 +337,7 @@ With `accept_partial=true`:
|
|||
Line `1` is written and queryable.
|
||||
The response is an HTTP error (`400`) status, and the response body contains the error message `partial write of line protocol occurred` with details about the problem line.
|
||||
|
||||
##### Parsing failed for write_lp endpoint
|
||||
###### Parsing failed for write_lp endpoint
|
||||
|
||||
With `accept_partial=false`:
|
||||
|
||||
|
|
@ -320,7 +368,7 @@ The response is the following:
|
|||
InfluxDB rejects all points in the batch.
|
||||
The response is an HTTP error (`400`) status, and the response body contains `parsing failed for write_lp endpoint` and details about the problem line.
|
||||
|
||||
##### Data durability
|
||||
#### Data durability
|
||||
|
||||
When you write data to InfluxDB, InfluxDB ingests the data and writes it to WAL files, created once per second, and to an in-memory queryable buffer.
|
||||
Later, InfluxDB snapshots the WAL and persists the data into object storage as Parquet files.
|
||||
|
|
@ -360,7 +408,7 @@ The `no_sync` CLI option controls when writes are acknowledged--for example:
|
|||
influxdb3 write --bucket=mydb --org=my_org --token=my-token --no-sync
|
||||
```
|
||||
|
||||
#### Create a database or table
|
||||
### Create a database or table
|
||||
|
||||
To create a database without writing data, use the `create` subcommand--for example:
|
||||
|
||||
|
|
@ -374,7 +422,7 @@ To learn more about a subcommand, use the `-h, --help` flag:
|
|||
influxdb3 create -h
|
||||
```
|
||||
|
||||
### Query the database
|
||||
### Query a database
|
||||
|
||||
InfluxDB 3 now supports native SQL for querying, in addition to InfluxQL, an
|
||||
SQL-like language customized for time series queries.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,111 @@
|
|||
/// <reference types="cypress" />
|
||||
const fakeGoogleTagManager = {
|
||||
trackingOptIn: () => {},
|
||||
trackingOptOut: () => {}
|
||||
}
|
||||
|
||||
describe('API reference content', () => {
|
||||
const subjects = [
|
||||
'/influxdb/cloud/api/',
|
||||
'/influxdb/cloud/api/v1/',
|
||||
'/influxdb/cloud/api/v1-compatibility/',
|
||||
'/influxdb/cloud/api/v2/',
|
||||
|
||||
'/influxdb/v2/api/',
|
||||
'/influxdb/v2/api/v1/',
|
||||
'/influxdb/v2/api/v1-compatibility/',
|
||||
'/influxdb/v2/api/v2/',
|
||||
|
||||
'/influxdb3/cloud-dedicated/api/',
|
||||
'/influxdb3/cloud-dedicated/api/management/',
|
||||
'/influxdb3/cloud-dedicated/api/v1/',
|
||||
'/influxdb3/cloud-dedicated/api/v1-compatibility/',
|
||||
'/influxdb3/cloud-dedicated/api/v2/',
|
||||
|
||||
'/influxdb3/cloud-serverless/api/',
|
||||
'/influxdb3/cloud-serverless/api/v1/',
|
||||
'/influxdb3/cloud-serverless/api/v1-compatibility/',
|
||||
'/influxdb3/cloud-serverless/api/v2/',
|
||||
|
||||
'/influxdb3/clustered/api/',
|
||||
// TODO '/influxdb3/clustered/api/management/',
|
||||
'/influxdb3/clustered/api/v1/',
|
||||
'/influxdb3/clustered/api/v1-compatibility/',
|
||||
'/influxdb3/clustered/api/v2/',
|
||||
|
||||
'/influxdb3/core/api/',
|
||||
'/influxdb3/enterprise/api/',
|
||||
];
|
||||
|
||||
|
||||
subjects.forEach((subject) => {
|
||||
describe(subject, () => {
|
||||
beforeEach(() => {
|
||||
// Intercept and modify the page HTML before it loads
|
||||
cy.intercept('GET', '**', (req) => {
|
||||
req.continue((res) => {
|
||||
if (res.headers['content-type']?.includes('text/html')) {
|
||||
// Modify the Kapa widget script attributes
|
||||
// Avoid socket errors from fpjs in tests by disabling fingerprinting
|
||||
res.body = res.body.replace(
|
||||
/data-user-analytics-fingerprint-enabled="true"/,
|
||||
'data-user-analytics-fingerprint-enabled="false"'
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
cy.visit(subject);
|
||||
|
||||
|
||||
window.fcdsc = fakeGoogleTagManager;
|
||||
cy.stub(window.fcdsc, 'trackingOptIn').as('trackingOptIn');
|
||||
cy.stub(window.fcdsc, 'trackingOptOut').as('trackingOptOut');
|
||||
});
|
||||
it(`has API info`, function () {
|
||||
cy.get('script[data-user-analytics-fingerprint-enabled=false]').should('have.length', 1);
|
||||
cy.get('h1').first().should('have.length', 1);
|
||||
cy.get('[data-role$=description]').should('have.length', 1);
|
||||
});
|
||||
it('links back to the version home page', function () {
|
||||
cy.get('a.back').contains('Docs')
|
||||
.should('have.length', 1)
|
||||
.click();
|
||||
// Path should be the first two segments and trailing slash in $subject
|
||||
cy.location('pathname')
|
||||
.should('eq', subject.replace(/^(\/[^/]+\/[^/]+\/).*/, '$1'));
|
||||
cy.get('h1').should('have.length', 1);
|
||||
});
|
||||
it('contains valid internal links', function () {
|
||||
// The following conditional test isn't the cypress way, but the doc might not have internal links.
|
||||
cy.get('body').then(($body) => {
|
||||
if ($body.find('p a[href^="/"]').length === 0) {
|
||||
cy.log('No internal links found');
|
||||
return;
|
||||
}
|
||||
cy.get('p a[href^="/"]').as('internal-links');
|
||||
cy.get('@internal-links').each(($a) => {
|
||||
cy.log(`** Testing link ${$a.attr('href')} **`);
|
||||
// cy.request doesn't show in your browser's Developer Tools
|
||||
// because the request comes from Node, not from the browser.
|
||||
cy.request($a.attr('href')).its('status').should('eq', 200);
|
||||
});
|
||||
|
||||
});
|
||||
});
|
||||
it('contains valid external links', function () {
|
||||
// The following conditional test isn't the cypress way, but the doc might not have external links.
|
||||
cy.get('body').then(($body) => {
|
||||
if ($body.find('p a[href^="http"]').length === 0) {
|
||||
cy.log('No external links found');
|
||||
return;
|
||||
}
|
||||
cy.get('p a[href^="http"]').as('external-links');
|
||||
cy.get('@external-links').each(($a) => {
|
||||
cy.log(`** Testing link ${$a.attr('href')} **`);
|
||||
cy.request($a.attr('href')).its('status').should('eq', 200);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -27,6 +27,8 @@
|
|||
"jquery": "^3.7.1",
|
||||
"js-cookie": "^3.0.5",
|
||||
"js-yaml": "^4.1.0",
|
||||
"lefthook": "^1.10.10",
|
||||
"markdown-link": "^0.1.1",
|
||||
"mermaid": "^11.4.1",
|
||||
"vanillajs-datepicker": "^1.3.4"
|
||||
},
|
||||
|
|
@ -35,6 +37,7 @@
|
|||
"e2e:o": "npx cypress open",
|
||||
"e2e:o:links": "export cypress_test_subjects=\"http://localhost:1313/influxdb3/core/,http://localhost:1313/influxdb3/enterprise/\"; npx cypress open cypress/e2e/article-links.cy.js",
|
||||
"e2e:links": "export cypress_test_subjects=\"http://localhost:1313/influxdb3/core/,http://localhost:1313/influxdb3/enterprise/\"; npx cypress run --spec cypress/e2e/article-links.cy.js",
|
||||
"e2e:api-docs": "export cypress_test_subjects=\"http://localhost:1313/influxdb3/core/api/,http://localhost:1313/influxdb3/enterprise/api/,http://localhost:1313/influxdb3/cloud-dedicated/api/,http://localhost:1313/influxdb3/cloud-dedicated/api/v1/,http://localhost:1313/influxdb/cloud-dedicated/api/v1/,http://localhost:1313/influxdb/cloud-dedicated/api/management/,http://localhost:1313/influxdb3/cloud-dedicated/api/management/\"; npx cypress run --spec cypress/e2e/article-links.cy.js",
|
||||
"lint": "LEFTHOOK_EXCLUDE=test lefthook run pre-commit && lefthook run pre-push",
|
||||
"pre-commit": "lefthook run pre-commit",
|
||||
"test-content": "docker compose --profile test up"
|
||||
|
|
|
|||
|
|
@ -98,6 +98,8 @@ function substitute_placeholders {
|
|||
s|NUMBER_OF_DAYS|365|g;
|
||||
s|@path/to/line-protocol.txt|data/home-sensor-data.lp|g;
|
||||
s|/path/to/custom/assets-dir|/app/custom-assets|g;
|
||||
s|/path/to/TEMPLATE_FILE.yml|/root/influxdb-templates/TEMPLATE_FILE.yml|g;
|
||||
s|/path/to/TEMPLATE_FILE.json|/root/influxdb-templates/TEMPLATE_FILE.json|g;
|
||||
' $file
|
||||
|
||||
# v2-specific replacements.
|
||||
|
|
|
|||
|
|
@ -51,6 +51,7 @@ setup
|
|||
|
||||
if [[ $runner == "pytest" ]]; then
|
||||
pytest \
|
||||
-ra \
|
||||
-s \
|
||||
--codeblocks \
|
||||
--suppress-no-test-exit-code \
|
||||
|
|
|
|||
156
yarn.lock
156
yarn.lock
|
|
@ -2,18 +2,18 @@
|
|||
# yarn lockfile v1
|
||||
|
||||
|
||||
"@antfu/install-pkg@^1.0.0":
|
||||
version "1.0.0"
|
||||
resolved "https://registry.yarnpkg.com/@antfu/install-pkg/-/install-pkg-1.0.0.tgz#2912a150fc8b35ec912f583f90074ee98f64d66a"
|
||||
integrity sha512-xvX6P/lo1B3ej0OsaErAjqgFYzYVcJpamjLAFLYh9vRJngBrMoUG7aVnrGTeqM7yxbyTD5p3F2+0/QUEh8Vzhw==
|
||||
"@antfu/install-pkg@^0.4.1":
|
||||
version "0.4.1"
|
||||
resolved "https://registry.yarnpkg.com/@antfu/install-pkg/-/install-pkg-0.4.1.tgz#d1d7f3be96ecdb41581629cafe8626d1748c0cf1"
|
||||
integrity sha512-T7yB5QNG29afhWVkVq7XeIMBa5U/vs9mX69YqayXypPRmYzUmzwnYltplHmPtZ4HPCn+sQKeXW8I47wCbuBOjw==
|
||||
dependencies:
|
||||
package-manager-detector "^0.2.8"
|
||||
tinyexec "^0.3.2"
|
||||
package-manager-detector "^0.2.0"
|
||||
tinyexec "^0.3.0"
|
||||
|
||||
"@antfu/utils@^8.1.0":
|
||||
version "8.1.1"
|
||||
resolved "https://registry.yarnpkg.com/@antfu/utils/-/utils-8.1.1.tgz#95b1947d292a9a2efffba2081796dcaa05ecedfb"
|
||||
integrity sha512-Mex9nXf9vR6AhcXmMrlz/HVgYYZpVGJ6YlPgwl7UnaFpnshXs6EK/oa5Gpf3CzENMjkvEx2tQtntGnb7UtSTOQ==
|
||||
"@antfu/utils@^0.7.10":
|
||||
version "0.7.10"
|
||||
resolved "https://registry.yarnpkg.com/@antfu/utils/-/utils-0.7.10.tgz#ae829f170158e297a9b6a28f161a8e487d00814d"
|
||||
integrity sha512-+562v9k4aI80m1+VuMHehNJWLOFjBnXn3tdOitzD0il5b7smkSBal4+a3oKiQTbrwMmN/TBUMDvbdoWDehgOww==
|
||||
|
||||
"@babel/code-frame@^7.0.0":
|
||||
version "7.26.2"
|
||||
|
|
@ -217,18 +217,18 @@
|
|||
integrity sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==
|
||||
|
||||
"@iconify/utils@^2.1.32":
|
||||
version "2.3.0"
|
||||
resolved "https://registry.yarnpkg.com/@iconify/utils/-/utils-2.3.0.tgz#1bbbf8c477ebe9a7cacaea78b1b7e8937f9cbfba"
|
||||
integrity sha512-GmQ78prtwYW6EtzXRU1rY+KwOKfz32PD7iJh6Iyqw68GiKuoZ2A6pRtzWONz5VQJbp50mEjXh/7NkumtrAgRKA==
|
||||
version "2.2.1"
|
||||
resolved "https://registry.yarnpkg.com/@iconify/utils/-/utils-2.2.1.tgz#635b9bd8fd3e5e53742471bc0b5291f1570dda41"
|
||||
integrity sha512-0/7J7hk4PqXmxo5PDBDxmnecw5PxklZJfNjIVG9FM0mEfVrvfudS22rYWsqVk6gR3UJ/mSYS90X4R3znXnqfNA==
|
||||
dependencies:
|
||||
"@antfu/install-pkg" "^1.0.0"
|
||||
"@antfu/utils" "^8.1.0"
|
||||
"@antfu/install-pkg" "^0.4.1"
|
||||
"@antfu/utils" "^0.7.10"
|
||||
"@iconify/types" "^2.0.0"
|
||||
debug "^4.4.0"
|
||||
globals "^15.14.0"
|
||||
globals "^15.13.0"
|
||||
kolorist "^1.8.0"
|
||||
local-pkg "^1.0.0"
|
||||
mlly "^1.7.4"
|
||||
local-pkg "^0.5.1"
|
||||
mlly "^1.7.3"
|
||||
|
||||
"@isaacs/cliui@^8.0.2":
|
||||
version "8.0.2"
|
||||
|
|
@ -2214,7 +2214,7 @@ globals@^14.0.0:
|
|||
resolved "https://registry.yarnpkg.com/globals/-/globals-14.0.0.tgz#898d7413c29babcf6bafe56fcadded858ada724e"
|
||||
integrity sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ==
|
||||
|
||||
globals@^15.14.0:
|
||||
globals@^15.13.0, globals@^15.14.0:
|
||||
version "15.15.0"
|
||||
resolved "https://registry.yarnpkg.com/globals/-/globals-15.15.0.tgz#7c4761299d41c32b075715a4ce1ede7897ff72a8"
|
||||
integrity sha512-7ACyT3wmyp3I61S4fG682L0VA2RGD9otkqGJIwNUMF1SWUombIIk+af1unuDYgMm082aHYwD+mzJvv9Iu8dsgg==
|
||||
|
|
@ -2233,7 +2233,7 @@ globby@^14.0.0:
|
|||
|
||||
gopd@^1.2.0:
|
||||
version "1.2.0"
|
||||
resolved "https://registry.yarnpkg.com/gopd/-/gopd-1.2.0.tgz#89f56b8217bdbc8802bd299df6d7f1081d7e51a1"
|
||||
resolved "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz"
|
||||
integrity sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==
|
||||
|
||||
got@^12.6.0:
|
||||
|
|
@ -2657,6 +2657,72 @@ lazy-ass@^1.6.0:
|
|||
resolved "https://registry.yarnpkg.com/lazy-ass/-/lazy-ass-1.6.0.tgz#7999655e8646c17f089fdd187d150d3324d54513"
|
||||
integrity sha512-cc8oEVoctTvsFZ/Oje/kGnHbpWHYBe8IAJe4C0QNc3t8uM/0Y8+erSz/7Y1ALuXTEZTMvxXwO6YbX1ey3ujiZw==
|
||||
|
||||
lefthook-darwin-arm64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-darwin-arm64/-/lefthook-darwin-arm64-1.10.10.tgz#48a3eb7935cb171a36a037e61a68c0dc800efc5f"
|
||||
integrity sha512-hEypKdwWpmNSl4Q8eJxgmlGb2ybJj1+W5/v13Mxc+ApEmjbpNiJzPcdjC9zyaMEpPK4EybiHy8g5ZC0dLOwkpA==
|
||||
|
||||
lefthook-darwin-x64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-darwin-x64/-/lefthook-darwin-x64-1.10.10.tgz#729f5ddd296f876da703496e5071a735e6cf3625"
|
||||
integrity sha512-9xNbeE78i4Amz+uOheg9dcy7X/6X12h98SUMrYWk7fONvjW/Bp9h6nPGIGxI5krHp9iRB8rhmo33ljVDVtTlyg==
|
||||
|
||||
lefthook-freebsd-arm64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-freebsd-arm64/-/lefthook-freebsd-arm64-1.10.10.tgz#24abbba49d5d6007381883bb122089f4d33f0e48"
|
||||
integrity sha512-GT9wYxPxkvO1rtIAmctayT9xQIVII5xUIG3Pv6gZo+r6yEyle0EFTLFDbmVje7p7rQNCsvJ8XzCNdnyDrva90g==
|
||||
|
||||
lefthook-freebsd-x64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-freebsd-x64/-/lefthook-freebsd-x64-1.10.10.tgz#e509ab6efe42741a0b8f57e87155f855c701366e"
|
||||
integrity sha512-2BB/HRhEb9wGpk5K38iNkHtMPnn+TjXDtFG6C/AmUPLXLNhGnNiYp+v2uhUE8quWzxJx7QzfnU7Ga+/gzJcIcw==
|
||||
|
||||
lefthook-linux-arm64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-linux-arm64/-/lefthook-linux-arm64-1.10.10.tgz#1c5c9339f86fa427d311026af92e9f84a89191a1"
|
||||
integrity sha512-GJ7GALKJ1NcMnNZG9uY+zJR3yS8q7/MgcHFWSJhBl+w4KTiiD/RAdSl5ALwEK2+UX36Eo+7iQA7AXzaRdAii4w==
|
||||
|
||||
lefthook-linux-x64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-linux-x64/-/lefthook-linux-x64-1.10.10.tgz#629f7f91618073ca8d712ff95e4f0e54d839af3c"
|
||||
integrity sha512-dWUvPM9YTIJ3+X9dB+8iOnzoVHbnNmpscmUqEOKSeizgBrvuuIYKZJGDyjEtw65Qnmn1SJ7ouSaKK93p5c7SkQ==
|
||||
|
||||
lefthook-openbsd-arm64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-openbsd-arm64/-/lefthook-openbsd-arm64-1.10.10.tgz#29859c0357f00ba828f73ada56fe709bd108bb15"
|
||||
integrity sha512-KnwDyxOvbvGSBTbEF/OxkynZRPLowd3mIXUKHtkg3ABcQ4UREalX+Sh0nWU2dNjQbINx7Eh6B42TxNC7h+qXEg==
|
||||
|
||||
lefthook-openbsd-x64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-openbsd-x64/-/lefthook-openbsd-x64-1.10.10.tgz#2ff9cd0ed72f9d5deabdcc84fba4d8e1b6e14c50"
|
||||
integrity sha512-49nnG886CI3WkrzVJ71D1M2KWpUYN1BP9LMKNzN11cmZ0j6dUK4hj3nbW+NcrKXxgYzzyLU3FFwrc51OVy2eKA==
|
||||
|
||||
lefthook-windows-arm64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-windows-arm64/-/lefthook-windows-arm64-1.10.10.tgz#6ba521f289909cd1467b4f408f8ef8a1e87d278f"
|
||||
integrity sha512-9ni0Tsnk+O5oL7EBfKj9C5ZctD1mrTyHCtiu1zQJBbREReJtPjIM9DwWzecfbuVfrIlpbviVQvx5mjZ44bqlWw==
|
||||
|
||||
lefthook-windows-x64@1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook-windows-x64/-/lefthook-windows-x64-1.10.10.tgz#aac9caca3152df8f288713929c2ec31ee0a10b54"
|
||||
integrity sha512-gkKWYrlay4iecFfY1Ris5VcRYa0BaNJKMk0qE/wZmIpMgu4GvNg+f9BEwTMflkQIanABduT9lrECaL1lX5ClKw==
|
||||
|
||||
lefthook@^1.10.10:
|
||||
version "1.10.10"
|
||||
resolved "https://registry.yarnpkg.com/lefthook/-/lefthook-1.10.10.tgz#29d0b221429f55d699785ddeeb6fa3c8f9951e6f"
|
||||
integrity sha512-YW0fTONgOXsephvXq2gIFbegCW19MHCyKYX7JDWmzVF1ZiVMnDBYUL/SP3i0RtFvlCmqENl4SgKwYYQGUMnvig==
|
||||
optionalDependencies:
|
||||
lefthook-darwin-arm64 "1.10.10"
|
||||
lefthook-darwin-x64 "1.10.10"
|
||||
lefthook-freebsd-arm64 "1.10.10"
|
||||
lefthook-freebsd-x64 "1.10.10"
|
||||
lefthook-linux-arm64 "1.10.10"
|
||||
lefthook-linux-x64 "1.10.10"
|
||||
lefthook-openbsd-arm64 "1.10.10"
|
||||
lefthook-openbsd-x64 "1.10.10"
|
||||
lefthook-windows-arm64 "1.10.10"
|
||||
lefthook-windows-x64 "1.10.10"
|
||||
|
||||
levn@^0.4.1:
|
||||
version "0.4.1"
|
||||
resolved "https://registry.yarnpkg.com/levn/-/levn-0.4.1.tgz#ae4562c007473b932a6200d403268dd2fffc6ade"
|
||||
|
|
@ -2694,13 +2760,13 @@ listr2@^3.8.3:
|
|||
through "^2.3.8"
|
||||
wrap-ansi "^7.0.0"
|
||||
|
||||
local-pkg@^1.0.0:
|
||||
version "1.0.0"
|
||||
resolved "https://registry.yarnpkg.com/local-pkg/-/local-pkg-1.0.0.tgz#a8d14dd41e78884f199ecd8b3eedaf0d376e2167"
|
||||
integrity sha512-bbgPw/wmroJsil/GgL4qjDzs5YLTBMQ99weRsok1XCDccQeehbHA/I1oRvk2NPtr7KGZgT/Y5tPRnAtMqeG2Kg==
|
||||
local-pkg@^0.5.1:
|
||||
version "0.5.1"
|
||||
resolved "https://registry.yarnpkg.com/local-pkg/-/local-pkg-0.5.1.tgz#69658638d2a95287534d4c2fff757980100dbb6d"
|
||||
integrity sha512-9rrA30MRRP3gBD3HTGnC6cDFpaE1kVDWxWgqWJUN0RvDNAo+Nz/9GxB+nHOH0ifbVFy0hSA1V6vFDvnx54lTEQ==
|
||||
dependencies:
|
||||
mlly "^1.7.3"
|
||||
pkg-types "^1.3.0"
|
||||
pkg-types "^1.2.1"
|
||||
|
||||
locate-path@^6.0.0:
|
||||
version "6.0.0"
|
||||
|
|
@ -2798,6 +2864,11 @@ make-dir@^1.0.0:
|
|||
dependencies:
|
||||
pify "^3.0.0"
|
||||
|
||||
markdown-link@^0.1.1:
|
||||
version "0.1.1"
|
||||
resolved "https://registry.yarnpkg.com/markdown-link/-/markdown-link-0.1.1.tgz#32c5c65199a6457316322d1e4229d13407c8c7cf"
|
||||
integrity sha512-TurLymbyLyo+kAUUAV9ggR9EPcDjP/ctlv9QAFiqUH7c+t6FlsbivPo9OKTU8xdOx9oNd2drW/Fi5RRElQbUqA==
|
||||
|
||||
marked@^13.0.2:
|
||||
version "13.0.3"
|
||||
resolved "https://registry.yarnpkg.com/marked/-/marked-13.0.3.tgz#5c5b4a5d0198060c7c9bc6ef9420a7fed30f822d"
|
||||
|
|
@ -3112,7 +3183,7 @@ package-json-from-dist@^1.0.0:
|
|||
resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz#4f1471a010827a86f94cfd9b0727e36d267de505"
|
||||
integrity sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==
|
||||
|
||||
package-manager-detector@^0.2.8:
|
||||
package-manager-detector@^0.2.0:
|
||||
version "0.2.9"
|
||||
resolved "https://registry.yarnpkg.com/package-manager-detector/-/package-manager-detector-0.2.9.tgz#20990785afa69d38b4520ccc83b34e9f69cb970f"
|
||||
integrity sha512-+vYvA/Y31l8Zk8dwxHhL3JfTuHPm6tlxM2A3GeQyl7ovYnSp1+mzAxClxaOr0qO1TtPxbQxetI7v5XqKLJZk7Q==
|
||||
|
|
@ -3173,9 +3244,9 @@ path-type@^6.0.0:
|
|||
integrity sha512-Vj7sf++t5pBD637NSfkxpHSMfWaeig5+DKWLhcqIYx6mWQz5hdJTGDVMQiJcw1ZYkhs7AazKDGpRVji1LJCZUQ==
|
||||
|
||||
pathe@^2.0.1:
|
||||
version "2.0.3"
|
||||
resolved "https://registry.yarnpkg.com/pathe/-/pathe-2.0.3.tgz#3ecbec55421685b70a9da872b2cff3e1cbed1716"
|
||||
integrity sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==
|
||||
version "2.0.2"
|
||||
resolved "https://registry.yarnpkg.com/pathe/-/pathe-2.0.2.tgz#5ed86644376915b3c7ee4d00ac8c348d671da3a5"
|
||||
integrity sha512-15Ztpk+nov8DR524R4BF7uEuzESgzUEAV4Ah7CUMNGXdE5ELuvxElxGXndBl32vMSsWa1jpNf22Z+Er3sKwq+w==
|
||||
|
||||
pend@~1.2.0:
|
||||
version "1.2.0"
|
||||
|
|
@ -3219,7 +3290,7 @@ pinkie@^2.0.0:
|
|||
resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-2.0.4.tgz#72556b80cfa0d48a974e80e77248e80ed4f7f870"
|
||||
integrity sha512-MnUuEycAemtSaeFSjXKW/aroV7akBbY+Sv+RkyqFjgAe73F+MR0TBWKBRDkmfWq/HiFmdavfZ1G7h4SPZXaCSg==
|
||||
|
||||
pkg-types@^1.3.0:
|
||||
pkg-types@^1.2.1, pkg-types@^1.3.0:
|
||||
version "1.3.1"
|
||||
resolved "https://registry.yarnpkg.com/pkg-types/-/pkg-types-1.3.1.tgz#bd7cc70881192777eef5326c19deb46e890917df"
|
||||
integrity sha512-/Jm5M4RvtBFVkKWRu2BLUTNP8/M2a+UwuAX+ae4770q1qVGtfjG+WTCupoZixokjmHiry8uI+dlY8KXYV5HVVQ==
|
||||
|
|
@ -3382,6 +3453,13 @@ randexp@0.4.6:
|
|||
discontinuous-range "1.0.0"
|
||||
ret "~0.1.10"
|
||||
|
||||
randombytes@^2.1.0:
|
||||
version "2.1.0"
|
||||
resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a"
|
||||
integrity sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==
|
||||
dependencies:
|
||||
safe-buffer "^5.1.0"
|
||||
|
||||
read-cache@^1.0.0:
|
||||
version "1.0.0"
|
||||
resolved "https://registry.yarnpkg.com/read-cache/-/read-cache-1.0.0.tgz#e664ef31161166c9751cdbe8dbcf86b5fb58f774"
|
||||
|
|
@ -3537,7 +3615,7 @@ rxjs@^7.5.1:
|
|||
dependencies:
|
||||
tslib "^2.1.0"
|
||||
|
||||
safe-buffer@^5.0.1, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@~5.2.0:
|
||||
safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@~5.2.0:
|
||||
version "5.2.1"
|
||||
resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6"
|
||||
integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==
|
||||
|
|
@ -3564,11 +3642,23 @@ seek-bzip@^1.0.5:
|
|||
dependencies:
|
||||
commander "^2.8.1"
|
||||
|
||||
semver@^7.3.4, semver@^7.5.3:
|
||||
semver@^7.3.4:
|
||||
version "7.7.1"
|
||||
resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.1.tgz#abd5098d82b18c6c81f6074ff2647fd3e7220c9f"
|
||||
integrity sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==
|
||||
|
||||
semver@^7.5.3:
|
||||
version "7.7.0"
|
||||
resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.0.tgz#9c6fe61d0c6f9fa9e26575162ee5a9180361b09c"
|
||||
integrity sha512-DrfFnPzblFmNrIZzg5RzHegbiRWg7KMR7btwi2yjHwx06zsUbO5g613sVwEV7FTwmzJu+Io0lJe2GJ3LxqpvBQ==
|
||||
|
||||
serialize-javascript@^6.0.2:
|
||||
version "6.0.2"
|
||||
resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.2.tgz#defa1e055c83bf6d59ea805d8da862254eb6a6c2"
|
||||
integrity sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==
|
||||
dependencies:
|
||||
randombytes "^2.1.0"
|
||||
|
||||
setimmediate@~1.0.4:
|
||||
version "1.0.5"
|
||||
resolved "https://registry.yarnpkg.com/setimmediate/-/setimmediate-1.0.5.tgz#290cbb232e306942d7d7ea9b83732ab7856f8285"
|
||||
|
|
@ -3884,7 +3974,7 @@ through@^2.3.8:
|
|||
resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5"
|
||||
integrity sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==
|
||||
|
||||
tinyexec@^0.3.2:
|
||||
tinyexec@^0.3.0:
|
||||
version "0.3.2"
|
||||
resolved "https://registry.yarnpkg.com/tinyexec/-/tinyexec-0.3.2.tgz#941794e657a85e496577995c6eef66f53f42b3d2"
|
||||
integrity sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==
|
||||
|
|
|
|||
Loading…
Reference in New Issue