From b00fc9532bcfdf74dcc76c42162fa2d98c67795e Mon Sep 17 00:00:00 2001 From: Marcin Haba Date: Sat, 3 Jun 2017 19:33:23 +0200 Subject: [PATCH] baculum: Document post method fields --- docs/manuals/en/console/baculum.tex | 163 +++++++++++++++++++++++++++- 1 file changed, 159 insertions(+), 4 deletions(-) diff --git a/docs/manuals/en/console/baculum.tex b/docs/manuals/en/console/baculum.tex index 6e0c1300..c606cbaf 100644 --- a/docs/manuals/en/console/baculum.tex +++ b/docs/manuals/en/console/baculum.tex @@ -616,10 +616,143 @@ GET /jobs/8 - get records only for job with jobid equal 8. POST /jobs/estimate/ - call estimate action on a job. +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/jobs/estimate/ POST request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| create[id] * | integer | job id to get job name for estimate purpose | +| | | (used instead job name) | ++-------------------+---------+-----------------------------------------------+ +| create[name] * | string | job name to estimate (used instead of jobid) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[fileset] * | string | FileSet resource name | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[level] * | string | Job level in short form. | +| | | One case sensitive letter: | +| | | F => Full | +| | | I => Incremental | +| | | D => Differential | +| | | B => Base | +| | | f => VirtualFull | +| | | V => InitCatalog | +| | | C => Catalog | +| | | O => VolumeToCatalog | +| | | d => DiskToCatalog | ++-------------------+---------+-----------------------------------------------+ +| create[clientid] *| integer | Client identifier | +| | | (used instead of client name) | ++-------------------+---------+-----------------------------------------------+ +| create[client] * | string | Client name (used instead of client id) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[accurate] *| integer | Enable accurate mode: 0 - no, 1 - yes | +| | | | ++-------------------+---------+-----------------------------------------------+ + +* - required field +\end{verbatim} + POST /jobs/run/ - call run action on job (run job). +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/jobs/run/ POST request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| create[id] * | integer | job id to get job name to run | +| | | (used instead job name) | ++-------------------+---------+-----------------------------------------------+ +| create[name] * | string | job name to run (used instead of jobid) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[level] * | string | Job level in short form. | +| | | One case sensitive letter: | +| | | F => Full | +| | | I => Incremental | +| | | D => Differential | +| | | B => Base | +| | | f => VirtualFull | +| | | V => InitCatalog | +| | | C => Catalog | +| | | O => VolumeToCatalog | +| | | d => DiskToCatalog | ++-------------------+---------+-----------------------------------------------+ +| create[fileset] * | string | FileSet resource name | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[clientid] *| integer | Client identifier | +| | | (used instead of client name) | ++-------------------+---------+-----------------------------------------------+ +| create[client] * | string | Client name (used instead of client id) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[storageid]*| integer | Storage identifier | +| | | (used instead of storage name) | ++-------------------+---------+-----------------------------------------------+ +| create[storage] * | string | Storage name (used instead of storage id) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[poolid] * | integer | Pool identifier (used instead of pool name) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[pool] * | string | Pool name (used instead of pool id) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[priority] | integer | Job priority to run | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[jobid] | integer | Job identifier for verify job | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[verifyjob] | string | Verify job name | +| | | | ++-------------------+---------+-----------------------------------------------+ + +* - required field +\end{verbatim} + POST /jobs/restore/ - call restore action. +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/jobs/restore/ POST request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| create[rpath] * | string | Bvfs temporary table name for restore purpose | +| | | in form: b2[0-9]+ | ++-------------------+---------+-----------------------------------------------+ +| create[fileset] * | string | FileSet resource name | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[clientid] *| integer | Client identifier | +| | | (used instead of client name) | ++-------------------+---------+-----------------------------------------------+ +| create[client] * | string | Client name (used instead of client id) | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[priority] | integer | Job priority to run | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[where] * | string | Destination directory for restored files | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[replace] * | string | Replace files in destination directory for | +| | | restored files. Available options: | +| | | - never | +| | | - ifolder | +| | | - ifnewer | +| | | - always | ++-------------------+---------+-----------------------------------------------+ + +* - required field +\end{verbatim} + DELETE /jobs/8 - delete by bconsole job with jobid equal 8.\\ Errors: @@ -644,13 +777,13 @@ Errors: 51 - Inputed job level is invalid. -52 - Fileset resource with inputted filesetid does not exist. +52 - Fileset resource does not exist. -53 - Client with inputted clientid does not exist. +53 - Client does not exist. -54 - Storage with inputted storageid does not exist. +54 - Storage does not exist. -55 - Pool with inputted poolid does not exist. +55 - Pool does not exist. 56 - [restore only] inputted rpath for restore is invalid. Proper format is b2[0-9]+. @@ -701,6 +834,28 @@ PUT /api/bvfs/update/9,10,22 - updating Bvfs cache for jobids equal 9, 10 and 22 POST /api/bvfs/restore/ - preparing Bvfs paths for restore command. +\begin{verbatim} ++-----------------------------------------------------------------------------+ +| /api/bvfs/restore/ POST request | ++-------------------+---------+-----------------------------------------------+ +| Name | Type | Description | ++-------------------+---------+-----------------------------------------------+ +| create[jobids] * | string | job identifiers comma separated | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[dirid] | string | directory identifiers comma separated | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[fileid] | string | file identifiers comma separated | +| | | | ++-------------------+---------+-----------------------------------------------+ +| create[path] * | string | temporary Bvfs table table name | +| | | in form b2[0-9]+ | ++-------------------+---------+-----------------------------------------------+ + +* - required field +\end{verbatim} + PUT /api/bvfs/clear/ - call '.bvfs\_clear\_cache yes' bconsole command.\\ -- 2.39.5