List Collector Instances

Get instantiated blocks and Get information about instantiated blocks

Request

URI

GET

https://{api_host}/tcsa.host.com/dcc/v1/collectors

COPY

Query Parameters

boolean

config

Optional

This parameter is set to false by default. If set to true, the configurations of all collectors are returned in the response.

boolean

skipFilters

Optional

This parameter is set to false by default. If set to true, the dm collectors are also returned in the response.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns dataCollectorInstances of type(s) application/json

{
    "kafkadash": {
        "block_object_id": "kafka-collector",
        "container_id": "kafkadash-64fcb8cf54-dt59z",
        "image_name": "10.180.13.121:30001/tcx/collector-manager@sha256:abaab76697582b6973b133cfda29ecd5341dfc2e0843ff4078715c583687ae5b",
        "image_version": "abaab76697582b6973b133cfda29ecd5341dfc2e0843ff4078715c583687ae5b",
        "status": "Running",
        "display_name": "kafkadash",
        "node_ip": "10.180.13.25"
    }
}

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