File - List From Task

  • Ссылка
Service:
Batch Service
API Version:
2022-01-01.15.0

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

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?api-version=2022-01-01.15.0
With optional parameters: 
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name In Required Type Description
batchUrl
 path True
  • string

Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
jobId
 path True
  • string

Идентификатор задания, содержащего задачу.
taskId
 path True
  • string

Идентификатор задачи, файлы которой нужно перечислить.
api-version
 query True
  • string

Версия API клиента.
$filter
 query
  • string

Предложение $filter OData. Дополнительные сведения о создании этого фильтра см. в разделе https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults
 query
  • integer
int32

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

Указывает, следует ли перечислять дочерние элементы каталога задач. Этот параметр можно использовать в сочетании с параметром фильтра для вывода списка определенных типов файлов.
timeout
 query
  • integer
int32

Максимальное время, которое сервер может потратить на обработку запроса в секундах. По умолчанию это 30 секунд.

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

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id
  • string
uuid

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

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

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

Ответы

Name Type Description
200 OK

Ответ, содержащий список файлов.

Headers

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

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

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

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

File list from task

Sample Request

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2022-01-01.15.0

Sample Response

Status code:
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": "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/jobs/jobId/tasks/taskId/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"
      }
    }
  ]
}

Определения

BatchError

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

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

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

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

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

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

BatchError

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

Name Type Description
code
  • string

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

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

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

BatchErrorDetail

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

Name Type Description
key
  • string

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

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

ErrorMessage

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

Name Type Description
lang
  • string

Код языка сообщения об ошибке
value
  • string

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

FileProperties

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

Name Type Description
contentLength
  • integer

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

Тип содержимого файла.
creationTime
  • string

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

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

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

NodeFile

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

Name Type Description
isDirectory
  • boolean

Указывает, представляет ли объект каталог.
name
  • string

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

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

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

NodeFileListResult

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

Name Type Description
odata.nextLink
  • string

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

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