[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

Management Of Collector Lifecycle

Description

You can start, stop, and restart the collectors
start - Collector will start collecting data based on its configuration
stop - Collector will stop collecting data
restart - is usuful if collector is not working as expected

Request

Request

URL

URL


post
https://{api_host}tcsa.host.com/dcc/v1/collectors/{collector-name}
Copy

Path Parameters

Path Parameters

string
collector-name Required

UUID of the instantiated collector block


Query Parameters

Query Parameters

string
action Required

action to be performed start/stop/restart

action example
"start"

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DCFRestartServiceResponse of type application/json

Success In Restarting Collector

string as ^.*$
id Required

Instance id of the Collector instance


string as ^.*$
status Required

Status of the collector instance after the restart operation is triggered

Errors

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

Code Samples

cURL Command

curl -X POST https://{api_host}tcsa.host.com/dcc/v1/collectors/{collector-name}?action=start


Feedback

Was this page helpful?