API to List Troubleshooting Commands Available for Connector
This endpoint returns the list of troubleshooting commands available for given Connector.
GET /openapi/v1/connectors/<id>/commands/available
where <id> is the id that can be obtained from the API to Get Connectors.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
id |
string |
Specify the Connector ID |
Response object: Returns the list of troubleshooting commands available for given Connector.
Sample response
resp = restclient.get('/connectors/63c6f2701a49bd2bb0696cab/commands/available')
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
[
{
"type": "LIST_SERVICE_FILES",
"name": "List a directory in a service"
},
{
"type": "CONTROLLER_PROFILING",
"name": "Collect controller profile"
},
{
"type": "SHOW_LOG",
"name": "Show logs"
},
{
"type": "SHOW_SERVICE_LOG",
"name": "Show service logs"
},
{
"type": "RESTART_CONNECTOR_CONTAINER",
"name": "Restart the connector docker container"
},
{
"type": "SHOW_SUPERVISOR_COMMANDS",
"name": "Execute supervisorctl command"
},
{
"type": "CONNECTOR_ALERT_INTERVAL_CONNECTOR",
"name": "Override connector alert interval for Connector"
},
{
"type": "SERVICE_PROFILING",
"name": "Collect connector profile"
},
{
"type": "SNAPSHOT_CONNECTOR",
"name": "Collect Snapshot from a connector"
},
{
"type": "PACKET_CAPTURE",
"name": "Packet capture"
},
{
"type": "NETWORK_CONNECTIVITY_COMMANDS",
"name": "Test network connectivity"
},
{
"type": "SHOW_SERVICE_RUNNING_CONF",
"name": "Show running configuration of a service"
},
{
"type": "RESTART_CONNECTOR_SERVICE",
"name": "Restart the connector service"
},
{
"type": "SHOW_SYS_COMMANDS",
"name": "Execute system command"
}
]