added the influx ping command, resolves #183

pull/184/head
Scott Anderson 2019-04-24 10:36:22 -06:00
parent f1f9feb89c
commit 944d2b80dd
2 changed files with 34 additions and 0 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

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