nodes

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/nodes

Object type: 7ekkf

Example UUID: zzzzz-7ekkf-0123456789abcde

Resource

Node resources list compute nodes on which Crunch may schedule work.

Each Node has, in addition to the Common resource fields:

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
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

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new Node.

Arguments:

Argument	Type	Description	Location	Example
node	object		query

delete

Delete an existing Node.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Node in question.	path

get

Gets a Node’s metadata by UUID.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Node in question.	path

list

List nodes.

See common resource list method.

ping

Process a ping from a compute node.

Arguments:

Argument	Type	Description	Location	Example
ping_secret	string		query
uuid	string		path

update

Update attributes of an existing Node.

Arguments:

Argument	Type	Description	Location	Example
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.

---

Previous: pipeline_templates Next: repositories