Transfer log¶
New in version 4.14.2.
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¶
Retrieving log content¶
-
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 – Optional integer, number of first row to return, default is
0
. - rows – Optional integer, number of rows to return, default is
100
. Cannot be greater than 1000. - starttime – Optional ISO 8601 time, for lower limit of rows to return.
- endtime – Optional ISO 8601 time, for upper limit of rows to return.
- storage – Optional 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 – Optional 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 – Optional 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 – Optional 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 – Optional URI, only return transfers where source or destination URI matches. Default is all rows.
A star (
*
) in the URI represent a wildcard. - job – Optional site id, only return transfers where job matches. Default is all rows. Note that not all transfers contains information about jobs.
- status – Optional status string, transfers where status matches. Valid values are
NONE
,STARTING
,FINISHED
,FAILED
. - method – Optional status string, transfers where method matches. Valid values are
NONE
,STARTING
,FINISHED
,FAILED
. - performCount –
false
(default) - Do not return a total number of rows matching criteria.true
- Return a total number of rows matching criteria (except first and count).
Produces: - application/xml, application/json – TransferLogListDocument
Role: _administrator
- first – Optional integer, number of first row to return, default is