Get Connector Instance

Get connector instance details

Request

URI

GET

https://{api_host}/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.

string

status

Required

Connector instance status - Running/Stopped/Failed/Pending

string

reason

Required

Reason of failure if Status is failed

string

message

Required

Error message if the connector status is failed

number

tasksMax

Optional

Constraints: default: 4

The maximum number of tasks for the Kafka Connector.

number

replicationFactor

Optional

Constraints: default: 1

Replication factor for the internal topics and replicated topics.

array of string

topics

Required

Topic names to be replicated

object

targetCluster

Required

Object having details of target kafka cluster and authentication

object

logging

Optional

Logging object containing logging type and logging level

object

resources

Optional

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

400

Invalid Request sent by the user