Cassandra Clusters - Status

Service:

Cosmos DB Resource Provider

API Version:

2025-04-15

Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status?api-version=2025-04-15

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string minLength: 1 maxLength: 100 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Managed Cassandra cluster name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CassandraClusterPublicStatus	Successfully fetched the usage statistics of all nodes in the cluster.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBManagedCassandraStatus

Sample request

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/status?api-version=2025-04-15

Java

/**
 * Samples for CassandraClusters Status.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBManagedCassandraStatus.json
     */
    /**
     * Sample code: CosmosDBManagedCassandraStatus.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBManagedCassandraStatus(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getCassandraClusters()
            .statusWithResponse("cassandra-prod-rg", "cassandra-prod", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_managed_cassandra_status.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.cassandra_clusters.status(
        resource_group_name="cassandra-prod-rg",
        cluster_name="cassandra-prod",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBManagedCassandraStatus.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBManagedCassandraStatus.json
func ExampleCassandraClustersClient_Status() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCassandraClustersClient().Status(ctx, "cassandra-prod-rg", "cassandra-prod", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CassandraClusterPublicStatus = armcosmos.CassandraClusterPublicStatus{
	// 	ConnectionErrors: []*armcosmos.ConnectionError{
	// 	},
	// 	DataCenters: []*armcosmos.CassandraClusterPublicStatusDataCentersItem{
	// 		{
	// 			Name: to.Ptr("cassandra-westus2-vmss"),
	// 			Nodes: []*armcosmos.ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems{
	// 				{
	// 					Address: to.Ptr("10.0.8.10"),
	// 					CassandraProcessStatus: to.Ptr("Running"),
	// 					CPUUsage: to.Ptr[float64](0.9),
	// 					DiskFreeKB: to.Ptr[int64](1001260056),
	// 					DiskUsedKB: to.Ptr[int64](749836),
	// 					HostID: to.Ptr("8ccc00a7-9e22-4ac2-aa63-e5327aa0dc51"),
	// 					Load: to.Ptr("84.61 MiB"),
	// 					MemoryBuffersAndCachedKB: to.Ptr[int64](10817580),
	// 					MemoryFreeKB: to.Ptr[int64](35731832),
	// 					MemoryTotalKB: to.Ptr[int64](57610444),
	// 					MemoryUsedKB: to.Ptr[int64](11061032),
	// 					Rack: to.Ptr("rack1"),
	// 					Size: to.Ptr[int32](16),
	// 					State: to.Ptr(armcosmos.NodeStateNormal),
	// 					Status: to.Ptr("Up"),
	// 					Timestamp: to.Ptr("10/05/2021, 14:35:20.028"),
	// 					Tokens: []*string{
	// 						to.Ptr("-7785254003841681178"),
	// 						to.Ptr("-6756518164561476165"),
	// 						to.Ptr("-4269720020504480060"),
	// 						to.Ptr("-2697657908817852783"),
	// 						to.Ptr("-2622387897201218249"),
	// 						to.Ptr("-2177258200443022948"),
	// 						to.Ptr("-129203941752875603"),
	// 						to.Ptr("1738406920822650025"),
	// 						to.Ptr("2598053056312400240"),
	// 						to.Ptr("3227346424117996872"),
	// 						to.Ptr("3644347038875498376"),
	// 						to.Ptr("4823546474906050895"),
	// 						to.Ptr("5293156680707616627"),
	// 						to.Ptr("5485806686603256557"),
	// 						to.Ptr("6250058817756969464"),
	// 						to.Ptr("7991328665766267709")},
	// 					},
	// 					{
	// 						Address: to.Ptr("10.0.8.11"),
	// 						CassandraProcessStatus: to.Ptr("Running"),
	// 						CPUUsage: to.Ptr[float64](1.2),
	// 						DiskFreeKB: to.Ptr[int64](1001283028),
	// 						DiskUsedKB: to.Ptr[int64](726864),
	// 						HostID: to.Ptr("14092117-4f77-4ec0-8984-c5b860b88a47"),
	// 						Load: to.Ptr("59.67 MiB"),
	// 						MemoryBuffersAndCachedKB: to.Ptr[int64](10691520),
	// 						MemoryFreeKB: to.Ptr[int64](35863248),
	// 						MemoryTotalKB: to.Ptr[int64](57610444),
	// 						MemoryUsedKB: to.Ptr[int64](11055676),
	// 						Rack: to.Ptr("rack2"),
	// 						Size: to.Ptr[int32](16),
	// 						State: to.Ptr(armcosmos.NodeStateNormal),
	// 						Status: to.Ptr("Up"),
	// 						Timestamp: to.Ptr("10/05/2021, 14:35:20.028"),
	// 						Tokens: []*string{
	// 							to.Ptr("-8726238055665903210"),
	// 							to.Ptr("-6687985003871487470"),
	// 							to.Ptr("-5269140854976433359"),
	// 							to.Ptr("-3989177686905645288"),
	// 							to.Ptr("-3957362495277148220"),
	// 							to.Ptr("-2539287458896988944"),
	// 							to.Ptr("-2460716365393303466"),
	// 							to.Ptr("-1848370030729221440"),
	// 							to.Ptr("137707733677015122"),
	// 							to.Ptr("579467328507000597"),
	// 							to.Ptr("1698264534774619627"),
	// 							to.Ptr("1904235159942090722"),
	// 							to.Ptr("3312208865519999146"),
	// 							to.Ptr("4035940456270983993"),
	// 							to.Ptr("4412314431151736777"),
	// 							to.Ptr("8232565668795426078")},
	// 						},
	// 						{
	// 							Address: to.Ptr("10.0.8.12"),
	// 							CassandraProcessStatus: to.Ptr("Running"),
	// 							CPUUsage: to.Ptr[float64](0.4),
	// 							DiskFreeKB: to.Ptr[int64](1001252352),
	// 							DiskUsedKB: to.Ptr[int64](757540),
	// 							HostID: to.Ptr("e16ada14-39db-462b-9f9e-5b5f6beb8bbd"),
	// 							Load: to.Ptr("93.2 MiB"),
	// 							MemoryBuffersAndCachedKB: to.Ptr[int64](10453856),
	// 							MemoryFreeKB: to.Ptr[int64](36104980),
	// 							MemoryTotalKB: to.Ptr[int64](57610444),
	// 							MemoryUsedKB: to.Ptr[int64](11051608),
	// 							Rack: to.Ptr("rack3"),
	// 							Size: to.Ptr[int32](16),
	// 							State: to.Ptr(armcosmos.NodeStateNormal),
	// 							Status: to.Ptr("Up"),
	// 							Timestamp: to.Ptr("10/05/2021, 14:35:20.028"),
	// 							Tokens: []*string{
	// 								to.Ptr("-5679481051867296621"),
	// 								to.Ptr("-4574115287969297989"),
	// 								to.Ptr("-3444578133211470522"),
	// 								to.Ptr("-2755931580714972271"),
	// 								to.Ptr("-2304431590844389550"),
	// 								to.Ptr("-1961946736975068713"),
	// 								to.Ptr("-940120277889446704"),
	// 								to.Ptr("554469308917912318"),
	// 								to.Ptr("1030447162050118004"),
	// 								to.Ptr("2745632329542596589"),
	// 								to.Ptr("4564547712926446283"),
	// 								to.Ptr("5185613478135944116"),
	// 								to.Ptr("7280237939830623824"),
	// 								to.Ptr("7504213835759531710"),
	// 								to.Ptr("7631994478195429959"),
	// 								to.Ptr("8139769477321226157")},
	// 						}},
	// 						SeedNodes: []*string{
	// 							to.Ptr("10.0.8.10"),
	// 							to.Ptr("10.0.8.11"),
	// 							to.Ptr("10.0.8.12")},
	// 					}},
	// 					ETag: to.Ptr("A350A2CE7E91B6D5A102A5E5EC222B882D981092"),
	// 					ReaperStatus: &armcosmos.ManagedCassandraReaperStatus{
	// 						Healthy: to.Ptr(true),
	// 						RepairRunIDs: map[string]*string{
	// 						},
	// 						RepairSchedules: map[string]*string{
	// 							"00000000-0000-0001-0000-000000000000": to.Ptr("ACTIVE"),
	// 						},
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
 *
 * @summary Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBManagedCassandraStatus.json
 */
