{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/crdb-cli/crdb/health-report",
  "title": "crdb-cli crdb health-report",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/crdb-cli/crdb/health-report/",
  "summary": "Shows the health report of an Active-Active database.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2023-12-14T15:27:49+01:00",
  "page_type": "content",
  "content_hash": "9df7f5bb746b2500970d35f8ce6e15118ba7222725a4bd646fb42ad4cfa6db52",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Shows the health report of the API management layer of an Active-Active database.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter           | Value  | Description                         |\n|---------------------|--------|-------------------------------------|\n| crdb-guid  | string | The GUID of the database (required) |"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Returns the health report of the API management layer of the database."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "overview-ex0",
      "language": "sh",
      "code": "crdb-cli crdb health-report --crdb-guid <guid>",
      "section_id": "overview"
    },
    {
      "id": "example-ex0",
      "language": "sh",
      "code": "$ crdb-cli crdb health-report --crdb-guid d84f6fe4-5bb7-49d2-a188-8900e09c6f66\n[\n  {\n    \"active_config_version\":1,\n    \"cluster_name\":\"cluster2.redis.local\",\n    \"configurations\":[\n      {\n        \"causal_consistency\":false,\n        \"encryption\":false,\n        \"featureset_version\":5,\n        \"instances\":[\n          {\n            \"cluster\":{\n              \"name\":\"cluster1.redis.local\",\n              \"url\":\"https:\\/\\/cluster1.redis.local:9443\"\n            },\n            \"db_uid\":\"\",\n            \"id\":1\n          },\n          {\n            \"cluster\":{\n              \"name\":\"cluster2.redis.local\",\n              \"url\":\"https:\\/\\/cluster2.redis.local:9443\"\n            },\n            \"db_uid\":\"1\",\n            \"id\":2\n          }\n        ],\n        \"name\":\"database1\",\n        \"protocol_version\":1,\n        \"status\":\"commit-completed\",\n        \"version\":1\n      }\n    ],\n    \"connections\":[\n      {\n        \"name\":\"cluster1.redis.local\",\n        \"status\":\"ok\"\n      },\n      {\n        \"name\":\"cluster2.redis.local\",\n        \"status\":\"ok\"\n      }\n    ],\n    \"guid\":\"d84f6fe4-5bb7-49d2-a188-8900e09c6f66\",\n    \"name\":\"database1\",\n    \"connection_error\":null\n  },\n  {\n    \"active_config_version\":1,\n    \"cluster_name\":\"cluster1.redis.local\",\n    \"configurations\":[\n      {\n        \"causal_consistency\":false,\n        \"encryption\":false,\n        \"featureset_version\":5,\n        \"instances\":[\n          {\n            \"cluster\":{\n              \"name\":\"cluster1.redis.local\",\n              \"url\":\"https:\\/\\/cluster1.redis.local:9443\"\n            },\n            \"db_uid\":\"4\",\n            \"id\":1\n          },\n          {\n            \"cluster\":{\n              \"name\":\"cluster2.redis.local\",\n              \"url\":\"https:\\/\\/cluster2.redis.local:9443\"\n            },\n            \"db_uid\":\"\",\n            \"id\":2\n          }\n        ],\n        \"name\":\"database1\",\n        \"protocol_version\":1,\n        \"status\":\"commit-completed\",\n        \"version\":1\n      }\n    ],\n    \"connections\":[\n      {\n        \"name\":\"cluster1.redis.local\",\n        \"status\":\"ok\"\n      },\n      {\n        \"name\":\"cluster2.redis.local\",\n        \"status\":\"ok\"\n      }\n    ],\n    \"guid\":\"d84f6fe4-5bb7-49d2-a188-8900e09c6f66\",\n    \"name\":\"database1\",\n    \"connection_error\":null\n  }\n]",
      "section_id": "example"
    }
  ]
}