File - List From Compute Node

Служба:

Batch Service

Версия API:

2024-07-01.20.0

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

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?api-version=2024-07-01.20.0

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

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
nodeId	path	True	string	Идентификатор вычислительного узла, файлы которого нужно перечислить.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
$filter	query		string	Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults	query		integer int32	Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 файлов.
recursive	query		boolean	Указывает, следует ли перечислять дочерние элементы каталога.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

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

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

Имя	Обязательно	Тип	Описание
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 напрямую.

Ответы

Имя	Тип	Описание
200 OK	NodeFileListResult	Ответ, содержащий список файлов. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

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

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

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

Области

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

Authorization

Тип: apiKey
В: header

Примеры

File list from node

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

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/files?recursive=False&api-version=2024-07-01.20.0

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

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

200

{
  "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"
      }
    }
  ]
}

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
FileProperties	Свойства файла на вычислительном узле.
NodeFile	Сведения о файле или каталоге на вычислительном узле.
NodeFileListResult	Результат перечисления файлов на вычислительном узле или файлов, связанных с задачей на вычислительном узле.

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

FileProperties

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

Имя	Тип	Описание
contentLength	integer	Длина файла.
contentType	string	Тип контента файла.
creationTime	string	Время создания файла. Время создания не возвращается для файлов на вычислительных узлах Linux.
fileMode	string	Атрибут режима файла в восьмеричном формате. Режим файла возвращается только для файлов на вычислительных узлах Linux.
lastModified	string	Время последнего изменения файла.

NodeFile

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

Имя	Тип	Описание
isDirectory	boolean	Представляет ли объект каталог.
name	string	Путь к файлу.
properties	FileProperties	Свойства файла.
url	string	URL-адрес файла.

NodeFileListResult

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

Имя	Тип	Описание
odata.nextLink	string	URL-адрес для получения следующего набора результатов.
value	NodeFile[]	Список файлов.