doc/api/methods/jobs.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "jobs"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. cancel
  16
  17 Cancel a job that is queued or running.
  18
  19 Arguments:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  23 {background:#ccffcc}.|uuid|string||path||
  24
  25 h2(#create). create
  26
  27 Create a new Job.
  28
  29 Arguments:
  30
  31 table(table table-bordered table-condensed).
  32 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  33 {background:#ccffcc}.|job|object|See "Job resource":{{site.baseurl}}/api/schema/Job.html|request body||
  34 |minimum_script_version |string     |Git branch, tag, or commit hash specifying the minimum acceptable script version (earliest ancestor) to consider when deciding whether to re-use a past job.|query|@"c3e86c9"@|
  35 |exclude_script_versions|array of strings|Git commit branches, tags, or hashes to exclude when deciding whether to re-use a past job.|query|@["8f03c71","8f03c71"]@
  36 @["badtag1","badtag2"]@|
  37 |find_or_create         |boolean    |Before creating, look for an existing job that has identical script, script_version, and script_parameters to those in the present job, has nondeterministic=false, and did not fail (it could be queued, running, or completed). If such a job exists, respond with the existing job instead of submitting a new one.|query|@false@|
  38
  39 When a job is submitted to the queue using the **create** method, the 'script_version' field is updated to a full 40-character Git commit hash based on the current content of the specified repository. If 'script_version' cannot be resolved, the job submission is rejected.
  40
  41 h3. Reusing jobs
  42
  43 Because Arvados records the exact version of the script, input parameters, and runtime environment [1] that was used to run the job, if the script is deterministic (meaning that the same code version is guaranteed to produce the same outputs from the same inputs) then it is possible to re-use the results of past jobs, and avoid re-running the computation to save time.  Arvados uses the following algorithm to determine if a past job can be re-used:
  44
  45 notextile. <div class="spaced-out">
  46
  47 # If @find_or_create@ is false or omitted, create a new job and skip the rest of these steps.
  48 # Find a list of acceptable values for @script_version@.  If @minimum_script_version@ is specified, this is the set of all revisions in the Git commit graph between @minimum_script_version@ and the @script_version@ in the submitted "job object":{{site.baseurl}}/api/schema/Job.html (inclusive)[2].  If @minimum_script_version@ is not specified, only @script_version@ is added to the list.  If @exclude_script_versions@ is specified, the listed versions are excluded from the list.
  49 # Select jobs whose @script@ and @script_parameters@ attributes match those in the submitted "job object":{{site.baseurl}}/api/schema/Job.html, and whose @script_version@ attribute is in the list of acceptable versions.  Exclude jobs that failed or set @nondeterministic@ to true.
  50 # If more than one of the candidate jobs has finished, check that all such jobs actually did produce the same output.
  51 # If existing jobs exist and do not disagree with one another about the correct output, return one of the selected past jobs instead of creating a new job. If there is more than one match, which job will be returned is undefined.
  52 # If an existing job could not be chosen this way, create a new job.
  53
  54 fn1. As of this writing, versioning the runtime environment is still under development.
  55
  56 fn2. This may include parallel branches if there is more than one path between @minimum_script_version@ and the submitted job's @script_version@ in the Git commit graph.  Use @exclude_script_versions@ to blacklist specific commits.
  57
  58 </div>
  59
  60 h3. Examples
  61
  62 Run the script "crunch_scripts/hash.py" in the repository "you" using the "master" commit.  Arvados should re-use a previous job if the script_version of the previous job is the same as the current "master" commit. This works irrespective of whether the previous job was submitted using the name "master", a different branch name or tag indicating the same commit, a SHA-1 commit hash, etc.
  63
  64 <notextile><pre>
  65 {
  66   "job": {
  67     "script": "hash.py",
  68     "repository": "<b>you</b>",
  69     "script_version": "master",
  70     "script_parameters": {
  71       "input": "c1bad4b39ca5a924e481008009d94e32+210"
  72     }
  73   },
  74   "find_or_create": true
  75 }
  76 </pre></notextile>
  77
  78 Run using exactly the version "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5". Arvados should re-use a previous job if the "script_version" of that job is also "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5".
  79
  80 <notextile><pre>
  81 {
  82   "job": {
  83     "script": "hash.py",
  84     "repository": "<b>you</b>",
  85     "script_version": "d00220fb38d4b85ca8fc28a8151702a2b9d1dec5",
  86     "script_parameters": {
  87       "input": "c1bad4b39ca5a924e481008009d94e32+210"
  88     }
  89   },
  90   "find_or_create": true
  91 }
  92 </pre></notextile>
  93
  94 Arvados should re-use a previous job if the "script_version" of the previous job is between "earlier_version_tag" and the "master" commit (inclusive), but not the commit indicated by "blacklisted_version_tag". If there are no previous jobs matching these criteria, run the job using the "master" commit.
  95
  96 <notextile><pre>
  97 {
  98   "job": {
  99     "script": "hash.py",
 100     "repository": "<b>you</b>",
 101     "script_version": "master",
 102     "script_parameters": {
 103       "input": "c1bad4b39ca5a924e481008009d94e32+210"
 104     }
 105   },
 106   "minimum_script_version": "earlier_version_tag",
 107   "exclude_script_versions": ["blacklisted_version_tag"],
 108   "find_or_create": true
 109 }
 110 </pre></notextile>
 111
 112 Run the script "crunch_scripts/monte-carlo.py" in the repository "you" using the current "master" commit. Because it is marked as "nondeterministic", this job will not be considered as a suitable candidate for future job submissions that use the "find_or_create" feature.
 113
 114 <notextile><pre>
 115 {
 116   "job": {
 117     "script": "monte-carlo.py",
 118     "repository": "<b>you</b>",
 119     "script_version": "master",
 120     "nondeterministic": true,
 121     "script_parameters": {
 122       "input": "c1bad4b39ca5a924e481008009d94e32+210"
 123     }
 124   }
 125 }
 126 </pre></notextile>
 127
 128 h2. delete
 129
 130 Delete an existing Job.
 131
 132 Arguments:
 133
 134 table(table table-bordered table-condensed).
 135 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 136 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
 137
 138 h2. get
 139
 140 Gets a Job's metadata by UUID.
 141
 142 Arguments:
 143
 144 table(table table-bordered table-condensed).
 145 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 146 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
 147
 148 h2. list
 149
 150 List jobs.
 151
 152 Arguments:
 153
 154 table(table table-bordered table-condensed).
 155 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 156 |limit|integer (default 100)|Maximum number of jobs to return.|query||
 157 |order|string|Order in which to return matching jobs.|query||
 158 |filters|array|Conditions for filtering jobs.|query||
 159
 160 h2. log_tail_follow
 161
 162 log_tail_follow jobs
 163
 164 Arguments:
 165
 166 table(table table-bordered table-condensed).
 167 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 168 {background:#ccffcc}.|uuid|string||path||
 169 |buffer_size|integer (default 8192)||query||
 170
 171 h2. queue
 172
 173 Get the current job queue.
 174
 175 Arguments:
 176
 177 table(table table-bordered table-condensed).
 178 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 179 |order|string||query||
 180 |filters|array||query||
 181
 182 This method is equivalent to the "list method":#list, except that the results are restricted to queued jobs (i.e., jobs that have not yet been started or cancelled) and order defaults to queue priority.
 183
 184 h2. update
 185
 186 Update attributes of an existing Job.
 187
 188 Arguments:
 189
 190 table(table table-bordered table-condensed).
 191 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 192 {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path||
 193 |job|object||query||