doc/api/schema/Job.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: Job
   6
   7 ...
   8
   9
  10
  11 Applications submit compute jobs when:
  12 * Provenance is important, i.e., it is worth recording how the output was produced; or
  13 * Computation time is significant; or
  14 * The job management features are convenient (failure detection/recovery, regression testing, etc).
  15
  16 h2. Methods
  17
  18 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  19
  20 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/jobs@
  21
  22 h3. Queue
  23
  24 <pre>
  25 GET https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue
  26
  27 POST https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue
  28 _method=GET
  29 where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25
  30 </pre>
  31
  32 &rarr; Job resource list
  33
  34 This method is equivalent to the "index method":{{site.baseurl}}/api/methods.html#index, 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.
  35
  36 h2. Resource
  37
  38 Each job has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Attribute|_. Type|_. Description|_. Notes|
  42 |submit_id|string|Unique ID provided by client when job was submitted|Optional. Can be used by client to ensure idempotence|
  43 |priority|string|||
  44 |runtime_constraints{}|list|Constraints that must be satisfied by the job/task scheduler in order to run the job.|See below.|
  45 |script|string|Name of crunch script in @/crunch_scripts/@||
  46 |script_parameters{}|list|Parameters passed to MapReduce script||
  47 |script_version|string|git branch, tag, or commit hash.|Before the job starts, this is the git branch, tag, or hash supplied by the user.  When the job starts, Arvados updates this field to the full 40-character git hash of the actual commit used by the job.|
  48 |repository             |string     |The repository from which the script_version will be fetched.|
  49 |cancelled_by_client_uuid|string|API client ID|Is null if job has not been cancelled|
  50 |cancelled_by_user_uuid|string|Authenticated user ID|Is null if job has not been cancelled|
  51 |cancelled_at|datetime|When job was cancelled|Is null if job has not been cancelled|
  52 |started_at|datetime|When job started running|Is null if job has not [yet] started|
  53 |finished_at|datetime|When job finished running|Is null if job has not [yet] finished|
  54 |running|boolean|Whether the job is running||
  55 |success|boolean|Whether the job indicated successful completion|Is null if job has not finished|
  56 |is_locked_by_uuid|string|UUID of the user who has locked this job|Is null if job is not locked. The system user locks the job when starting the job, in order to prevent job attributes from being altered.|
  57 |log|string|||
  58 |tasks_summary|Hash|||
  59 |output|string|||
  60 |nondeterministic       |boolean    |Indicates whether this job is a candidate for re-use|If true, this job will never be considered for re-use.|
  61
  62 h3. Runtime constraints
  63
  64 table(table table-bordered table-condensed).
  65 |_. Key|_. Type|_. Description|_. Implemented|
  66 |dependencies{}|list|[
  67  {
  68   "name": "freebayes",
  69   "package_type": "git",
  70   "origin": "https://github.com/ekg/freebayes.git",
  71   "version": "011561f4a96619125d4388b66b2e82b173f3de7a"
  72  },
  73  ...
  74 ]||
  75 |min_nodes|integer||&#10003;|
  76 |max_nodes|integer|||
  77 |max_tasks_per_node|integer|Maximum simultaneous tasks on a single node|&#10003;|
  78 |min_ram_per_task|integer|Minimum real memory (KiB) per task||
  79 |min_ram_per_node|integer|Minimum real memory (KiB) per node||