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

Get Connector Instance

Description

Get connector instance details

Request

Request

URL

URL


get
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


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns GetConnectorResponse of type application/json

Returns the connector details

{
	"display_name": "DashboardKafka",
	"logging": {
		"level": "INFO",
		"type": "inline"
	},
	"message": null,
	"name": "dashboardkafka",
	"paused": false,
	"reason": null,
	"refreshInterval": 60,
	"replicationFactor": 1,
	"resources": {
		"limits": {
			"cpu": "4000m",
			"memory": "8192Mi"
		},
		"requests": {
			"cpu": "1000m",
			"memory": "2048Mi"
		}
	},
	"status": "Running",
	"targetCluster": {
		"authentication": {
			"enabled": false
		},
		"bootstrapServers": "10.168.200.123:9092",
		"tls": {
			"enabled": false
		}
	},
	"tasksMax": 4,
	"topics": [
		"vsa_metrics",
		"vsa_events"
	]
}
string as ^[A-Za-z]
display_name Required

Display name of the connector instance which was provided as input parameter in create request


string
message Required

Error message if the connector status is failed


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

Name of the connector instance


boolean
paused Required

Whether the connector instance is paused.


string
reason Required

Reason of failure if Status is failed


string
status Required

Connector instance status - Running/Stopped/Failed/Pending


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.

Errors

Errors

object
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 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?