Headers

• Connect-Protocol-Version number Required

  Define the version of the Connect protocol

  Value is 1.

• Connect-Timeout-Ms number

  Define the timeout, in ms

Responses

• 200 application/json

  Success

  Hide response attributes Show response attributes object

  • connections array[object]

    The list of connections matching the request. Note that in addition to open connections, some recently-closed connections may also be included here. If you don't want to include closed connections, set the filter in the request to state = KAFKA_CONNECTION_STATE_OPEN.

    Kafka connection details for a broker

    Hide connections attributes Show connections attributes object

    • apiVersions object

      This map records, for each Kafka API, the highest version number observed in requests on this connection. It can be useful for understanding which protocol versions a client supports or has negotiated with the broker. Only APIs that were actually used (i.e. at least one request was seen) are included.

      Example: { 0: 11, 1: 13 } means that for API key 0 (Produce), version 11 was the highest seen, and for API key 1 (Fetch), version 13 was the highest seen.

      Reference:

      • https://kafka.apache.org/0101/protocol.html#protocol_api_keys
      • https://kafka.apache.org/0101/protocol.html#protocol_compatibility
      Hide apiVersions attribute Show apiVersions attribute object

      • * integer(int32) Additional properties
    • authenticationInfo object

      Information about the authentication state of the connection

      Additional properties are NOT allowed.

      Hide authenticationInfo attributes Show authenticationInfo attributes object

      • mechanism string

        Authentication mechanism

        Values are AUTHENTICATION_MECHANISM_UNSPECIFIED, AUTHENTICATION_MECHANISM_MTLS, AUTHENTICATION_MECHANISM_SASL_SCRAM, AUTHENTICATION_MECHANISM_SASL_OAUTHBEARER, AUTHENTICATION_MECHANISM_SASL_PLAIN, or AUTHENTICATION_MECHANISM_SASL_GSSAPI.

      • state string

        Authentication state

        Values are AUTHENTICATION_STATE_UNSPECIFIED, AUTHENTICATION_STATE_UNAUTHENTICATED, AUTHENTICATION_STATE_SUCCESS, or AUTHENTICATION_STATE_FAILURE.

      • userPrincipal string

        Authenticated user principal

    • clientId string

      Client identifier included in every request sent by the Kafka client. This is typically a configurable property (client.id) set by the application when creating a producer or consumer, and is often used for metrics, quotas, and debugging.

    • clientSoftwareName string

      Name of the client library, reported automatically in ApiVersions v3+ requests. This is set by the client implementation and is not typically configurable by applications.

    • clientSoftwareVersion string

      Version of the client library, reported automatically in ApiVersions v3+ requests. Like client_software_name, this is set by the client and not usually configurable by applications.

    • closeTime string(date-time)

      When the connection was closed. This field is set only when the connection state is "closed".

    • groupId string

      Most recent group ID seen in requests sent over this connection. This typically refers to a consumer group, but the Kafka group protocol is more general and may also be used by other types of clients that coordinate membership and assignments through the broker.

    • groupInstanceId string

      Most recent group instance ID seen in requests sent over this connection. This is used when static membership is enabled, allowing a specific client instance to retain its group membership across restarts.

    • groupMemberId string

      Most recent group member ID seen in requests sent over this connection. This is the unique identifier assigned by the broker to a particular member of the group.

    • idleDuration string(duration)

      How long the connection has been idle (no in-flight requests)

    • inFlightRequests object

      Currently in-flight requests

      Additional properties are NOT allowed.

      Hide inFlightRequests attributes Show inFlightRequests attributes object

      • hasMoreRequests boolean

        Whether there are more in-flight requests than those in sampled_in_flight_requests.

      • sampledInFlightRequests array[object]

        A sample (e.g., the 5 latest) of the currently in-flight requests

        Hide sampledInFlightRequests attributes Show sampledInFlightRequests attributes object

        • apiKey integer(int32)

          API key for the request type (e.g., produce/fetch/metadata/etc) https://kafka.apache.org/0101/protocol.html#protocol_api_keys

        • inFlightDuration string(duration)

          How long the request has been in-flight since it was received

    • listenerName string

      Name of the Kafka listener that accepted this connection. A listener is a named broker endpoint (for example, "internal", "external", or "sasl_tls"). Each listener defines its network address and enforces its protocol and authentication policy.

    • nodeId integer(int32)

      Broker node ID

    • openTime string(date-time)

      When the broker accepted the connection

    • recentRequestStatistics object

      Statistics for previous last one minute window.

      Additional properties are NOT allowed.

      Hide recentRequestStatistics attributes Show recentRequestStatistics attributes object

      • fetchBytes integer | string

        Sum of bytes fetched.

      • produceBatchCount integer | string

        Number of produced batches. Average batch size = produce_bytes / produce_batch_count

      • produceBytes integer | string

        Sum of bytes produced.

      • requestCount integer | string

        Number of requests the client has made.

    • shardId integer

      Broker shard that handles the connection

    • source object

      Remote client address of the TCP connection

      Additional properties are NOT allowed.

      Hide source attributes Show source attributes object

      • ipAddress string
      • port integer
    • state string

      Lifecycle state of the connection (open/aborting/closed)

      Values are KAFKA_CONNECTION_STATE_UNSPECIFIED, KAFKA_CONNECTION_STATE_OPEN, KAFKA_CONNECTION_STATE_ABORTING, or KAFKA_CONNECTION_STATE_CLOSED.

    • tlsInfo object

      Information about the TLS state of the connection (e.g., whether TLS encryption is used for this connection)

      Additional properties are NOT allowed.

      Hide tlsInfo attribute Show tlsInfo attribute object

      • enabled boolean

        Whether TLS is in use

    • totalRequestStatistics object

      Aggregated statistics for the entire connection's lifetime.

      Additional properties are NOT allowed.

      Hide totalRequestStatistics attributes Show totalRequestStatistics attributes object

      • fetchBytes integer | string

        Sum of bytes fetched.

      • produceBatchCount integer | string

        Number of produced batches. Average batch size = produce_bytes / produce_batch_count

      • produceBytes integer | string

        Sum of bytes produced.

      • requestCount integer | string

        Number of requests the client has made.

    • transactionalId string

      Most recent transactional ID seen in requests sent over this connection

    • uid string

      Kafka connection UUID

  • totalSize integer | string

    Total number of connections matching the request. This may be greater than len(connections) if some connections were omitted from the response due to the specified (or default) page_size. Example: request.page_size = 10 response.connections = [<10 items>] response.total_size = 13

• default application/json

  Error

  Hide response attributes Show response attributes object

  • code string

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    Values are canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, or unauthenticated.

  • details array[object]

    A list of messages that carry the error details. There is no limit on the number of messages.

    Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

    Hide details attributes Show details attributes object

    • debug object

      Detailed error information.

      Additional properties are allowed.

    • type string

      A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

    • value string(binary)

      The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

  • message string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.