status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

added no-HA API status error message to EMs page

This commit is contained in:
trujillo-adam 2022-09-06 11:59:21 -07:00
parent c76116fec2
commit 47f3a00969
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/docs/nia/api/status.mdx
View File

@ -232,7 +232,7 @@ Response:
## Cluster status
The `/v1/status/cluster` API endpoint returns information about the cluster and member instances, such as health status and leadership. This endpoint is only supported when using CTS in [high availability mode](/docs/usage/run-ha). If you call the endpoint without configuring CTS for high availability, then CTS prints an error to the console. Refer to [Error Messages](/docs/nia/usage/errors-ref) for information about CTS error messages.
The `/v1/status/cluster` API endpoint returns information about the cluster and member instances, such as health status and leadership. This endpoint is only supported when using CTS in [high availability mode](/docs/nia/usage/run-ha). If you call the endpoint without configuring CTS for high availability, then CTS prints an error to the console. Refer to [Error Messages](/docs/nia/usage/errors-ref) for information about CTS error messages.
| Method | Path | Response format |
| ------ | ----------------- | ------------------ |

20
website/content/docs/nia/usage/errors-ref.mdx
View File

@ -95,3 +95,23 @@ Identify and send the request to the leader CTS instance. You can identify the l
```shell-session
[INFO] ha: acquired leadership lock: id=<ID-OF-CTS-INSTANCE>
```
---
**Error**:
```json
{
"error": {
"message": "this endpoint is only available with high availability configured"
}
}
```
**Conditions**:
- CTS is not configured for [high availability](/docs/nia/usage/run-ha).
**Resolution**:
Configure CTS to run in [high availability mode](/docs/nia/usage/run-ha).