Skip to content

Commit 180c82d

Browse files
committed
fix(api): Fix Cloud Dedicated /ping descriptions
- Cloud Dedicated /ping only reports querier, not ingester, health - Update v1 docs API and client library recommendations. Closes 5610
1 parent 77937e9 commit 180c82d

File tree

2 files changed

+91
-8
lines changed

2 files changed

+91
-8
lines changed

api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,83 @@ paths:
240240
application/json:
241241
schema:
242242
$ref: '#/components/schemas/Error'
243+
/ping:
244+
get:
245+
description: |
246+
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
247+
248+
The response is a HTTP `204` status code to inform you the querier is available.
249+
250+
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
251+
252+
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
253+
254+
This endpoint doesn't require authentication.
255+
operationId: GetPing
256+
responses:
257+
'204':
258+
description: |
259+
Success--the querier is available.
260+
Headers contain InfluxDB version information.
261+
headers:
262+
X-Influxdb-Build:
263+
description: |
264+
The type of InfluxDB build.
265+
schema:
266+
type: string
267+
X-Influxdb-Version:
268+
description: |
269+
The version of InfluxDB.
270+
schema:
271+
type: integer
272+
4xx:
273+
description: |
274+
#### InfluxDB Cloud
275+
- Doesn't return this error.
276+
security:
277+
- {}
278+
servers: []
279+
summary: Get the status of the instance
280+
tags:
281+
- Ping
282+
head:
283+
description: |
284+
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
285+
286+
The response is a HTTP `204` status code to inform you the querier is available.
287+
288+
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
289+
290+
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
291+
292+
This endpoint doesn't require authentication.
293+
294+
operationId: HeadPing
295+
responses:
296+
'204':
297+
description: |
298+
Success--the querier is available.
299+
Headers contain InfluxDB version information.
300+
headers:
301+
X-Influxdb-Build:
302+
description: The type of InfluxDB build.
303+
schema:
304+
type: string
305+
X-Influxdb-Version:
306+
description: |
307+
The version of InfluxDB.
308+
schema:
309+
type: integer
310+
4xx:
311+
description: |
312+
#### InfluxDB Cloud
313+
- Doesn't return this error.
314+
security:
315+
- {}
316+
servers: []
317+
summary: Get the status of the instance
318+
tags:
319+
- Ping
243320
components:
244321
parameters:
245322
TraceSpan:

api-docs/cloud-dedicated/v2/ref.yml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -149,17 +149,20 @@ paths:
149149
/ping:
150150
get:
151151
description: |
152-
Retrieves the status and InfluxDB version of the instance.
152+
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
153+
154+
The response is a HTTP `204` status code to inform you the querier is available.
153155
154-
Use this endpoint to monitor uptime for the InfluxDB instance. The response
155-
returns a HTTP `204` status code to inform you the instance is available.
156+
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
157+
158+
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
156159
157160
This endpoint doesn't require authentication.
158161
operationId: GetPing
159162
responses:
160163
'204':
161164
description: |
162-
Success.
165+
Success--the querier is available.
163166
Headers contain InfluxDB version information.
164167
headers:
165168
X-Influxdb-Build:
@@ -184,17 +187,20 @@ paths:
184187
- Ping
185188
head:
186189
description: |
187-
Returns the status and InfluxDB version of the instance.
190+
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
191+
192+
The response is a HTTP `204` status code to inform you the querier is available.
193+
194+
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
188195
189-
Use this endpoint to monitor uptime for the InfluxDB instance. The response
190-
returns a HTTP `204` status code to inform you the instance is available.
196+
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
191197
192198
This endpoint doesn't require authentication.
193199
operationId: HeadPing
194200
responses:
195201
'204':
196202
description: |
197-
Success.
203+
Success--the querier is available.
198204
Headers contain InfluxDB version information.
199205
headers:
200206
X-Influxdb-Build:

0 commit comments

Comments
 (0)