File - List From Compute Node
Lists all of the files in Task directories on the specified Compute Node.
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
The base URL for all Azure Batch service requests. |
node
|
path | True |
string |
The ID of the Compute Node whose files you want to list. |
pool
|
path | True |
string |
The ID of the Pool that contains the Compute Node. |
api-version
|
query | True |
string |
Client API Version. |
$filter
|
query |
string |
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. |
|
maxresults
|
query |
integer int32 |
The maximum number of items to return in the response. A maximum of 1000 files can be returned. |
|
recursive
|
query |
boolean |
Whether to list children of a directory. |
|
timeout
|
query |
integer int32 |
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. |
Request Header
Media Types: "application/json; odata=minimalmetadata"
Name | Required | Type | Description |
---|---|---|---|
client-request-id |
string 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-id |
boolean |
Whether the server should return the client-request-id in the response. |
|
ocp-date |
string 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. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
A response containing the list of files. Headers
|
|
Other Status Codes |
The error from the Batch service. |
Security
azure_auth
Microsoft Entra OAuth 2.0 auth code flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Impersonate your user account |
Authorization
Type:
apiKey
In:
header
Examples
File list from node
Sample request
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/files?recursive=False&api-version=2023-11-01.18.0
Sample response
{
"value": [
{
"name": "shared",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared",
"isDirectory": true
},
{
"name": "startup\\ProcessEnv.cmd",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd",
"isDirectory": false,
"properties": {
"creationTime": "2014-09-19T21:56:17.679195Z",
"lastModified": "2014-09-19T21:56:17.679195Z",
"contentLength": 1813,
"contentType": "application/octet-stream"
}
},
{
"name": "startup\\stderr.txt",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt",
"isDirectory": false,
"properties": {
"creationTime": "2014-09-19T21:56:17.5590855Z",
"lastModified": "2014-09-19T21:56:17.5590855Z",
"contentLength": 0,
"contentType": "application/octet-stream"
}
}
]
}
Definitions
Name | Description |
---|---|
Batch |
An error response received from the Azure Batch service. |
Batch |
An item of additional information included in an Azure Batch error response. |
Error |
An error message received in an Azure Batch error response. |
File |
The properties of a file on a Compute Node. |
Node |
Information about a file or directory on a Compute Node. |
Node |
The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node. |
BatchError
An error response received from the Azure Batch service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
message |
A message describing the error, intended to be suitable for display in a user interface. |
|
values |
A collection of key-value pairs containing additional details about the error. |
BatchErrorDetail
An item of additional information included in an Azure Batch error response.
Name | Type | Description |
---|---|---|
key |
string |
An identifier specifying the meaning of the Value property. |
value |
string |
The additional information included with the error response. |
ErrorMessage
An error message received in an Azure Batch error response.
Name | Type | Description |
---|---|---|
lang |
string |
The language code of the error message |
value |
string |
The text of the message. |
FileProperties
The properties of a file on a Compute Node.
Name | Type | Description |
---|---|---|
contentLength |
integer |
The length of the file. |
contentType |
string |
The content type of the file. |
creationTime |
string |
The file creation time. |
fileMode |
string |
The file mode attribute in octal format. |
lastModified |
string |
The time at which the file was last modified. |
NodeFile
Information about a file or directory on a Compute Node.
Name | Type | Description |
---|---|---|
isDirectory |
boolean |
Whether the object represents a directory. |
name |
string |
The file path. |
properties |
The file properties. |
|
url |
string |
The URL of the file. |
NodeFileListResult
The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.
Name | Type | Description |
---|---|---|
odata.nextLink |
string |
The URL to get the next set of results. |
value |
Node |
The list of files. |