Document toolboxDocument toolbox

Vidispine

Transfer log [VC 21.3 GEN]

Owned by Andreas Schmidt
Aug 31, 2021
2 min read

The transfer log records low-level file transfers. It is typically used for troubleshooting, to be able to determine what happened when.

Examining the log

List all transfer log entries

GET /log/transfer-log

Retrieves log entries according to the specified filtering criteria. Note that the transfer log table does not have a lot of indices, so the extraction of data can be slow. Do not use this method other than for troubleshooting.

Query Parameters:

  • first (integer) – Number of first row to return. Default is 0.

  • rows (integer) – Number of rows to return. Default is 100. Cannot be greater than 1000.

  • starttime (string) – ISO 8601 time, for lower limit of rows to return.

  • endtime (string) – ISO 8601 time, for upper limit of rows to return.

  • storage (string) – Site id, only return transfers where source or destination storage matches. Default is all rows. Note that not all transfers contains information about storages.

  • file (string) – Site id, only return transfers where source or destination file matches. Default is all rows. Note that not all transfers contains information about files.

  • item (string) – Site id, only return transfers where source or destination item matches. Default is all rows. Note that not all transfers contains information about items.

  • shape (string) – Site id, only return transfers where source or destination shape matches. Default is all rows. Note that not all transfers contains information about shapes.

  • uri (string) – URI, only return transfers where source or destination URI matches. Default is all rows. A star (*) in the URI represents a wildcard.

  • job (string) – Site id, only return transfers where job matches. Default is all rows. Note that not all transfers contains information about jobs.

  • status (string) – Comma-separated list. Only return transfers where status matches. Valid values are NONE, STARTING, FINISHED, FAILED.

  • method (string) – Comma-separated list Only return transfers where method matches. Valid values are GET, POST, PUT, DELETE.

  • performCount (boolean) –

    • true - Return a total number of rows matching criteria (except first and count).

    • false (default) - Do not return a total number of rows matching criteria.
Produces:
Role:

_administrator