Management Of Collector Lifecycle

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

URI

POST

https://{api_host}/dcc/v1/collectors/{collector-name}

COPY

Path Parameters

string

collector-name

Required

ID of the instantiated collector block

collector-name example

demo-collector

Query Parameters

string

action

Required

action to be performed start/stop/restart

action example

start

Possible values are : start, stop, restart,

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Success In Restarting Collector

Returns DCFRestartServiceResponse of type(s) application/json

{
    "id": "apg-collector-manager-cloudify-orchestratorffa3bb75-99f4-4613-8a5a-45e2cee0372c",
    "status": "STARTED"
}

string As ^.*$

Required

Constraints: default:

Instance id of the Collector instance

string As ^.*$

status

Required

Constraints: default:

Status of the collector instance after the restart operation is triggered

400

Invalid Request sent by the user