Rabbitmq Overview

Operations Summary

Method	Endpoint	Description
GET	/api/rabbitmq-overview/	Get RabbitMQ cluster overview statistics

---

Get RabbitMQ cluster overview statistics

Returns global RabbitMQ cluster health and performance metrics.

Includes: - Cluster info: Name, RabbitMQ version, Erlang version - Message stats: Publish/deliver/confirm/ack counts and rates (per second) - Queue totals: Total messages, ready messages, unacknowledged messages - Object totals: Connection, channel, exchange, queue, and consumer counts - Listeners: Active protocol listeners (AMQP, HTTP, etc.)

Requires support user permissions.

HTTPiePythonTypeScriptResponses

http \
  GET \
  https://api.example.com/api/rabbitmq-overview/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rabbitmq_overview import rabbitmq_overview_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rabbitmq_overview_retrieve.sync(client=client)

print(response)

1. API Source: rabbitmq_overview_retrieve

import { rabbitmqOverviewRetrieve } from 'waldur-js-client';

try {
  const response = await rabbitmqOverviewRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field	Type	Description
cluster_name	string	Name of the RabbitMQ cluster
rabbitmq_version	string	RabbitMQ server version
erlang_version	string	Erlang/OTP runtime version
message_stats	any	Message throughput statistics with rates
queue_totals	any	Global queue message counts
object_totals	any	Counts of connections, channels, queues, etc.
node	string	Current RabbitMQ node name
listeners	array of objects	Active protocol listeners
listeners.protocol	string	Protocol name (e.g., 'amqp', 'http', 'clustering')
listeners.port	integer	Listening port number

---

503 -

Field	Type	Description
error	string	Error message describing what went wrong

---