Merge branch '13581-cr-not-satisfiable-report'
[arvados.git] / 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|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||
36 |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||
37
38 h2. Methods
39
40 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
41
42 Required arguments are displayed in %{background:#ccffcc}green%.
43
44 h3. create
45
46 Create a new Node.
47
48 Arguments:
49
50 table(table table-bordered table-condensed).
51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
52 {background:#ccffcc}.|node|object||query||
53
54 h3. delete
55
56 Delete an existing Node.
57
58 Arguments:
59
60 table(table table-bordered table-condensed).
61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
62 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
63
64 h3. get
65
66 Gets a Node's metadata by UUID.
67
68 Arguments:
69
70 table(table table-bordered table-condensed).
71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
72 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
73
74 h3. list
75
76 List nodes.
77
78 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
79
80 h3. ping
81
82 Process a ping from a compute node.
83
84 Arguments:
85
86 table(table table-bordered table-condensed).
87 |_. Argument |_. Type |_. Description |_. Location |_. Example |
88 {background:#ccffcc}.|ping_secret|string||query||
89 {background:#ccffcc}.|uuid|string||path||
90
91 h3. update
92
93 Update attributes of an existing Node.
94
95 Arguments:
96
97 table(table table-bordered table-condensed).
98 |_. Argument |_. Type |_. Description |_. Location |_. Example |
99 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
100 |node|object||query||
101
102 To remove a node's job assignment, update the node object's @job_uuid@ to null.