Managed Service for Apache Kafka® API, gRPC: ConnectorService.List

Статья создана

Yandex Cloud

Обновлена 3 августа 2026 г.

Открыть в Markdown

gRPC request
ListConnectorsRequest
ListConnectorsResponse
Connector
ConnectorPlacement
ConnectorConfigMirrorMaker
ClusterConnection
ThisCluster
ExternalClusterConnection
ConnectorConfigS3Sink
S3Connection
ExternalS3Storage
ConnectorConfigIcebergSink
MetastoreConnection
IcebergS3Connection
ExternalIcebergS3Storage
StaticTables
DynamicTables
IcebergTablesConfig
IcebergControl

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

gRPC request

rpc List (ListConnectorsRequest) returns (ListConnectorsResponse)

ListConnectorsRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field	Description
cluster_id	string Required field. ID of the Apache Kafka® cluster to list connectors in. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the API returns a ListConnectorsResponse.next_page_token that can be used to get the next page of results in the subsequent ConnectorService.List requests. The maximum value is 1000.
page_token	string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set `page_token` to the ListConnectorsResponse.next_page_token returned by the previous ConnectorService.List request. The maximum string length in characters is 100.

ListConnectorsResponse

{
  "connectors": [
    {
      "name": "string",
      "tasks_max": "google.protobuf.Int64Value",
      "properties": "map<string, string>",
      "health": "Health",
      "status": "Status",
      "cluster_id": "string",
      "placement": {
        "dedicated": "bool"
      },
      // Includes only one of the fields `connector_config_mirrormaker`, `connector_config_s3_sink`, `connector_config_iceberg_sink`
      "connector_config_mirrormaker": {
        "source_cluster": {
          "alias": "string",
          // Includes only one of the fields `this_cluster`, `external_cluster`
          "this_cluster": "ThisCluster",
          "external_cluster": {
            "bootstrap_servers": "string",
            "sasl_username": "string",
            "sasl_mechanism": "string",
            "security_protocol": "string"
          }
          // end of the list of possible fields
        },
        "target_cluster": {
          "alias": "string",
          // Includes only one of the fields `this_cluster`, `external_cluster`
          "this_cluster": "ThisCluster",
          "external_cluster": {
            "bootstrap_servers": "string",
            "sasl_username": "string",
            "sasl_mechanism": "string",
            "security_protocol": "string"
          }
          // end of the list of possible fields
        },
        "topics": "string",
        "replication_factor": "google.protobuf.Int64Value"
      },
      "connector_config_s3_sink": {
        "topics": "string",
        "file_compression_type": "string",
        "file_max_records": "google.protobuf.Int64Value",
        "s3_connection": {
          "bucket_name": "string",
          // Includes only one of the fields `external_s3`
          "external_s3": {
            "access_key_id": "string",
            "endpoint": "string",
            "region": "string"
          }
          // end of the list of possible fields
        }
      },
      "connector_config_iceberg_sink": {
        // Includes only one of the fields `topics`, `topics_regex`
        "topics": "string",
        "topics_regex": "string",
        // end of the list of possible fields
        "control_topic": "string",
        "metastore_connection": {
          "catalog_uri": "string",
          "warehouse": "string"
        },
        "s3_connection": {
          // Includes only one of the fields `external_s3`
          "external_s3": {
            "access_key_id": "string",
            "endpoint": "string",
            "region": "string"
          }
          // end of the list of possible fields
        },
        // Includes only one of the fields `static_tables`, `dynamic_tables`
        "static_tables": {
          "tables": "string"
        },
        "dynamic_tables": {
          "route_field": "string"
        },
        // end of the list of possible fields
        "tables_config": {
          "default_commit_branch": "string",
          "default_id_columns": "string",
          "default_partition_by": "string",
          "evolve_schema_enabled": "bool",
          "schema_force_optional": "bool",
          "schema_case_insensitive": "bool"
        },
        "control_config": {
          "group_id_prefix": "string",
          "commit_interval_ms": "google.protobuf.Int64Value",
          "commit_timeout_ms": "google.protobuf.Int64Value",
          "commit_threads": "google.protobuf.Int64Value",
          "transactional_prefix": "string"
        }
      }
      // end of the list of possible fields
    }
  ],
  "next_page_token": "string"
}

Field

Description

connectors[]

Connector

