Merge pull request #184 from influxdata/update/influx-cli

Update influx CLI commands
pull/199/head
Scott Anderson 2019-04-24 11:15:46 -06:00 committed by GitHub
commit b4a8bc941f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 44 additions and 8 deletions

View File

@ -49,6 +49,7 @@ retrieving authentication tokens._
| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands |
| [help](/v2.0/reference/cli/influx/help) | Help about any command |
| [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 |
| [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. |

View File

@ -21,13 +21,13 @@ influx auth [command]
`auth`, `authorization`
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [active](/v2.0/reference/cli/influx/auth/active) | Active authorization |
| [create](/v2.0/reference/cli/influx/auth/create) | Create authorization |
| [delete](/v2.0/reference/cli/influx/auth/delete) | Delete authorization |
| [find](/v2.0/reference/cli/influx/auth/find) | Find authorization |
| [inactive](/v2.0/reference/cli/influx/auth/inactive) | Inactive authorization |
| Subcommand | Description |
|:---------- |:----------- |
| [active](/v2.0/reference/cli/influx/auth/active) | Activate authorization |
| [create](/v2.0/reference/cli/influx/auth/create) | Create authorization |
| [delete](/v2.0/reference/cli/influx/auth/delete) | Delete authorization |
| [find](/v2.0/reference/cli/influx/auth/find) | Find authorization |
| [inactive](/v2.0/reference/cli/influx/auth/inactive) | Inactivate authorization |
## Flags
| Flag | Description |

View File

@ -20,6 +20,8 @@ influx auth find [flags]
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for the `find` command | |
| `-i`, `--id` | The authorization ID | string |
| `-o`, `--org` | The organization | string |
| `--org-id` | The organization ID | string |
| `-u`, `--user` | The user | string |
| `--user-id` | The user ID | string |

View File

@ -20,7 +20,6 @@ influx bucket create [flags]
|:---- |:----------- |:----------: |
| `-h`, `--help` | Help for the `create` command | |
| `-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 |
| `-r`, `--retention` | Duration in nanoseconds data will live in bucket | duration |

View File

@ -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 |

View File

@ -21,6 +21,7 @@ influx task find [flags]
| `-h`, `--help` | Help for `find` | |
| `-i`, `--id` | Task ID | string |
| `--limit` | The number of tasks to find (default `100`) | integer |
| `--org` | Task organization name | string |
| `--org-id` | Task organization ID | string |
| `-n`, `--user-id` | Task owner ID | string |