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

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