Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Managed Service for Apache Kafka®
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Information about existing clusters
    • Creating clusters
    • Connecting to a cluster
    • Stopping and starting clusters
    • Upgrading the Apache Kafka® version
    • Changing cluster settings
    • Managing Apache Kafka® hosts
    • Working with topics and partitions
    • Managing Apache Kafka® users
    • Managing connectors
    • Viewing cluster logs
    • Deleting clusters
    • Monitoring the state of clusters and hosts
  • Practical guidelines
    • All tutorials
    • Setting up Kafka Connect to work with Managed Service for Apache Kafka®
    • Using data format schemas with Managed Service for Apache Kafka®
      • Overview
      • Working with the managed schema registry
      • Using Confluent Schema Registry with Managed Service for Apache Kafka®
    • Migrating databases from a third-party Apache Kafka® cluster
    • Moving data between Managed Service for Apache Kafka® clusters using Yandex Data Transfer
    • Delivering data from Managed Service for Apache Kafka® using Debezium
    • Delivering data from Yandex Managed Service for MySQL using Debezium
    • Delivering data from Managed Service for Apache Kafka® with Yandex Data Transfer
    • Delivering data to Managed Service for ClickHouse
    • Data delivery in ksqlDB
    • Delivering data to Yandex Managed Service for YDB using Yandex Data Transfer
  • Concepts
    • Relationships between service resources
    • Topics and partitions
    • Brokers
    • Producers and consumers
    • Managing data schemas
    • Host classes
    • Network in Managed Service for Apache Kafka®
    • Quotas and limits
    • Disk types
    • Connectors
    • Maintenance
    • Apache Kafka® settings
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the 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
  • Revision history
  • Questions and answers
  1. API reference
  2. REST
  3. Connector
  4. update

Managed Service for Apache Kafka® API, REST: Connector.update

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Body parameters
  • Response

Updates an Apache Kafka® connector.

HTTP request

PATCH 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 to update the connector in.

To get this ID, make a list request.

The maximum string length in characters is 50.

connectorName

Required. Name of the connector to update.

To get this name, make a list request.

The maximum string length in characters is 256. Value must match the regular expression [a-zA-Z0-9_-]*.

Body parameters

{
  "updateMask": "string",
  "connectorSpec": {
    "tasksMax": "integer",
    "properties": "object",

    // `connectorSpec` includes only one of the fields `connectorConfigMirrormaker`, `connectorConfigS3Sink`
    "connectorConfigMirrormaker": {
      "sourceCluster": {
        "alias": "string",

        // `connectorSpec.connectorConfigMirrormaker.sourceCluster` includes only one of the fields `thisCluster`, `externalCluster`
        "thisCluster": {},
        "externalCluster": {
          "bootstrapServers": "string",
          "saslUsername": "string",
          "saslPassword": "string",
          "saslMechanism": "string",
          "securityProtocol": "string",
          "sslTruststoreCertificates": "string"
        },
        // end of the list of possible fields`connectorSpec.connectorConfigMirrormaker.sourceCluster`

      },
      "targetCluster": {
        "alias": "string",

        // `connectorSpec.connectorConfigMirrormaker.targetCluster` includes only one of the fields `thisCluster`, `externalCluster`
        "thisCluster": {},
        "externalCluster": {
          "bootstrapServers": "string",
          "saslUsername": "string",
          "saslPassword": "string",
          "saslMechanism": "string",
          "securityProtocol": "string",
          "sslTruststoreCertificates": "string"
        },
        // end of the list of possible fields`connectorSpec.connectorConfigMirrormaker.targetCluster`

      },
      "topics": "string",
      "replicationFactor": "integer"
    },
    "connectorConfigS3Sink": {
      "topics": "string",
      "fileMaxRecords": "integer",
      "s3Connection": {
        "bucketName": "string",
        "externalS3": {
          "accessKeyId": "string",
          "secretAccessKey": "string",
          "endpoint": "string",
          "region": "string"
        }
      }
    },
    // end of the list of possible fields`connectorSpec`

  }
}
Field Description
updateMask string

Field mask that specifies which settings of the connector should be updated.

A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.

connectorSpec object

Required. Configuration of the connector to update.

connectorSpec.
tasksMax
integer (int64)

Maximum number of connector tasks to update.

connectorSpec.
properties
object

A set of new or changed properties to update for the connector. They are passed with the connector configuration to Managed Service for Apache Kafka®. Example: sync.topics.config.enabled: false.

connectorSpec.
connectorConfigMirrormaker
object
Configuration of the MirrorMaker connector.
connectorSpec includes only one of the fields connectorConfigMirrormaker, connectorConfigS3Sink
connectorSpec.
connectorConfigMirrormaker.
sourceCluster
object

Source cluster configuration for the MirrorMaker connector.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
alias
string

Alias of cluster connection configuration. Examples: source, target.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
thisCluster
object
Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
connectorSpec.connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster
connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster
object
Configuration of connection to an external cluster with all the necessary credentials.
connectorSpec.connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster
connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
bootstrapServers
string

List of bootstrap servers of the cluster, separated by ,.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslUsername
string

SASL username to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslPassword
string

SASL password to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslMechanism
string

SASL mechanism to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
securityProtocol
string

Security protocol to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
sslTruststoreCertificates
string

CA in PEM format to connect to external cluster. Lines of certificate separated by '\n' symbol.

connectorSpec.
connectorConfigMirrormaker.
targetCluster
object

Target cluster configuration for the MirrorMaker connector.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
alias
string

Alias of cluster connection configuration. Examples: source, target.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
thisCluster
object
Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
connectorSpec.connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster
connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster
object
Configuration of connection to an external cluster with all the necessary credentials.
connectorSpec.connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster
connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
bootstrapServers
string

List of bootstrap servers of the cluster, separated by ,.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslUsername
string

SASL username to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslPassword
string

SASL password to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslMechanism
string

SASL mechanism to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
securityProtocol
string

Security protocol to use for connection to the cluster.

connectorSpec.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
sslTruststoreCertificates
string

CA in PEM format to connect to external cluster. Lines of certificate separated by '\n' symbol.

connectorSpec.
connectorConfigMirrormaker.
topics
string

List of Kafka topics, separated by ,.

connectorSpec.
connectorConfigMirrormaker.
replicationFactor
integer (int64)

Replication factor for automatically created topics.

connectorSpec.
connectorConfigS3Sink
object
Update specification for S3-Sink Connector.
connectorSpec includes only one of the fields connectorConfigMirrormaker, connectorConfigS3Sink
connectorSpec.
connectorConfigS3Sink.
topics
string

List of Kafka topics, separated by ','.

connectorSpec.
connectorConfigS3Sink.
fileMaxRecords
integer (int64)

Max records per file.

connectorSpec.
connectorConfigS3Sink.
s3Connection
object

Credentials for connecting to S3 storage.

Specification 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.

connectorSpec.
connectorConfigS3Sink.
s3Connection.
bucketName
string
connectorSpec.
connectorConfigS3Sink.
s3Connection.
externalS3
object
connectorSpec.
connectorConfigS3Sink.
s3Connection.
externalS3.
accessKeyId
string
connectorSpec.
connectorConfigS3Sink.
s3Connection.
externalS3.
secretAccessKey
string
connectorSpec.
connectorConfigS3Sink.
s3Connection.
externalS3.
endpoint
string
connectorSpec.
connectorConfigS3Sink.
s3Connection.
externalS3.
region
string

Default is 'us-east-1'.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy string

ID of the user or service account who initiated the operation.

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Body parameters
  • Response