commit
b4a8bc941f
|
@ -49,6 +49,7 @@ retrieving authentication tokens._
|
||||||
| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands |
|
| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands |
|
||||||
| [help](/v2.0/reference/cli/influx/help) | Help about any command |
|
| [help](/v2.0/reference/cli/influx/help) | Help about any command |
|
||||||
| [org](/v2.0/reference/cli/influx/org) | Organization management commands |
|
| [org](/v2.0/reference/cli/influx/org) | Organization management commands |
|
||||||
|
| [ping](/v2.0/reference/cli/influx/ping) | Check the InfluxDB `/health` endpoint |
|
||||||
| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query |
|
| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query |
|
||||||
| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) |
|
| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) |
|
||||||
| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. |
|
| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket, etc. |
|
||||||
|
|
|
@ -21,13 +21,13 @@ influx auth [command]
|
||||||
`auth`, `authorization`
|
`auth`, `authorization`
|
||||||
|
|
||||||
## Subcommands
|
## Subcommands
|
||||||
| Subcommand | Description |
|
| Subcommand | Description |
|
||||||
|:---------- |:----------- |
|
|:---------- |:----------- |
|
||||||
| [active](/v2.0/reference/cli/influx/auth/active) | Active authorization |
|
| [active](/v2.0/reference/cli/influx/auth/active) | Activate authorization |
|
||||||
| [create](/v2.0/reference/cli/influx/auth/create) | Create authorization |
|
| [create](/v2.0/reference/cli/influx/auth/create) | Create authorization |
|
||||||
| [delete](/v2.0/reference/cli/influx/auth/delete) | Delete authorization |
|
| [delete](/v2.0/reference/cli/influx/auth/delete) | Delete authorization |
|
||||||
| [find](/v2.0/reference/cli/influx/auth/find) | Find authorization |
|
| [find](/v2.0/reference/cli/influx/auth/find) | Find authorization |
|
||||||
| [inactive](/v2.0/reference/cli/influx/auth/inactive) | Inactive authorization |
|
| [inactive](/v2.0/reference/cli/influx/auth/inactive) | Inactivate authorization |
|
||||||
|
|
||||||
## Flags
|
## Flags
|
||||||
| Flag | Description |
|
| Flag | Description |
|
||||||
|
|
|
@ -20,6 +20,8 @@ influx auth find [flags]
|
||||||
|:---- |:----------- |:----------: |
|
|:---- |:----------- |:----------: |
|
||||||
| `-h`, `--help` | Help for the `find` command | |
|
| `-h`, `--help` | Help for the `find` command | |
|
||||||
| `-i`, `--id` | The authorization ID | string |
|
| `-i`, `--id` | The authorization ID | string |
|
||||||
|
| `-o`, `--org` | The organization | string |
|
||||||
|
| `--org-id` | The organization ID | string |
|
||||||
| `-u`, `--user` | The user | string |
|
| `-u`, `--user` | The user | string |
|
||||||
| `--user-id` | The user ID | string |
|
| `--user-id` | The user ID | string |
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,6 @@ influx bucket create [flags]
|
||||||
|:---- |:----------- |:----------: |
|
|:---- |:----------- |:----------: |
|
||||||
| `-h`, `--help` | Help for the `create` command | |
|
| `-h`, `--help` | Help for the `create` command | |
|
||||||
| `-n`, `--name` | Name of bucket that will be created | string |
|
| `-n`, `--name` | Name of bucket that will be created | string |
|
||||||
| `-o`, `--org` | Name of the organization that owns the bucket | string |
|
|
||||||
| `--org-id` | The ID of the organization that owns the bucket | string |
|
| `--org-id` | The ID of the organization that owns the bucket | string |
|
||||||
| `-r`, `--retention` | Duration in nanoseconds data will live in bucket | duration |
|
| `-r`, `--retention` | Duration in nanoseconds data will live in bucket | duration |
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,33 @@
|
||||||
|
---
|
||||||
|
title: influx ping – Check the health of InfluxDB
|
||||||
|
description: >
|
||||||
|
The `influx ping` command checks the health of a running InfluxDB instance by
|
||||||
|
querying the `/health` endpoint.
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx ping
|
||||||
|
parent: influx
|
||||||
|
weight: 101
|
||||||
|
v2.0/tags: [ping, health]
|
||||||
|
---
|
||||||
|
|
||||||
|
The `influx ping` command checks the health of a running InfluxDB instance by
|
||||||
|
querying the `/health` endpoint.
|
||||||
|
It does not require an authorization token.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx ping [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the `ping` command |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
|
@ -21,6 +21,7 @@ influx task find [flags]
|
||||||
| `-h`, `--help` | Help for `find` | |
|
| `-h`, `--help` | Help for `find` | |
|
||||||
| `-i`, `--id` | Task ID | string |
|
| `-i`, `--id` | Task ID | string |
|
||||||
| `--limit` | The number of tasks to find (default `100`) | integer |
|
| `--limit` | The number of tasks to find (default `100`) | integer |
|
||||||
|
| `--org` | Task organization name | string |
|
||||||
| `--org-id` | Task organization ID | string |
|
| `--org-id` | Task organization ID | string |
|
||||||
| `-n`, `--user-id` | Task owner ID | string |
|
| `-n`, `--user-id` | Task owner ID | string |
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue