Managed Service for Apache Kafka® API, REST: Connector.list
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",
// `connectors[]` includes only one of the fields `connectorConfigMirrormaker`, `connectorConfigS3Sink`
"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"
},
"connectorConfigS3Sink": {
"topics": "string",
"fileCompressionType": "string",
"fileMaxRecords": "integer",
"s3Connection": {
"bucketName": "string",
"externalS3": {
"accessKeyId": "string",
"endpoint": "string",
"region": "string"
}
}
},
// end of the list of possible fields`connectors[]`
}
],
"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: |
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 Configuration of the MirrorMaker connector. connectors[] includes only one of the fields connectorConfigMirrormaker , connectorConfigS3Sink |
connectors[]. connectorConfigMirrormaker. sourceCluster |
object Source cluster connection configuration. |
connectors[]. connectorConfigMirrormaker. sourceCluster. alias |
string Alias of cluster connection configuration. Examples: |
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: |
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. |
connectors[]. connectorConfigS3Sink |
object Configuration of S3-Sink connector. connectors[] includes only one of the fields connectorConfigMirrormaker , connectorConfigS3Sink |
connectors[]. connectorConfigS3Sink. topics |
string List of Kafka topics, separated by ','. |
connectors[]. connectorConfigS3Sink. fileCompressionType |
string The compression type used for files put on GCS. The supported values are: |
connectors[]. connectorConfigS3Sink. fileMaxRecords |
integer (int64) Max records per file. |
connectors[]. connectorConfigS3Sink. s3Connection |
object Credentials for connecting to S3 storage. 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. |
connectors[]. connectorConfigS3Sink. s3Connection. bucketName |
string |
connectors[]. connectorConfigS3Sink. s3Connection. externalS3 |
object |
connectors[]. connectorConfigS3Sink. s3Connection. externalS3. accessKeyId |
string |
connectors[]. connectorConfigS3Sink. s3Connection. externalS3. endpoint |
string |
connectors[]. connectorConfigS3Sink. s3Connection. externalS3. region |
string Default is 'us-east-1' |
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. |