luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Document streaming on service health endpoint

This commit is contained in:
Daniel Nephin 2021-05-03 17:40:07 -04:00
parent 789478b542
commit d4b077174c
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/content/api-docs/health.mdx
View File

@ -208,14 +208,15 @@ incorporating the use of health checks.
| `GET` | `/health/service/:service` | `application/json` |
The table below shows this endpoint's support for
[streaming](/api/features/streaming),
[blocking queries](/api/features/blocking),
[consistency modes](/api/features/consistency),
[agent caching](/api/features/caching), and
[required ACLs](/api#authentication).
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | -------------------- | ------------------------ |
| `YES` | `all` | `background refresh` | `node:read,service:read` |
| Streaming | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ----------| ---------------- | ----------------- | -------------------- | ------------------------ |
| `partial` | `YES` | `all` | `background refresh` | `node:read,service:read` |
### Parameters
@ -425,6 +426,11 @@ gateway](/docs/connect/ingress-gateway) for a service in a given datacenter.
Parameters and response format are the same as
[`/health/service/:service`](/api/health#list-nodes-for-service).
**Note** that unlike `/health/connect/:service` and `/health/service/:service` this
endpoint does not support [streaming](/api/features/streaming), and will use
[blocking queries](/api/features/blocking).
## List Checks in State
This endpoint returns the checks in the state provided on the path.