Method list
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.
|
connectors[]. status |
string Current status of the connector.
|
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. |