Sign in
ComputeNodes

Gets information about the specified compute node.

get/pools/{poolId}/nodes/{nodeId}

Path parameters

poolIdstring required

The id of the pool that contains the compute node.

nodeIdstring required

The id of the compute node that you want to get information about.

Query parameters

$selectstring

An OData $select clause.

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

Headers

client-request-idstring

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id identifier in the response.

ocp-datestring date-time-rfc1123

The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

Response

OK

idstring

The id of the compute node.

urlstring

The URL of the compute node.

state'idle' | 'rebooting' | 'reimaging' | 'running' | 'unusable' | 'creating' | 'starting' | 'waitingforstarttask' | 'starttaskfailed' | 'unknown' | 'leavingpool' | 'offline'

The current state of the compute node.

schedulingState'enabled' | 'disabled'

Whether the compute node should be available for task scheduling.

stateTransitionTimestring date-time

The time at which the compute node entered its current state.

lastBootTimestring date-time

The time at which the compute node was started.

allocationTimestring date-time

The time at which this compute node was allocated to the pool.

ipAddressstring

The IP address that other compute nodes can use to communicate with this compute node.

affinityIdstring

An identifier which can be passed in the Add Task API to request that the task be scheduled close to this compute node.

vmSizestring

The size of the virtual machine hosting the compute node.

totalTasksRuninteger

The total number of job tasks completed on the compute node. This includes Job Preparation, Job Release and Job Manager tasks, but not the pool start task.

runningTasksCountinteger

The total number of currently running job tasks on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.

totalTasksSucceededinteger

The total number of job tasks which completed successfully (with exitCode 0) on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.

Changes