File - List From Task

Usługa:

Batch Service

Wersja interfejsu API:

2023-11-01.18.0

Wyświetla listę plików w katalogu zadania w węźle obliczeniowym.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?api-version=2023-11-01.18.0

Z parametrami opcjonalnymi:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/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 wszystkich żądań obsługi Azure Batch.
jobId	path	True	string	Identyfikator zadania zawierającego zadanie.
taskId	path	True	string	Identyfikator zadania, którego pliki chcesz wyświetlić.
api-version	query	True	string	Wersja interfejsu API klienta.
$filter	query		string	Klauzula $filter OData. 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-task-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	Czy wyświetlić listę elementów podrzędnych katalogu Task. Ten parametr można użyć w połączeniu z parametrem filtru, aby wyświetlić listę określonych typów plików.
timeout	query		integer int32	Maksymalny czas, który serwer może poświęcić na przetwarzanie żądania 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, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	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. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

File list from task

Przykładowe żądanie

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2023-11-01.18.0

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
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

Odpowiedź o błędzie odebrana 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 Azure Batch błędu.

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	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.