Get Connector Instance

Get connector instance details

Request

URI

GET

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

COPY

Path Parameters

string

connector-name

Required

Instance id of the connector

connector-name example

demo-connector

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns the connector details

Returns GetConnectorResponse of type(s) application/json

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

string As ^[A-Za-z]

name

Required

Name of the connector instance

string As ^[A-Za-z]

display_name

Required

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

boolean

paused

Required

Whether the connector instance is paused.