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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "nodes"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/nodes@
  15
  16 Object type: @7ekkf@
  17
  18 Example UUID: @zzzzz-7ekkf-0123456789abcde@
  19
  20 h2. Resource
  21
  22 Node resources list compute nodes on which Crunch may schedule work.
  23
  24 Each Node has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |slot_number|integer|||
  29 |hostname|string|||
  30 |domain|string|||
  31 |ip_address|string|||
  32 |job_uuid|string|The UUID of the job that this node is assigned to work on.  If you do not have permission to read the job, this will be null.||
  33 |first_ping_at|datetime|||
  34 |last_ping_at|datetime|||
  35 |info|hash|||
  36
  37 h2. Methods
  38
  39 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  40
  41 Required arguments are displayed in %{background:#ccffcc}green%.
  42
  43 h3. create
  44
  45 Create a new Node.
  46
  47 Arguments:
  48
  49 table(table table-bordered table-condensed).
  50 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  51 {background:#ccffcc}.|node|object||query||
  52
  53 h3. delete
  54
  55 Delete an existing Node.
  56
  57 Arguments:
  58
  59 table(table table-bordered table-condensed).
  60 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  61 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  62
  63 h3. get
  64
  65 Gets a Node's metadata by UUID.
  66
  67 Arguments:
  68
  69 table(table table-bordered table-condensed).
  70 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  71 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  72
  73 h3. list
  74
  75 List nodes.
  76
  77 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  78
  79 h3. ping
  80
  81 Process a ping from a compute node.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|ping_secret|string||query||
  88 {background:#ccffcc}.|uuid|string||path||
  89
  90 h3. update
  91
  92 Update attributes of an existing Node.
  93
  94 Arguments:
  95
  96 table(table table-bordered table-condensed).
  97 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  98 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  99 |node|object||query||
 100
 101 To remove a node's job assignment, update the node object's @job_uuid@ to null.