--- title: "GET /pools/{poolId}/nodes/{nodeId}" method: GET path: "/pools/{poolId}/nodes/{nodeId}" tags: ["ComputeNodes"] --- # GET /pools/{poolId}/nodes/{nodeId} `GET /pools/{poolId}/nodes/{nodeId}` Gets information about the specified compute node. ## Path parameters - `poolId` string, required - `nodeId` string, required ## Query parameters - `$select` string - `timeout` integer - `api-version` string, required ## Headers - `client-request-id` string - `return-client-request-id` boolean - `ocp-date` string, date-time-rfc1123 ## Response `200` OK - ComputeNode — A compute node in the Batch service. - `id` string — The id of the compute node. - `url` string — 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. - `stateTransitionTime` string, date-time — The time at which the compute node entered its current state. - `lastBootTime` string, date-time — The time at which the compute node was started. - `allocationTime` string, date-time — The time at which this compute node was allocated to the pool. - `ipAddress` string — The IP address that other compute nodes can use to communicate with this compute node. - `affinityId` string — An identifier which can be passed in the Add Task API to request that the task be scheduled close to this compute node. - `vmSize` string — The size of the virtual machine hosting the compute node. - `totalTasksRun` integer — 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. - `runningTasksCount` integer — 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. - `totalTasksSucceeded` integer — 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. - `recentTasks` TaskInformation[] — The list of tasks that are currently running on the compute node. - `taskUrl` string — The URL of the task. - `jobId` string — The id of the job to which the task belongs. - `taskId` string — The id of the task. - `subtaskId` integer — The id of the subtask if the task is a multi-instance task. - `taskState` 'active' | 'preparing' | 'running' | 'completed', required — The current state of the task. - `executionInfo` TaskExecutionInformation — Information about the execution of a task. - `startTime` string, date-time — The time at which the task started running. If the task has been restarted or retried, this is the most recent time at which the task started running. - `endTime` string, date-time — The time at which the task completed. This property is set only if the task is in the Completed state. - `exitCode` integer — The exit code of the task. This property is set only if the task is in completed state. - `schedulingError` TaskSchedulingError — Information about an error when scheduling a task. - `category` 'usererror' | 'servererror' | 'unmapped', required — The category of the task scheduling error. - `code` string — An identifier for the task scheduling error. Codes are invariant and are intended to be consumed programmatically. - `message` string — A message describing the task scheduling error, intended to be suitable for display in a user interface. - `details` NameValuePair[] — The list of additional error details related to the scheduling error. - `name` string — The name in the name-value pair. - `value` string — The value in the name-value pair. - `retryCount` integer, required — The number of times the task has been retried by the Batch service. - `lastRetryTime` string, date-time — The most recent time at which a retry of the task started running. - `requeueCount` integer, required — The number of times the task has been requeued by the Batch service as the result of a user request. - `lastRequeueTime` string, date-time — The most recent time at which the task has been requeued by the Batch service as the result of a user request. - `startTask` StartTask — A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. - `commandLine` string — The command line of the start task. - `resourceFiles` ResourceFile[] — A list of files that the Batch service will download to the compute node before running the command line. - `blobSource` string — The URL of the file within Azure Blob Storage. This URL should include a shared access signature if the blob is not publicly readable. - `filePath` string — The location to which to download the file, relative to the task's working directory. - `fileMode` string — The file mode attribute in octal format. This property will be ignored if it is specified for a resourceFile which will be downloaded to a Windows compute node. - `environmentSettings` EnvironmentSetting[] — A list of environment variable settings for the start task. - `name` string — The name of the environment variable. - `value` string — The value of the environment variable. - `runElevated` boolean — Whether to run the start task in elevated mode. The default value is false. - `maxTaskRetryCount` integer — The maximum number of times the task may be retried. - `waitForSuccess` boolean — Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node. - `startTaskInfo` StartTaskInformation — Information about a start task running on a compute node. - `state` 'running' | 'completed', required — The state of the start task on the compute node. - `startTime` string, date-time, required — The time at which the start task started running. - `endTime` string, date-time — The time at which the start task stopped running. - `exitCode` integer — The exit code of the start task. - `schedulingError` TaskSchedulingError — Information about an error when scheduling a task. - `category` 'usererror' | 'servererror' | 'unmapped', required — The category of the task scheduling error. - `code` string — An identifier for the task scheduling error. Codes are invariant and are intended to be consumed programmatically. - `message` string — A message describing the task scheduling error, intended to be suitable for display in a user interface. - `details` NameValuePair[] — The list of additional error details related to the scheduling error. - `name` string — The name in the name-value pair. - `value` string — The value in the name-value pair. - `retryCount` integer, required — The number of times the task has been retried by the Batch service. - `lastRetryTime` string, date-time — The most recent time at which a retry of the task started running. - `certificateReferences` CertificateReference[] — The list of certificates installed on the compute node. - `thumbprint` string, required — The thumbprint of the certificate. - `thumbprintAlgorithm` string, required — The algorithm with which the thumbprint is associated. This must be sha1. - `storeLocation` 'currentuser' | 'localmachine' | 'unmapped' — The location of the certificate store on the compute node into which to install the certificate. The default value is CurrentUser. - `storeName` string — The name of the certificate store on the compute node into which to install the certificate. The default value is My. - `visibility` string[] — Which user accounts on the compute node should have access to the private data of the certificate. This may be any subset of the values 'starttask', 'task' and 'remoteuser', separated by commas. The default is all accounts, corresponding to the string 'starttask,task,remoteuser'. - `errors` ComputeNodeError[] — The list of errors that are currently being encountered by the compute node. - `code` string — An identifier for the compute node error. Codes are invariant and are intended to be consumed programmatically. - `message` string — A message describing the compute node error, intended to be suitable for display in a user interface. - `errorDetails` NameValuePair[] — The list of additional error details related to the compute node error. - `name` string — The name in the name-value pair. - `value` string — The value in the name-value pair. ## Other responses - `default` — The error from the Batch service. --- [API](https://skmtc.dev/azure/apis/batch-batch.md) · [All operations](https://skmtc.dev/azure/apis/batch-batch/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/batch-batch/revisions/bee2d837bf8f/schema)