From d23c007cc4543ead9d1180525cf1b6cbc627e8ca Mon Sep 17 00:00:00 2001 From: trujillo-adam Date: Tue, 6 Sep 2022 11:59:21 -0700 Subject: [PATCH] added no-HA API status error message to EMs page --- website/content/docs/nia/api/status.mdx | 2 +- website/content/docs/nia/usage/errors-ref.mdx | 20 +++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/website/content/docs/nia/api/status.mdx b/website/content/docs/nia/api/status.mdx index 12ca87346..0f5d73761 100644 --- a/website/content/docs/nia/api/status.mdx +++ b/website/content/docs/nia/api/status.mdx @@ -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 | | ------ | ----------------- | ------------------ | diff --git a/website/content/docs/nia/usage/errors-ref.mdx b/website/content/docs/nia/usage/errors-ref.mdx index 9c7cd8bf8..4f433c9ef 100644 --- a/website/content/docs/nia/usage/errors-ref.mdx +++ b/website/content/docs/nia/usage/errors-ref.mdx @@ -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= ``` + +--- + +**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). \ No newline at end of file