Skip to content

http request kafka cluster detail

Jump to bottom
Todd Palino edited this page Dec 1, 2017 · 4 revisions

Name

Kafka Cluster Detail

Usage

This endpoint returns detailed information about a single cluster, specified in the URL. This will include a list of the brokers and zookeepers that Burrow is aware of.

URL path

GET /v3/kafka/(cluster)

Parameters

Name Format Description
cluster string The name of a Kafka cluster, as returned by the [[List Clusters

Response

The response contains a cluster key whose value is an object:

{
    "error": false,
    "message": "cluster module detail returned",
    "module": {
        "class-name": "kafka",
        "client-profile": {
            "client-id": "burrow-i001",
            "kafka-version": "0.8",
            "name": "default"
        },
        "offset-refresh": 30,
        "servers": [
            "kafka01.example.com:10251",
            "kafka02.example.com:10251",
            "kafka03.example.com:10251",
        ],
        "topic-refresh": 120
    },
    "request": {
        "host": "responding.host.example.com",
        "url": "/v3/kafka/tracking"
    }
}

Possible errors

  • Cluster Not Found If an unknown cluster name is provided, a 404 error will be returned with a JSON response body.
  • JSON Encoding Error If there is a failure encoding the JSON response, a 500 error will be returned with a JSON response body.

Clone this wiki locally
⌂ 换网址