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 {% include 'notebox_begin_warning' %}
  15 This is a legacy API.  This endpoint is deprecated, disabled by default in new installations, and slated to be removed entirely in a future major release of Arvados.  It is replaced by "cloud dispatcher API.":../dispatch.html
  16 {% include 'notebox_end' %}
  17
  18 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/nodes@
  19
  20 Object type: @7ekkf@
  21
  22 Example UUID: @zzzzz-7ekkf-0123456789abcde@
  23
  24 h2. Resource
  25
  26 Node resources list compute nodes on which Crunch may schedule work.
  27
  28 Each Node has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Attribute|_. Type|_. Description|_. Example|
  32 |slot_number|integer|||
  33 |hostname|string|||
  34 |domain|string|||
  35 |ip_address|string|||
  36 |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.||
  37 |first_ping_at|datetime|||
  38 |last_ping_at|datetime|||
  39 |info|hash|Sensitive information about the node (only visible to admin) such as 'ping_secret' and 'ec2_instance_id'. May be used in queries using "subproperty filters":{{site.baseurl}}/api/methods.html#subpropertyfilters||
  40 |properties|hash|Public information about the node, such as 'total_cpu_cores', 'total_ram_mb', and 'total_scratch_mb'.  May be used in queries using "subproperty filters":{{site.baseurl}}/api/methods.html#subpropertyfilters||
  41
  42 h2. Methods
  43
  44 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  45
  46 Required arguments are displayed in %{background:#ccffcc}green%.
  47
  48 h3. create
  49
  50 Create a new Node.
  51
  52 Arguments:
  53
  54 table(table table-bordered table-condensed).
  55 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  56 {background:#ccffcc}.|node|object||query||
  57
  58 h3. delete
  59
  60 Delete an existing Node.
  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. get
  69
  70 Gets a Node's metadata by UUID.
  71
  72 Arguments:
  73
  74 table(table table-bordered table-condensed).
  75 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  76 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  77
  78 h3. list
  79
  80 List nodes.
  81
  82 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  83
  84 h3. ping
  85
  86 Process a ping from a compute node.
  87
  88 Arguments:
  89
  90 table(table table-bordered table-condensed).
  91 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  92 {background:#ccffcc}.|ping_secret|string||query||
  93 {background:#ccffcc}.|uuid|string||path||
  94
  95 h3. update
  96
  97 Update attributes of an existing Node.
  98
  99 Arguments:
 100
 101 table(table table-bordered table-condensed).
 102 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 103 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
 104 |node|object||query||
 105
 106 To remove a node's job assignment, update the node object's @job_uuid@ to null.