List Collector Files | Telco Cloud Service Assurance

List Collector Files

List the all collectors configuration files. This API can filter the configuration files based on "modules". By default API returns all the backup files, but user can enable/disable via query param "backup_files".

Request

URI

GET

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

COPY

Path Parameters

string

collector-name

Required

id of the instantiated collector

collector-name example

demo-collector

Query Parameters

string

module

Optional

Module name for which user wants to list the configuration files.

module example

Collecting

boolean

backup_files

Optional

Set to false if doesn't want to list the backup files. Default is true.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns the list of configuration files.

Returns Array of CollectorFileDetails of type(s) application/json

[
    {
        "file_name": "collector.xml",
        "display_path": "conf/collector.xml",
        "file_path": "Collecting/Collector-Manager/vcenter-collector/conf/collector.xml",
        "size": 1500,
        "file_extension": "xml"
    }
]

400

Bad request

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Collector not found

Operation doesn't return any data structure