Tasks - List Task Files

Служба:
Batch Service
Версия API:
2025-06-01

Перечисляет файлы в каталоге задачи на его вычислительном узле.

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/files?api-version=2025-06-01
С использованием необязательных параметров: 
GET {endpoint}/jobs/{jobId}/tasks/{taskId}/files?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&recursive={recursive}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (uri)

Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
jobId
 path True

string

ID работы, содержащей задачу.
taskId
 path True

string

ID задачи, файлы которой вы хотите перечислить.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.
$filter
 query

string

Предложение OData $filter. Для получения дополнительной информации о построении этого фильтра см. https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.
recursive
 query

boolean

Стоит ли указывать потомки из каталога задач. Этот параметр может использоваться в сочетании с параметром фильтра для перечисления определённых типов файлов.
timeOut
 query

integer (int32)

Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

Имя Обязательно Тип Описание
client-request-id

string

Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date

string (date-time-rfc7231)

Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

Имя Тип Описание
200 OK

BatchNodeFileListResult

Запрос выполнен успешно.

Заголовки

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя Описание
https://batch.core.windows.net//.default

Примеры

File list from task

Образец запроса

GET {endpoint}/jobs/jobId/tasks/taskId/files?api-version=2025-06-01&recursive=False

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "name": "startup\\ProcessEnv.cmd",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup/ProcessEnv.cmd",
      "isDirectory": false,
      "properties": {
        "creationTime": "2025-09-19T21:56:17.679195Z",
        "lastModified": "2025-09-19T21:56:17.679195Z",
        "contentLength": "1813",
        "contentType": "application/octet-stream"
      }
    },
    {
      "name": "startup\\stderr.txt",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup/stderr.txt",
      "isDirectory": false,
      "properties": {
        "creationTime": "2025-09-19T21:56:17.5590855Z",
        "lastModified": "2025-09-19T21:56:17.5590855Z",
        "contentLength": "0",
        "contentType": "application/octet-stream"
      }
    }
  ]
}

Определения

Имя Описание
BatchError

Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchNodeFile

Сведения о файле или каталоге на вычислительном узле.
BatchNodeFileListResult

Результат перечисления файлов на вычислительном узле или файлов, связанных с задачей на вычислительном узле.
FileProperties

Свойства файла на вычислительном узле.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message

BatchErrorMessage

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.
value

string

Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя Тип Описание
lang

string

Языковой код сообщения об ошибке.
value

string

Текст сообщения.

BatchNodeFile

Объект

Сведения о файле или каталоге на вычислительном узле.

Имя Тип Описание
isDirectory

boolean

Представляет ли объект каталог.
name

string

Путь к файлу.
properties

FileProperties

Свойства файла.
url

string (uri)

URL-адрес файла.

BatchNodeFileListResult

Объект

Результат перечисления файлов на вычислительном узле или файлов, связанных с задачей на вычислительном узле.

Имя Тип Описание
odata.nextLink

string (uri)

URL-адрес для получения следующего набора результатов.
value

BatchNodeFile[]

Список файлов.

FileProperties

Объект

Свойства файла на вычислительном узле.

Имя Тип Описание
contentLength

string (int64)

Длина файла.
contentType

string

Тип контента файла.
creationTime

string (date-time)

Время создания файла. Время создания не возвращается для файлов на вычислительных узлах Linux.
fileMode

string

Атрибут режима файла в восьмиметрическом формате. Файловый режим возвращается только для файлов на вычислительных узлах Linux.
lastModified

string (date-time)

Время последней модификации файла.