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 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/nodes@
  12
  13 UUID type: @7ekkf@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Node resources list compute nodes on which Crunch may schedule work.
  20
  21 Each Node has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |slot_number|integer|||
  26 |hostname|string|||
  27 |domain|string|||
  28 |ip_address|string|||
  29 |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.||
  30 |first_ping_at|datetime|||
  31 |last_ping_at|datetime|||
  32 |info|hash|||
  33
  34 h2. Methods
  35
  36 h3. create
  37
  38 Create a new Node.
  39
  40 Arguments:
  41
  42 table(table table-bordered table-condensed).
  43 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  44 {background:#ccffcc}.|node|object||query||
  45
  46 h3. delete
  47
  48 Delete an existing Node.
  49
  50 Arguments:
  51
  52 table(table table-bordered table-condensed).
  53 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  54 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  55
  56 h3. get
  57
  58 Gets a Node's metadata by UUID.
  59
  60 Arguments:
  61
  62 table(table table-bordered table-condensed).
  63 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  64 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  65
  66 h3. list
  67
  68 List nodes.
  69
  70 Arguments:
  71
  72 table(table table-bordered table-condensed).
  73 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  74 |limit|integer (default 100)|Maximum number of nodes to return.|query||
  75 |order|string|Order in which to return matching nodes.|query||
  76 |filters|array|Conditions for filtering nodes.|query||
  77
  78 h3. ping
  79
  80 ping nodes
  81
  82 Arguments:
  83
  84 table(table table-bordered table-condensed).
  85 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  86 {background:#ccffcc}.|ping_secret|string||query||
  87 {background:#ccffcc}.|uuid|string||path||
  88
  89 h3. update
  90
  91 Update attributes of an existing Node.
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  98 |node|object||query||
  99
 100 To remove a node's job assignment, update the node object's @job_uuid@ to null.