[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

Update Connector Instance

Description

Update the Connector Configuration e.g. number of tasks replicationFactor, add remove topics for replication

Request

Request

URL

URL


put
https://{api_host}tcsa.host.com/dcc/v1/connectors/{connector-name}
Copy

Path Parameters

Path Parameters

string
connector-name Required

Instance id of the connector


Request Body

Request Body

UpdateConnectorRequest of mimetype application/json Required

Update the Connector Configuration e.g. number of tasks replicationFactor, add remove topics for replication

{}
targetCluster Required

Object having details of target kafka cluster and authentication


array of string
topics Required

Topic names to be replicated


logging Optional

Logging object containing logging type and logging level


number
replicationFactor Optional

Replication factor for the internal topics and replicated topics.


resources Optional

Maximum limits for CPU and memory resources and the requested initial resources.


number
tasksMax Optional

The maximum number of tasks for the Kafka Connector.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns object of type application/json

Returns the Config for updated connector

{
	"display_name": "DashboardKafka",
	"instanceId": "dashboardkafka",
	"message": "Connector successfully updated",
	"name": "dashboardkafka",
	"status": "pending",
	"time": "2022-03-29 10:08:55.346489"
}
Errors

Errors

400

Invalid Request sent by the user


401

User authentication failed


403

Access to the requested resource/operation is forbidden


404

Cannot find requested resource


500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"replicationFactor":2,"tasksMax":6}' https://{api_host}tcsa.host.com/dcc/v1/connectors/{connector-name}


[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Feedback

Was this page helpful?