[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Get Collector
DescriptionGet block config and Get configurations for an installed module and instance
Request
URLURL
https://{api_host}tcsa.host.com/dcc/v1/collectors/{collector-name}
Path Parameters
Path Parameters
string
collector-name
Required
id of the instantiated collector
collector-name example
"demo-collector"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
CollectorDefaultBlockConfig
of type application/json
Returns the Configurations
{
"Resources": {
"limits": {
"cpu": "4",
"memory": "8Gi"
},
"requests": {
"cpu": "1",
"memory": "2Gi"
}
},
"sink": {
"properties": {
"bootstrap.servers": "edge-kafka-bootstrap:9093"
},
"topic": "output-events"
},
"source": {
"mapping": {
"instance": "$.properties.source",
"metricType": "$.properties.devtype",
"metrics": "$.metrics.*.value",
"processedTimestamp": "$.timestamp",
"properties.dataSource": "$.properties.ip",
"properties.deviceName": "$.properties.devdesc",
"properties.deviceType": "$.properties.devtype",
"properties.entityName": "$.properties.table",
"properties.entityType": "$.properties.type",
"tags": "$.relations.*.type",
"timestamp": "$.timestamp",
"type": "Kafka-Collector"
},
"properties": {
"application.id": "omega-kafka-collector",
"auto.offset.reset": "earliest",
"bootstrap.servers": "edge-kafka-bootstrap:9093",
"group.id": "omega-consumer-group",
"key.deserializer": "org.apache.kafka.common.serialization.StringDeserializer",
"value.deserializer": "org.apache.kafka.common.serialization.StringDeserializer"
},
"topic": "input_metrics",
"type": "json_metrics"
}
}
source
Required
Source cluster details e.g. source topic name , mapping name etc.
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
cURL Command
curl https://{api_host}tcsa.host.com/dcc/v1/collectors/demo-collector
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
On This Page
Collector Operations
post
delete
get
