Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Managed Service for Apache Kafka®
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к кластеру
    • Остановка и запуск кластера
    • Обновление версии Apache Kafka®
    • Изменение настроек кластера
    • Управление хостами Apache Kafka®
    • Работа с топиками и разделами
    • Управление учетными записями Kafka
    • Управление коннекторами
    • Просмотр логов кластера
    • Удаление кластера
    • Мониторинг состояния кластера и хостов
  • Практические руководства
    • Все руководства
    • Поставка данных в Managed Service for ClickHouse
    • Настройка Kafka Connect для работы с Managed Service for Apache Kafka®
    • Поставка данных в ksqlDB
    • Использование схем формата данных с Managed Service for Apache Kafka®
      • Обзор
      • Работа с управляемым реестром схем формата данных
      • Работа с реестром схем формата данных Confluent
    • Миграция данных в Managed Service for Apache Kafka®
    • Поставка данных с помощью Debezium
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Топики и разделы
    • Брокеры
    • Производители и потребители
    • Управление схемами данных
    • Классы хостов
    • Сеть в Managed Service for Apache Kafka®
    • Квоты и лимиты
    • Типы хранилища
    • Коннекторы
    • Техническое обслуживание
    • Настройки Apache Kafka®
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в 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
  • История изменений
  • Вопросы и ответы
  1. Справочник API
  2. REST (англ.)
  3. Connector
  4. list

Method list

Статья создана
Yandex.Cloud
  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Retrieves the list of Apache Kafka Connector resources in the specified 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 the cluster ID use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum value is 1000.
pageToken Page token. To get the next page of results, Set pageToken to the nextPageToken returned by a 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

An Apache Kafka® connector resource.

connectors[].
name
string

Name of the connector.

connectors[].
tasksMax
integer (int64)

Maximum number of tasks. Default is the number of brokers

connectors[].
properties
object

Properties passed with connector config to Connect service Example: 'sync.topics.config.enabled: true'

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

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

connectors[].
connectorConfigMirrormaker
object

An An Apache Kafka® MirrorMaker connector resource.

connectors[].
connectorConfigMirrormaker.
sourceCluster
object

Source cluster resource settings.

Resource ClusterConnection - settings of connection to clusters, that are source or target of MirrorMaker clusters.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
alias
string

Alias of ClusterConnection resource. For example: 'source', 'target', ...

connectors[].
connectorConfigMirrormaker.
sourceCluster.
thisCluster
object
If type is 'this_cluster' - we connect to cluster that is handle Kafka Connect Worker, on which we try to register connector.
connectors[].connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster

Resource of cluster_connection type 'this_cluster'.

connectors[].
connectorConfigMirrormaker.
sourceCluster.
externalCluster
object
If type is 'external_cluster' - we connect to cluster that is not handle Kafka Connect Worker, on which we try to register connector.
connectors[].connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster

Resource of connection to external cluster. It contains all settings of connection to external cluster.

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

List bootstrap servers of cluster, separated by ','

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

Sasl username which we use to connect to cluster.

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

Sasl mechanism, which we should use to connect to cluster.

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

Security protocol, which we should use to connect to cluster.

connectors[].
connectorConfigMirrormaker.
targetCluster
object

Target cluster resource settings.

Resource ClusterConnection - settings of connection to clusters, that are source or target of MirrorMaker clusters.

connectors[].
connectorConfigMirrormaker.
targetCluster.
alias
string

Alias of ClusterConnection resource. For example: 'source', 'target', ...

connectors[].
connectorConfigMirrormaker.
targetCluster.
thisCluster
object
If type is 'this_cluster' - we connect to cluster that is handle Kafka Connect Worker, on which we try to register connector.
connectors[].connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster

Resource of cluster_connection type 'this_cluster'.

connectors[].
connectorConfigMirrormaker.
targetCluster.
externalCluster
object
If type is 'external_cluster' - we connect to cluster that is not handle Kafka Connect Worker, on which we try to register connector.
connectors[].connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster

Resource of connection to external cluster. It contains all settings of connection to external cluster.

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

List bootstrap servers of cluster, separated by ','

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

Sasl username which we use to connect to cluster.

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

Sasl mechanism, which we should use to connect to cluster.

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

Security protocol, which we should use to connect to cluster.

connectors[].
connectorConfigMirrormaker.
topics
string

List of Kafka topics, separated by ','

connectors[].
connectorConfigMirrormaker.
replicationFactor
integer (int64)

Replication factor for automatically created topics.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response