List of Apache Kafka® Connectors.

next_page_token

string

The token that can be used to get the next page of results.
If the number of results is larger than ListConnectorsRequest.page_size, use the next_page_token as the value for the ListConnectorsRequest.page_token in the subsequent ConnectorService.List request to iterate through multiple pages of results.

Connector

Field	Description
name	string Name of the connector.
tasks_max	google.protobuf.Int64Value Maximum number of connector tasks. Default value is the number of brokers.
properties	object (map<string, string>) A set of properties passed to Managed Service for Apache Kafka® with the connector configuration. Example: `sync.topics.config.enabled: true`.
health	enum Health Connector health. `HEALTH_UNKNOWN`: Health of the connector is unknown. `ALIVE`: Connector is running. `DEAD`: Connector has failed to start.
status	enum Status 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.
cluster_id	string ID of the Apache Kafka® cluster that the connector belongs to.
placement	ConnectorPlacement Placement of the connector workers.
connector_config_mirrormaker	ConnectorConfigMirrorMaker Configuration of the MirrorMaker connector. Includes only one of the fields `connector_config_mirrormaker`, `connector_config_s3_sink`, `connector_config_iceberg_sink`. Additional settings for the connector.
connector_config_s3_sink	ConnectorConfigS3Sink Configuration of S3-Sink connector. Includes only one of the fields `connector_config_mirrormaker`, `connector_config_s3_sink`, `connector_config_iceberg_sink`. Additional settings for the connector.
connector_config_iceberg_sink	ConnectorConfigIcebergSink Configuration of Iceberg Sink connector. Includes only one of the fields `connector_config_mirrormaker`, `connector_config_s3_sink`, `connector_config_iceberg_sink`. Additional settings for the connector.

ConnectorPlacement

Connector worker placement.
By default, workers run on Kafka broker hosts.

Field

Description

dedicated

bool

Run workers on dedicated nodes instead of broker hosts.

ConnectorConfigMirrorMaker

Field	Description
source_cluster	ClusterConnection Source cluster connection configuration.
target_cluster	ClusterConnection Target cluster connection configuration.
topics	string List of Kafka topics, separated by `,`.
replication_factor	google.protobuf.Int64Value Replication factor for automatically created topics.

ClusterConnection

Field	Description
alias	string Alias of cluster connection configuration. Examples: `source`, `target`.
this_cluster	ThisCluster Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty. Includes only one of the fields `this_cluster`, `external_cluster`. Type of connection to Apache Kafka® cluster.
external_cluster	ExternalClusterConnection Configuration of connection to an external cluster with all the necessary credentials. Includes only one of the fields `this_cluster`, `external_cluster`. Type of connection to Apache Kafka® cluster.

ThisCluster

Field	Description
Empty

ExternalClusterConnection

Field	Description
bootstrap_servers	string List of bootstrap servers of the cluster, separated by `,`.
sasl_username	string SASL username to use for connection to the cluster.
sasl_mechanism	string SASL mechanism to use for connection to the cluster.
security_protocol	string Security protocol to use for connection to the cluster.

ConnectorConfigS3Sink

An Apache Kafka® S3-Sink
connector resource.

Field	Description
topics	string List of Kafka topics, separated by ','.
file_compression_type	string The compression type used for files put on GCS. The supported values are: `gzip`, `snappy`, `zstd`, `none`. Optional, the default is `none`.
file_max_records	google.protobuf.Int64Value Max records per file.
s3_connection	S3Connection Credentials for connecting to S3 storage.

S3Connection

Resource for S3Connection -
settings of connection to AWS-compatible S3 storage, that
are source or target of Kafka S3-connectors.
YC Object Storage is AWS-compatible.

Field

Description

bucket_name

string

Name of the bucket.

external_s3

ExternalS3Storage

Configuration for connection to S3 storage.

Includes only one of the fields external_s3.

ExternalS3Storage

Field	Description
access_key_id	string ID of the AWS access key.
endpoint	string S3 endpoint.
region	string AWS region. Default is 'us-east-1'.

ConnectorConfigIcebergSink

Resource for Kafka Iceberg Sink Connector.

