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

Management Of Connector Lifecycle

Description

API to start, stop, and restart a connector instance start - connector will start transfering data based on its configuration stop - connector will stop transfering data restart - is usuful if connector is not working as expected

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
connector-name Required

Instance id of the connector


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 RestartConnectorResponse of type application/json

Success In Restarting Connector

{
	"id": "testconnector1",
	"status": "STARTED"
}
string
id Optional

Instance id of the connector object


string
status Optional

Status of the object after restart operation

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/connectors/{connector-name}?action=start


Feedback

Was this page helpful?