put_fs_tasks_id
Update an existing file system task (copy, move, delete, etc.) by its ID, modifying its state, progress, or other properties.
Instructions
Updates the FsTask task with the given id
Error codes: invalid_id, path_not_found, internal_error, disk_unavailable, invalid_request, invalid_conflict_mode, exec_failed, out_of_memory, task_not_found, invalid_state, invalid_task_type, destination_conflict, access_denied, disk_full, none, archive_read_failed, archive_open_failed, archive_write_failed, chdir_failed, dest_is_not_dir, file_exists, file_not_found, mkdir_failed, open_input_failed, open_output_failed, opendir_failed, overwrite_failed, path_too_big, repair_failed, rmdir_failed
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id__path | Yes | (Path parameter) | |
| id | No | id | |
| type | No | The valid task types are: — Values: `cat`: Concatenate multiple files; `cp`: Copy files; `mv`: Move files; `rm`: Remove files; `archive`: Creates an archive; `extract`: Extract an archive; `repair`: Check and repair files | |
| state | No | Values: `queued`: Queued (only one task is active at a given time); `running`: Running; `paused`: Paused (user suspended); `done`: Done; `failed`: Failed (see error) | |
| error | No | Values: `none`: No error; `archive_read_failed`: Error reading archive; `archive_open_failed`: Error opening archive; `archive_write_failed`: Error writing archive; `chdir_failed`: Error changing directory; `dest_is_not_dir`: The destination is not a directory; `file_exists`: File already exists; `file_not_found`: File not found; `mkdir_failed`: Unable to create directory; `open_input_failed`: Error opening input file; `open_output_failed`: Error opening output file; `opendir_failed`: Error opening directory; `overwrite_failed`: Error overwriting file; `path_too_big`: Path is too long; `repair_failed`: Failed to repair corrupted files; `rmdir_failed`: Error removing directory; `same_file`: Source and Destination are the same file; `unlink_failed`: Error removing file; `unsupported_file_type`: This file type is not supported; `write_failed`: Error writing file; `disk_full`: Disk is full; `internal`: Internal error; `invalid_format`: Invalid file format (corrupted ?); `incorrect_password`: Invalid or missing password for extraction; `permission_denied`: Permission denied; `readlink_failed`: Failed to read the target of a symbolic link; `symlink_failed`: Failed to create a symbolic link | |
| created_ts | No | task creation timestamp — Unix timestamp (seconds since epoch). | |
| started_ts | No | task start timestamp — Unix timestamp (seconds since epoch). | |
| done_ts | No | task end timestamp — Unix timestamp (seconds since epoch). | |
| duration | No | task duration in seconds | |
| progress | No | task progress in percent (scaled by 100) | |
| eta | No | estimated time remaining before the task completion (in seconds) | |
| from | No | current source file (if available) | |
| to | No | current destination file (if available) | |
| nfiles | No | number of files to process | |
| nfiles_done | No | number of files processed | |
| total_bytes | No | total bytes to process | |
| total_bytes_done | No | number of bytes processed | |
| curr_bytes | No | size of the file currently processed | |
| curr_bytes_done | No | number of bytes processed for the current file | |
| rate | No | processing rate in byte/s |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||