Managed Service for Apache Kafka® API, REST: Connector.get
Returns information about an Apache Kafka® connector.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/connectors/{connectorName}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Apache Kafka® cluster the connector belongs to. To get this ID, make a list request. The maximum string length in characters is 50. |
connectorName | Required. Name of the Apache Kafka® connector to return information about. To get this name, make a list request. The maximum string length in characters is 256. Value must match the regular expression |
Response
HTTP Code: 200 - OK
{
"name": "string",
"tasksMax": "integer",
"properties": "object",
"health": "string",
"status": "string",
"clusterId": "string",
// includes only one of the fields `connectorConfigMirrormaker`, `connectorConfigS3Sink`
"connectorConfigMirrormaker": {
"sourceCluster": {
"alias": "string",
// `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`connectorConfigMirrormaker.sourceCluster`
},
"targetCluster": {
"alias": "string",
// `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`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
}
Field | Description |
---|---|
name | string Name of the connector. |
tasksMax | integer (int64) Maximum number of connector tasks. Default value is the number of brokers. |
properties | object A set of properties passed to Managed Service for Apache Kafka® with the connector configuration. Example: |
health | string Connector health.
|
status | string Current status of the connector.
|
clusterId | string ID of the Apache Kafka® cluster that the connector belongs to. |
connectorConfigMirrormaker | object Configuration of the MirrorMaker connector. includes only one of the fields connectorConfigMirrormaker , connectorConfigS3Sink |
connectorConfigMirrormaker. sourceCluster |
object Source cluster connection configuration. |
connectorConfigMirrormaker. sourceCluster. alias |
string Alias of cluster connection configuration. Examples: |
connectorConfigMirrormaker. sourceCluster. thisCluster |
object Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty. connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster , externalCluster |
connectorConfigMirrormaker. sourceCluster. externalCluster |
object Configuration of connection to an external cluster with all the necessary credentials. connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster , externalCluster |
connectorConfigMirrormaker. sourceCluster. externalCluster. bootstrapServers |
string List of bootstrap servers of the cluster, separated by |
connectorConfigMirrormaker. sourceCluster. externalCluster. saslUsername |
string SASL username to use for connection to the cluster. |
connectorConfigMirrormaker. sourceCluster. externalCluster. saslMechanism |
string SASL mechanism to use for connection to the cluster. |
connectorConfigMirrormaker. sourceCluster. externalCluster. securityProtocol |
string Security protocol to use for connection to the cluster. |
connectorConfigMirrormaker. targetCluster |
object Target cluster connection configuration. |
connectorConfigMirrormaker. targetCluster. alias |
string Alias of cluster connection configuration. Examples: |
connectorConfigMirrormaker. targetCluster. thisCluster |
object Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty. connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster , externalCluster |
connectorConfigMirrormaker. targetCluster. externalCluster |
object Configuration of connection to an external cluster with all the necessary credentials. connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster , externalCluster |
connectorConfigMirrormaker. targetCluster. externalCluster. bootstrapServers |
string List of bootstrap servers of the cluster, separated by |
connectorConfigMirrormaker. targetCluster. externalCluster. saslUsername |
string SASL username to use for connection to the cluster. |
connectorConfigMirrormaker. targetCluster. externalCluster. saslMechanism |
string SASL mechanism to use for connection to the cluster. |
connectorConfigMirrormaker. targetCluster. externalCluster. securityProtocol |
string Security protocol to use for connection to the cluster. |
connectorConfigMirrormaker. topics |
string List of Kafka topics, separated by |
connectorConfigMirrormaker. replicationFactor |
integer (int64) Replication factor for automatically created topics. |
connectorConfigS3Sink | object Configuration of S3-Sink connector. includes only one of the fields connectorConfigMirrormaker , connectorConfigS3Sink |
connectorConfigS3Sink. topics |
string List of Kafka topics, separated by ','. |
connectorConfigS3Sink. fileCompressionType |
string The compression type used for files put on GCS. The supported values are: |
connectorConfigS3Sink. fileMaxRecords |
integer (int64) Max records per file. |
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. |
connectorConfigS3Sink. s3Connection. bucketName |
string |
connectorConfigS3Sink. s3Connection. externalS3 |
object |
connectorConfigS3Sink. s3Connection. externalS3. accessKeyId |
string |
connectorConfigS3Sink. s3Connection. externalS3. endpoint |
string |
connectorConfigS3Sink. s3Connection. externalS3. region |
string Default is 'us-east-1' |