v1

latestSwagger 2.02026-07-1377151733.6 KB
Files

Lists all of the files in task directories on the specified compute node.

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

Path parameters

poolIdstring required

The ID of the pool that contains the compute node.

nodeIdstring required

The ID of the compute node whose files you want to list.

Query parameters

$filterstring

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.

recursiveboolean

Whether to list children of a directory.

maxresultsinteger

The maximum number of items to return in the response. A maximum of 1000 files can be returned.

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 uuid

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 in the response.

ocp-datestring date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Response

A response containing the list of files.

odata.nextLinkstring