X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/4a2dc82a1acce855151928abe0030e1dd7dbf728..HEAD:/doc/api/methods/nodes.html.textile.liquid diff --git a/doc/api/methods/nodes.html.textile.liquid b/doc/api/methods/nodes.html.textile.liquid deleted file mode 100644 index 7ddc62519c..0000000000 --- a/doc/api/methods/nodes.html.textile.liquid +++ /dev/null @@ -1,102 +0,0 @@ ---- -layout: default -navsection: api -navmenu: API Methods -title: "nodes" - -... -{% comment %} -Copyright (C) The Arvados Authors. All rights reserved. - -SPDX-License-Identifier: CC-BY-SA-3.0 -{% endcomment %} - -API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/nodes@ - -Object type: @7ekkf@ - -Example UUID: @zzzzz-7ekkf-0123456789abcde@ - -h2. Resource - -Node resources list compute nodes on which Crunch may schedule work. - -Each Node has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: - -table(table table-bordered table-condensed). -|_. Attribute|_. Type|_. Description|_. Example| -|slot_number|integer||| -|hostname|string||| -|domain|string||| -|ip_address|string||| -|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.|| -|first_ping_at|datetime||| -|last_ping_at|datetime||| -|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|| -|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|| - -h2. Methods - -See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. - -Required arguments are displayed in %{background:#ccffcc}green%. - -h3. create - -Create a new Node. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|node|object||query|| - -h3. delete - -Delete an existing Node. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| - -h3. get - -Gets a Node's metadata by UUID. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| - -h3. list - -List nodes. - -See "common resource list method.":{{site.baseurl}}/api/methods.html#index - -h3. ping - -Process a ping from a compute node. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|ping_secret|string||query|| -{background:#ccffcc}.|uuid|string||path|| - -h3. update - -Update attributes of an existing Node. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| -|node|object||query|| - -To remove a node's job assignment, update the node object's @job_uuid@ to null.