Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Managed Service for Apache Kafka®
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Information about existing clusters
    • Creating clusters
    • Connecting to a cluster
    • Stopping and starting clusters
    • Upgrading the Apache Kafka® version
    • Changing cluster settings
    • Managing Apache Kafka® hosts
    • Working with topics and partitions
    • Managing Kafka accounts
    • Managing connectors
    • Viewing cluster logs
    • Deleting clusters
    • Monitoring the state of clusters and hosts
  • Practical guidelines
    • All tutorials
    • Data delivery in Managed Service for ClickHouse
    • Configuring Kafka Connect for Managed Service for Apache Kafka®
    • Data delivery in ksqlDB
    • Using schema registries with Managed Service for Apache Kafka®
      • Overview
      • Working with the managed schema registry
      • Working with Confluent Schema Registry
    • Delivering data using Debezium
  • Concepts
    • Relationships between service resources
    • Topics and partitions
    • Brokers
    • Producers and consumers
    • Managing data schemas
    • Host classes
    • Network in Managed Service for Apache Kafka®
    • Quotas and limits
    • Storage types
    • Connectors
    • Maintenance
    • Apache Kafka® settings
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ClusterService
      • ConnectorService
      • ResourcePresetService
      • TopicService
      • UserService
      • OperationService
    • REST
      • Overview
      • Cluster
        • Overview
        • create
        • delete
        • get
        • list
        • listHosts
        • listLogs
        • listOperations
        • move
        • rescheduleMaintenance
        • start
        • stop
        • streamLogs
        • update
      • Connector
        • Overview
        • create
        • delete
        • get
        • list
        • pause
        • resume
        • update
      • ResourcePreset
        • Overview
        • get
        • list
      • Topic
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Operation
        • Overview
        • get
  • Revision history
  • Questions and answers
  1. API reference
  2. REST
  3. Connector
  4. list

Method list

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Retrieves the list of Apache Kafka® connectors in a cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/connectors

Path parameters

Parameter Description
clusterId Required. ID of the Apache Kafka® cluster to list connectors in. To get this ID, make a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the API returns a nextPageToken that can be used to get the next page of results in the subsequent list requests. The maximum value is 1000.
pageToken Page token that can be used to iterate through multiple pages of results. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "connectors": [
    {
      "name": "string",
      "tasksMax": "integer",
      "properties": "object",
      "health": "string",
      "status": "string",
      "clusterId": "string",
      "connectorConfigMirrormaker": {
        "sourceCluster": {
          "alias": "string",

          // `connectors[].connectorConfigMirrormaker.sourceCluster` includes only one of the fields `thisCluster`, `externalCluster`
          "thisCluster": {},
          "externalCluster": {
            "bootstrapServers": "string",
            "saslUsername": "string",
            "saslMechanism": "string",
            "securityProtocol": "string"
          },
          // end of the list of possible fields`connectors[].connectorConfigMirrormaker.sourceCluster`

        },
        "targetCluster": {
          "alias": "string",

          // `connectors[].connectorConfigMirrormaker.targetCluster` includes only one of the fields `thisCluster`, `externalCluster`
          "thisCluster": {},
          "externalCluster": {
            "bootstrapServers": "string",
            "saslUsername": "string",
            "saslMechanism": "string",
            "securityProtocol": "string"
          },
          // end of the list of possible fields`connectors[].connectorConfigMirrormaker.targetCluster`

        },
        "topics": "string",
        "replicationFactor": "integer"
      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
connectors[] object

List of Apache Kafka® Connectors.

connectors[].
name
string

Name of the connector.

connectors[].
tasksMax
integer (int64)

Maximum number of connector tasks. Default value is the number of brokers.

connectors[].
properties
object

A set of properties passed to Managed Service for Apache Kafka® with the connector configuration. Example: sync.topics.config.enabled: true.

connectors[].
health
string
Connector health.
  • HEALTH_UNKNOWN: Health of the connector is unknown.
  • ALIVE: Connector is running.
  • DEAD: Connector has failed to start.
connectors[].
status
string
Current status of the connector.
  • STATUS_UNKNOWN: Connector state is unknown.
  • RUNNING: Connector is running normally.
  • ERROR: Connector has encountered a problem and cannot operate.
  • PAUSED: Connector is paused.
connectors[].
clusterId
string

ID of the Apache Kafka® cluster that the connector belongs to.

connectors[].
connectorConfigMirrormaker
object
Configuration of the MirrorMaker connector.
connectors[].
connectorConfigMirrormaker.
sourceCluster
object

Source cluster connection configuration.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
alias
string

Alias of cluster connection configuration. Examples: source, target.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
thisCluster
object
Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
connectors[].connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster

connectors[].
connectorConfigMirrormaker.
sourceCluster.
externalCluster
object
Configuration of connection to an external cluster with all the necessary credentials.
connectors[].connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster

connectors[].
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
bootstrapServers
string

List of bootstrap servers of the cluster, separated by ,.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslUsername
string

SASL username to use for connection to the cluster.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslMechanism
string

SASL mechanism to use for connection to the cluster.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
securityProtocol
string

Security protocol to use for connection to the cluster.

connectors[].
connectorConfigMirrormaker.
targetCluster
object

Target cluster connection configuration.

connectors[].
connectorConfigMirrormaker.
targetCluster.
alias
string

Alias of cluster connection configuration. Examples: source, target.

connectors[].
connectorConfigMirrormaker.
targetCluster.
thisCluster
object
Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
connectors[].connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster

connectors[].
connectorConfigMirrormaker.
targetCluster.
externalCluster
object
Configuration of connection to an external cluster with all the necessary credentials.
connectors[].connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster

connectors[].
connectorConfigMirrormaker.
targetCluster.
externalCluster.
bootstrapServers
string

List of bootstrap servers of the cluster, separated by ,.

connectors[].
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslUsername
string

SASL username to use for connection to the cluster.

connectors[].
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslMechanism
string

SASL mechanism to use for connection to the cluster.

connectors[].
connectorConfigMirrormaker.
targetCluster.
externalCluster.
securityProtocol
string

Security protocol to use for connection to the cluster.

connectors[].
connectorConfigMirrormaker.
topics
string

List of Kafka topics, separated by ,.

connectors[].
connectorConfigMirrormaker.
replicationFactor
integer (int64)

Replication factor for automatically created topics.

nextPageToken string

The token that can be used to get the next page of results.

If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken in the subsequent list request to iterate through multiple pages of results.

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response