REredpanda-data
Kafka Connect

Get connector status

Changed on

Gets the current status of the connector, including the state for each of its tasks, error information, etc.

get/v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/status

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Path parameters

cluster_namestring required

Unique name of target Connect cluster. For Redpanda Cloud, use redpanda.

namestring required

Name of connector.

Response

OK

holistic_state'CONNECTOR_HOLISTIC_STATE_PAUSED' | 'CONNECTOR_HOLISTIC_STATE_RESTARTING' | 'CONNECTOR_HOLISTIC_STATE_DESTROYED' | 'CONNECTOR_HOLISTIC_STATE_STOPPED' | 'CONNECTOR_HOLISTIC_STATE_UNASSIGNED' | 'CONNECTOR_HOLISTIC_STATE_HEALTHY' | 'CONNECTOR_HOLISTIC_STATE_UNHEALTHY' | 'CONNECTOR_HOLISTIC_STATE_DEGRADED' | 'CONNECTOR_HOLISTIC_STATE_UNKNOWN'

State of a connector or one of its tasks, as described in the Kafka Connect documentation. Takes into account not just the state of the connector instance itself, but also the tasks within the connector.

  • CONNECTOR_HOLISTIC_STATE_PAUSED: The connector or task has been administratively paused.
  • CONNECTOR_HOLISTIC_STATE_RESTARTING: The connector or task is restarting.
  • CONNECTOR_HOLISTIC_STATE_DESTROYED: The connector is destroyed, regardless of any tasks.
  • CONNECTOR_HOLISTIC_STATE_STOPPED: The connector or task has been stopped.
  • CONNECTOR_HOLISTIC_STATE_UNASSIGNED: - The connector or task has not yet been assigned to a worker,
  • THe connector is running, but there are unassigned tasks.
  • CONNECTOR_HOLISTIC_STATE_HEALTHY: The connector is running, > 0 tasks, all of them in running state.
  • CONNECTOR_HOLISTIC_STATE_UNHEALTHY: - The connector has failed,
  • The connector is running, but has no tasks,
  • Connector is running and has tasks, but all tasks have failed.
  • CONNECTOR_HOLISTIC_STATE_DEGRADED: The connector is running and has tasks, and at least one task, but not all, have failed.
  • CONNECTOR_HOLISTIC_STATE_UNKNOWN: The connector or task state could not be determined.
namestring

Name of connector.

typestring

Type of connector (sink or source).

Changes