Field	Description
topics	string List of Kafka topics, separated by ','. Includes only one of the fields `topics`, `topics_regex`.
topics_regex	string Regex of Kafka topics. Includes only one of the fields `topics`, `topics_regex`.
control_topic	string Control topic name for Iceberg connector.
metastore_connection	MetastoreConnection Credentials for connecting to Managed Hive Metastore.
s3_connection	IcebergS3Connection Credentials for connecting to S3 storage.
static_tables	StaticTables Static table routing Includes only one of the fields `static_tables`, `dynamic_tables`. Table routing strategy
dynamic_tables	DynamicTables Dynamic table routing Includes only one of the fields `static_tables`, `dynamic_tables`. Table routing strategy
tables_config	IcebergTablesConfig Optional table settings
control_config	IcebergControl Optional control settings

MetastoreConnection

Field

Description

catalog_uri

string

Thrift URI of Hive Metastore
Format: "thrift://host:9083"

warehouse

string

Warehouse root directory in S3
Format: "s3a://bucket-name/path/to/warehouse"
Can be any path within the bucket, not necessarily "/warehouse"

IcebergS3Connection

Resource for IcebergS3Connection -
settings of connection to AWS-compatible S3 storage, that
are target of Kafka Iceberg-connectors.
YC Object Storage is AWS-compatible.

Field

Description

external_s3

ExternalIcebergS3Storage

Configuration for connection to S3 storage.

Includes only one of the fields external_s3.

ExternalIcebergS3Storage

Field	Description
access_key_id	string ID of the AWS access key.
endpoint	string S3 endpoint.
region	string AWS region. Default is 'us-east-1'.

StaticTables

Field

Description

tables

string

List of tables, separated by ','.

DynamicTables

Field

Description

route_field

string

Field in the message to define the target table
The iceberg.tables.dynamic-enabled field is set to true

IcebergTablesConfig

Field	Description
default_commit_branch	string Default Git-like branch name for Iceberg commits. Default: "main"
default_id_columns	string List of columns used as identifiers for upsert operations, separated by ','.
default_partition_by	string Comma-separated list of columns or transform expressions for table partitioning. Defines physical data layout for query optimization. Examples: "date" "year,month" "year(timestamp),month(timestamp)" "days(timestamp)" "bucket(16,user_id)"
evolve_schema_enabled	bool Enable automatic schema evolution. Default: false
schema_force_optional	bool Force all columns to be nullable (optional). Default: false
schema_case_insensitive	bool Enable case-insensitive field name matching. Default: false

IcebergControl

Field	Description
group_id_prefix	string Consumer group ID prefix for control topic. Default: "cg-control"
commit_interval_ms	google.protobuf.Int64Value Interval between commits in milliseconds. Default: 300000 (5 minutes)
commit_timeout_ms	google.protobuf.Int64Value Commit operation timeout in milliseconds. Default: 30000 (30 seconds)
commit_threads	google.protobuf.Int64Value Number of threads for commit operations. Default: cores * 2
transactional_prefix	string Prefix for transactional operations. Default: ""

Managed Service for Apache Kafka® API, gRPC: ConnectorService.List

gRPC requestgRPC request

ListConnectorsRequestListConnectorsRequest

ListConnectorsResponseListConnectorsResponse

ConnectorConnector

ConnectorPlacementConnectorPlacement

ConnectorConfigMirrorMakerConnectorConfigMirrorMaker

ClusterConnectionClusterConnection

ThisClusterThisCluster

ExternalClusterConnectionExternalClusterConnection

ConnectorConfigS3SinkConnectorConfigS3Sink

S3ConnectionS3Connection

ExternalS3StorageExternalS3Storage

ConnectorConfigIcebergSinkConnectorConfigIcebergSink

MetastoreConnectionMetastoreConnection

IcebergS3ConnectionIcebergS3Connection

ExternalIcebergS3StorageExternalIcebergS3Storage

StaticTablesStaticTables

DynamicTablesDynamicTables

IcebergTablesConfigIcebergTablesConfig

IcebergControlIcebergControl

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

gRPC request

ListConnectorsRequest

ListConnectorsResponse

Connector

ConnectorPlacement

ConnectorConfigMirrorMaker

ClusterConnection

ThisCluster

ExternalClusterConnection

ConnectorConfigS3Sink

S3Connection

ExternalS3Storage

ConnectorConfigIcebergSink

MetastoreConnection

IcebergS3Connection

ExternalIcebergS3Storage

StaticTables

DynamicTables

IcebergTablesConfig

IcebergControl