Tasks - Get Task File

Служба:

Batch Service

Версия API:

2025-06-01

Возвращает содержимое указанного файла задачи.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
filePath	path	True	string	Путь к файлу задачи, содержимое которого вы хотите получить.
jobId	path	True	string	ID работы, содержащей задачу.
taskId	path	True	string	ID задачи, файл которого вы хотите получить.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
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 напрямую.
If-Modified-Since		string (date-time-rfc7231)	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс службы был изменен с указанного времени.
If-Unmodified-Since		string (date-time-rfc7231)	Метка времени, указывающая время последнего изменения ресурса, известного клиенту. Операция будет выполнена только в том случае, если ресурс в службе не был изменен с указанного времени.
ocp-range		string	Диапазон байтов, который нужно извлечь. По умолчанию нужно получить весь файл. Формат — bytes=startRange-endRange.

Ответы

Имя	Тип	Описание
200 OK	file	Запрос выполнен успешно. Media Types: "application/octet-stream", "application/json" Заголовки Content-Length: string ETag: string Last-Modified: string client-request-id: string ocp-batch-file-isdirectory: boolean ocp-batch-file-mode: string ocp-batch-file-url: string ocp-creation-time: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке. Media Types: "application/octet-stream", "application/json"

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

OAuth2Auth

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

Области

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

Примеры

Get File From Task

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

HTTP

GET {endpoint}/jobs/jobId/tasks/task1/files/wd\testFile.txt?api-version=2025-06-01

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

Код состояния:

200

"This is actually a byte stream. This request/response is being presented as a string for readability in the example"

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

BatchError

Объект

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

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

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

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

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

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.