Get Collector

Get Collector

Get block config and Get configurations for an installed module and instance

Request
URI
GET
https://{api_host}/dcc/v1/collectors/{collector-name}
COPY
Path Parameters
string
collector-name
Required

id of the instantiated collector

collector-name example
demo-collector

Authentication
This operation uses the following authentication methods.
Responses
200

Returns the Configurations

Returns CollectorDefaultBlockConfig of type(s) application/json
{
    "source": {
        "topic": "input_metrics",
        "type": "json_metrics",
        "mapping": {
            "type": "Kafka-Collector",
            "instance": "$.properties.source",
            "timestamp": "$.timestamp",
            "processedTimestamp": "$.timestamp",
            "metrics": "$.metrics.*.value",
            "metricType": "$.properties.devtype",
            "properties.dataSource": "$.properties.ip",
            "properties.deviceType": "$.properties.devtype",
            "properties.deviceName": "$.properties.devdesc",
            "properties.entityType": "$.properties.type",
            "properties.entityName": "$.properties.table",
            "tags": "$.relations.*.type"
        },
        "properties": {
            "bootstrap.servers": "edge-kafka-bootstrap:9093",
            "application.id": "omega-kafka-collector",
            "auto.offset.reset": "earliest",
            "group.id": "omega-consumer-group",
            "key.deserializer": "org.apache.kafka.common.serialization.StringDeserializer",
            "value.deserializer": "org.apache.kafka.common.serialization.StringDeserializer"
        }
    },
    "sink": {
        "topic": "output-events",
        "properties": {
            "bootstrap.servers": "edge-kafka-bootstrap:9093"
        }
    },
    "Resources": {
        "requests": {
            "cpu": "1",
            "memory": "2Gi"
        },
        "limits": {
            "cpu": "4",
            "memory": "8Gi"
        }
    }
}
object
source
Required

Source cluster details e.g. source topic name , mapping name etc.

object
sink
Required

Target kafka cluster topic name


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/dcc/v1/collectors/{collector-name}