async function cosmosDbManagedCassandraStatus() {
  const subscriptionId =
    process.env["COSMOSDB_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "cassandra-prod-rg";
  const clusterName = "cassandra-prod";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.cassandraClusters.status(resourceGroupName, clusterName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "eTag": "A350A2CE7E91B6D5A102A5E5EC222B882D981092",
  "reaperStatus": {
    "healthy": true,
    "repairRunIds": {},
    "repairSchedules": {
      "00000000-0000-0001-0000-000000000000": "ACTIVE"
    }
  },
  "connectionErrors": [],
  "dataCenters": [
    {
      "name": "cassandra-westus2-vmss",
      "seedNodes": [
        "10.0.8.10",
        "10.0.8.11",
        "10.0.8.12"
      ],
      "nodes": [
        {
          "address": "10.0.8.10",
          "state": "Normal",
          "status": "Up",
          "cassandraProcessStatus": "Running",
          "load": "84.61 MiB",
          "tokens": [
            "-7785254003841681178",
            "-6756518164561476165",
            "-4269720020504480060",
            "-2697657908817852783",
            "-2622387897201218249",
            "-2177258200443022948",
            "-129203941752875603",
            "1738406920822650025",
            "2598053056312400240",
            "3227346424117996872",
            "3644347038875498376",
            "4823546474906050895",
            "5293156680707616627",
            "5485806686603256557",
            "6250058817756969464",
            "7991328665766267709"
          ],
          "size": 16,
          "hostID": "8ccc00a7-9e22-4ac2-aa63-e5327aa0dc51",
          "rack": "rack1",
          "timestamp": "10/05/2021, 14:35:20.028",
          "diskUsedKB": 749836,
          "diskFreeKB": 1001260056,
          "memoryUsedKB": 11061032,
          "memoryBuffersAndCachedKB": 10817580,
          "memoryFreeKB": 35731832,
          "memoryTotalKB": 57610444,
          "cpuUsage": 0.9
        },
        {
          "address": "10.0.8.11",
          "state": "Normal",
          "status": "Up",
          "cassandraProcessStatus": "Running",
          "load": "59.67 MiB",
          "tokens": [
            "-8726238055665903210",
            "-6687985003871487470",
            "-5269140854976433359",
            "-3989177686905645288",
            "-3957362495277148220",
            "-2539287458896988944",
            "-2460716365393303466",
            "-1848370030729221440",
            "137707733677015122",
            "579467328507000597",
            "1698264534774619627",
            "1904235159942090722",
            "3312208865519999146",
            "4035940456270983993",
            "4412314431151736777",
            "8232565668795426078"
          ],
          "size": 16,
          "hostID": "14092117-4f77-4ec0-8984-c5b860b88a47",
          "rack": "rack2",
          "timestamp": "10/05/2021, 14:35:20.028",
          "diskUsedKB": 726864,
          "diskFreeKB": 1001283028,
          "memoryUsedKB": 11055676,
          "memoryBuffersAndCachedKB": 10691520,
          "memoryFreeKB": 35863248,
          "memoryTotalKB": 57610444,
          "cpuUsage": 1.2
        },
        {
          "address": "10.0.8.12",
          "state": "Normal",
          "status": "Up",
          "cassandraProcessStatus": "Running",
          "load": "93.2 MiB",
          "tokens": [
            "-5679481051867296621",
            "-4574115287969297989",
            "-3444578133211470522",
            "-2755931580714972271",
            "-2304431590844389550",
            "-1961946736975068713",
            "-940120277889446704",
            "554469308917912318",
            "1030447162050118004",
            "2745632329542596589",
            "4564547712926446283",
            "5185613478135944116",
            "7280237939830623824",
            "7504213835759531710",
            "7631994478195429959",
            "8139769477321226157"
          ],
          "size": 16,
          "hostID": "e16ada14-39db-462b-9f9e-5b5f6beb8bbd",
          "rack": "rack3",
          "timestamp": "10/05/2021, 14:35:20.028",
          "diskUsedKB": 757540,
          "diskFreeKB": 1001252352,
          "memoryUsedKB": 11051608,
          "memoryBuffersAndCachedKB": 10453856,
          "memoryFreeKB": 36104980,
          "memoryTotalKB": 57610444,
          "cpuUsage": 0.4
        }
      ]
    }
  ]
}

Definitions

Name	Description
CassandraClusterPublicStatus	Properties of a managed Cassandra cluster public status.
CassandraError
CloudError	An error response from the service.
ConnectionError
ConnectionState	The kind of connection error that occurred.
DataCenters	List of the status of each datacenter in this cluster.
ErrorResponse	Error Response.
ManagedCassandraReaperStatus
Nodes
NodeState	The state of the node in Cassandra ring.

CassandraClusterPublicStatus

Object

Properties of a managed Cassandra cluster public status.

Name	Type	Description
connectionErrors	ConnectionError[]	List relevant information about any connection errors to the Datacenters.
dataCenters	DataCenters[]	List of the status of each datacenter in this cluster.
eTag	string
errors	CassandraError[]	List relevant information about any errors about cluster, data center and connection error.
reaperStatus	ManagedCassandraReaperStatus

CassandraError

Object

Name	Type	Description
additionalErrorInfo	string	Additional information about the error.
code	string	The code of error that occurred.
message	string	The message of the error.
target	string	The target resource of the error.

CloudError

Object

An error response from the service.

Name	Type	Description
error	ErrorResponse	Error Response.

ConnectionError

Object

Name	Type	Description
connectionState	ConnectionState	The kind of connection error that occurred.
exception	string	Detailed error message about the failed connection.
iPFrom	string	The IP of host that originated the failed connection.
iPTo	string	The IP that the connection attempted to reach.
port	integer (int32)	The TCP port the connection was attempted on.

ConnectionState

Enumeration

The kind of connection error that occurred.

Value	Description
Unknown
OK
OperatorToDataCenterNetworkError
DatacenterToDatacenterNetworkError
InternalOperatorToDataCenterCertificateError
InternalError

DataCenters

Object

List of the status of each datacenter in this cluster.

Name	Type	Description
name	string	The name of this Datacenter.
nodes	Nodes[]
seedNodes	string[]	A list of all seed nodes in the cluster, managed and unmanaged.

ErrorResponse

Object

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ManagedCassandraReaperStatus

Object

Name	Type	Description
healthy	boolean
repairRunIds	object
repairSchedules	object

Nodes

Object

Name	Type	Description
address	string	The node's IP address.
cassandraProcessStatus	string	Cassandra service status on this node
cpuUsage	number (double)	A float representing the current system-wide CPU utilization as a percentage.
diskFreeKB	integer (int64)	The amount of disk free, in kB, of the directory /var/lib/cassandra.
diskUsedKB	integer (int64)	The amount of disk used, in kB, of the directory /var/lib/cassandra.
hostID	string	The network ID of the node.
load	string	The amount of file system data in the data directory (e.g., 47.66 kB), excluding all content in the snapshots subdirectories. Because all SSTable data files are included, any data that is not cleaned up (such as TTL-expired cells or tombstones) is counted.
memoryBuffersAndCachedKB	integer (int64)	Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo), in kB.
memoryFreeKB	integer (int64)	Unused memory (MemFree and SwapFree in /proc/meminfo), in kB.
memoryTotalKB	integer (int64)	Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB.
memoryUsedKB	integer (int64)	Used memory (calculated as total - free - buffers - cache), in kB.
rack	string	The rack this node is part of.
size	integer (int32)
state	NodeState	The state of the node in Cassandra ring.
status	string
timestamp	string	The timestamp when these statistics were captured.
tokens	string[]	List of tokens this node covers.

NodeState

Enumeration

The state of the node in Cassandra ring.

Value	Description
Normal
Leaving
Joining
Moving
Stopped