Skip to main content
Retrieve metadata about a Kafka broker, including broker information, topic details, partition assignments and leader brokers.

Basic Parameters

ParameterDescription
AddressThe Kafka broker address to get the metadata of.
Topics To IncludeA comma-separated list of topic names to retrieve metadata for. When omitted, all available topic will be retrieved.

Example Output

{
	"Throttle": 0,
	"ClusterID": "a3f9e2c1-4b8d-9c12-3a5e-7f9d8e1b2c3d",
	"Controller": {
		"Host": "10.0.1.100",
		"Port": 9092,
		"ID": 1,
		"Rack": "us-east-1a"
	},
	"Brokers": [
		{
			"Host": "10.0.1.100",
			"Port": 9092,
			"ID": 1,
			"Rack": "us-east-1a"
		},
		{
			"Host": "10.0.1.101",
			"Port": 9092,
			"ID": 2,
			"Rack": "us-east-1b"
		},
		{
			"Host": "10.0.1.102",
			"Port": 9092,
			"ID": 3,
			"Rack": "us-east-1c"
		}
	],
	"Topics": [
		{
			"Name": "__consumer_offsets",
			"Internal": true,
			"Partitions": [
				{
					"Topic": "__consumer_offsets",
					"ID": 0,
					"Leader": {
						"Host": "10.0.1.100",
						"Port": 9092,
						"ID": 1,
						"Rack": "us-east-1a"
					},
					"Replicas": [
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						},
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						},
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						}
					],
					"Isr": [
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						},
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						},
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						}
					],
					"OfflineReplicas": null,
					"Error": null
				}
			],
			"Error": null
		},
		{
			"Name": "orders",
			"Internal": false,
			"Partitions": [
				{
					"Topic": "orders",
					"ID": 0,
					"Leader": {
						"Host": "10.0.1.100",
						"Port": 9092,
						"ID": 1,
						"Rack": "us-east-1a"
					},
					"Replicas": [
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						},
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						}
					],
					"Isr": [
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						},
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						}
					],
					"OfflineReplicas": null,
					"Error": null
				},
				{
					"Topic": "orders",
					"ID": 1,
					"Leader": {
						"Host": "10.0.1.101",
						"Port": 9092,
						"ID": 2,
						"Rack": "us-east-1b"
					},
					"Replicas": [
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						},
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						}
					],
					"Isr": [
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						},
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						}
					],
					"OfflineReplicas": null,
					"Error": null
				},
				{
					"Topic": "orders",
					"ID": 2,
					"Leader": {
						"Host": "10.0.1.102",
						"Port": 9092,
						"ID": 3,
						"Rack": "us-east-1c"
					},
					"Replicas": [
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						},
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						}
					],
					"Isr": [
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						},
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						}
					],
					"OfflineReplicas": null,
					"Error": null
				}
			],
			"Error": null
		},
		{
			"Name": "user-events",
			"Internal": false,
			"Partitions": [
				{
					"Topic": "user-events",
					"ID": 0,
					"Leader": {
						"Host": "10.0.1.101",
						"Port": 9092,
						"ID": 2,
						"Rack": "us-east-1b"
					},
					"Replicas": [
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						},
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						},
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						}
					],
					"Isr": [
						{
							"Host": "10.0.1.101",
							"Port": 9092,
							"ID": 2,
							"Rack": "us-east-1b"
						},
						{
							"Host": "10.0.1.102",
							"Port": 9092,
							"ID": 3,
							"Rack": "us-east-1c"
						},
						{
							"Host": "10.0.1.100",
							"Port": 9092,
							"ID": 1,
							"Rack": "us-east-1a"
						}
					],
					"OfflineReplicas": null,
					"Error": null
				}
			],
			"Error": null
		}
	]
}