File - List From Compute Node

Service:

Batch Service

API Version:

2023-11-01.18.0

Wyświetla listę wszystkich plików w katalogach zadań w określonym węźle obliczeniowym.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań obsługi Azure Batch.
nodeId	path	True	string	Identyfikator węzła obliczeniowego, którego pliki chcesz wyświetlić.
poolId	path	True	string	Identyfikator puli zawierającej węzeł obliczeniowy.
api-version	query	True	string	Wersja interfejsu API klienta.
$filter	query		string	Klauzula OData $filter. Aby uzyskać więcej informacji na temat konstruowania tego filtru, zobacz https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults	query		integer int32	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Można zwrócić maksymalnie 1000 plików.
recursive	query		boolean	Określa, czy należy wyświetlić listę elementów podrzędnych katalogu.
timeout	query		integer int32	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takich jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Określa, czy serwer powinien zwrócić wartość client-request-id w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NodeFileListResult	Odpowiedź zawierająca listę plików. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

File list from node

Sample Request

HTTP

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

Status code:

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

Definicje

Nazwa	Opis
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd Azure Batch.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
FileProperties	Właściwości pliku w węźle obliczeniowym.
NodeFile	Informacje o pliku lub katalogu w węźle obliczeniowym.
NodeFileListResult	Wynik wyświetlania listy plików w węźle obliczeniowym lub plików skojarzonych z zadaniem w węźle obliczeniowym.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

FileProperties

Właściwości pliku w węźle obliczeniowym.

Nazwa	Typ	Opis
contentLength	integer	Długość pliku.
contentType	string	Typ zawartości pliku.
creationTime	string	Czas tworzenia pliku. Czas tworzenia nie jest zwracany dla plików w węzłach obliczeniowych systemu Linux.
fileMode	string	Atrybut trybu pliku w formacie ósemkowym. Tryb pliku jest zwracany tylko dla plików w węzłach obliczeniowych systemu Linux.
lastModified	string	Czas ostatniej modyfikacji pliku.

NodeFile

Informacje o pliku lub katalogu w węźle obliczeniowym.

Nazwa	Typ	Opis
isDirectory	boolean	Określa, czy obiekt reprezentuje katalog.
name	string	Ścieżka do pliku.
properties	FileProperties	Właściwości pliku.
url	string	Adres URL pliku.

NodeFileListResult

Wynik wyświetlania listy plików w węźle obliczeniowym lub plików skojarzonych z zadaniem w węźle obliczeniowym.

Nazwa	Typ	Opis
odata.nextLink	string	Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value	NodeFile[]	Lista plików.