For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Get the topology of the whole cluster Added in 8.10

GET 
/cluster/v2/topology

Strongly Consistent About endpoint data consistency

Obtains the topology of the whole cluster, aggregated over all physical tenants. Cluster-level information is reported once; partition layout, replication and per-partition role, health and state are reported per physical tenant.

Requires the cluster-admin security chain. Although this operation lists bearerAuth / basicAuth like the rest of the Orchestration Cluster API, it does not accept an Orchestration Cluster user's credentials — only the separate cluster-admin credentials are valid here. Use GET /v2/topology for the topology of a single physical tenant.

Required permissions​

Even when authorization is enabled, this endpoint requires no specific permission. See resources and permissions to learn more.

Responses​

The topology of the whole cluster, aggregated over all physical tenants.