[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
List Collector Instances
DescriptionGet instantiated blocks and Get information about instantiated blocks
Request
Operation doesn't accept any path, query or header parameters.
URL
https://{api_host}tcsa.host.com/dcc/v1/collectors
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
map of
CollectorInstanceSummary
of type application/json
{
"kafkadash": {
"block_object_id": "kafka-collector",
"container_id": "kafkadash-64fcb8cf54-dt59z",
"display_name": "kafkadash",
"image_name": "10.180.13.121:30001/tcx/collector-manager@sha256:abaab76697582b6973b133cfda29ecd5341dfc2e0843ff4078715c583687ae5b",
"image_version": "abaab76697582b6973b133cfda29ecd5341dfc2e0843ff4078715c583687ae5b",
"node_ip": "10.180.13.25",
"status": "Running"
}
}
string as ^.*$
block_object_id
Required
Block object id of collector object e.g. kafka-collector, network-traffic-flows
string as ^.*$
container_id
Required
Pod name of the collector instance
string as ^.*$
display_name
Required
Display name of the collector instance same as teh name provided in the create collector request
string as ^.*$
image_name
Required
Collector image name with repository-url, image name and image tag
string as ^.*$
image_version
Required
Collector image version e.g 1.0.0
string as ^.*$
node_ip
Required
Host ip of node where collector is deployed
string as ^.*$
status
Required
Collector instance status Running, Stopped, Pending, Failed
Errors
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
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
On This Page
Collector Operations
post
delete
get
