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

Create Connector

Description

Create a connector instance

Request

Request

URL

URL


post
https://{api_host}tcsa.host.com/dcc/v1/connectors
Copy

Request Body

Request Body

CreateConnectorRequest of mimetype application/json Required

Create a new connector instance such as kafka connector

{
    "name": "DashboardKafka",
    "targetCluster": {
        "authentication": {},
        "bootstrapServers": "10.168.200.123:9092",
        "tls": {}
    },
    "topics": [
        "vsa_metrics",
        "vsa_events"
    ]
}
array of string
topics Required

Topic names to be replicated


string as ^[A-Za-z]
name Required

Name of the connector should always start with a letter a-z or A-Z


targetCluster Required

Object having details of target kafka cluster and authentication


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.


logging Optional

Logging object containing logging type and logging level

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns object of type application/json

Returns Connector Config for the newly created Connector

{
	"blockId": "kafka-connector",
	"display_name": "Demo_connector",
	"instanceId": "demo-connector",
	"message": "Connector successfully initialized",
	"name": "demo_connector",
	"params": {
		"name": "DashboardKafka",
		"resources": {
			"limits": {
				"cpu": "4",
				"memory": "8Gi"
			},
			"requests": {
				"cpu": "1",
				"memory": "2Gi"
			}
		},
		"targetCluster": {
			"authentication": null,
			"bootstrapServers": "10.168.200.123:9092",
			"tls": null
		},
		"tasksMax": 4,
		"topics": [
			"vsa_metrics",
			"vsa_events"
		]
	},
	"status": "pending",
	"time": "2022-03-25 13:02:21.041469"
}
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 POST -H "Content-Type: application/json" -d '{"CreateConnectorRequest":{"name":"DashboardKafka","resources":{"limits":{"cpu":"4","memory":"8Gi"},"requests":{"cpu":"1","memory":"2Gi"}},"targetCluster":{"authentication":{},"bootstrapServers":"10.168.200.123:9092","tls":{}},"tasksMax":4,"topics":["vsa_metrics","vsa_events"]},"name":"DashboardKafka","replicationFactor":2,"resources":{"limits":{"cpu":"4","memory":"8Gi"},"requests":{"cpu":"1","memory":"2Gi"}},"targetCluster":{"authentication":{},"bootstrapServers":"10.168.200.123:9092","tls":{}},"tasksMax":4,"topics":["vsa_metrics","vsa_events"]}' https://{api_host}tcsa.host.com/dcc/v1/connectors


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

Was this page helpful?