File - List From Task

Služba:

Batch Service

Verze rozhraní API:

2023-11-01.18.0

Zobrazí seznam souborů v adresáři úkolu na jeho výpočetním uzlu.

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

S volitelnými parametry:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
jobId	path	True	string	ID úlohy, která obsahuje úkol.
taskId	path	True	string	ID úkolu, jehož soubory chcete vypsat.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru najdete v tématu https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer int32	Maximální počet položek, které se mají v odpovědi vrátit. Může se vrátit maximálně 1000 souborů.
recursive	query		boolean	Určuje, zda se mají zobrazit podřízené položky adresáře úkolů. Tento parametr lze použít v kombinaci s parametrem filtru k výpisu konkrétního typu souborů.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Odpovědi

Name	Typ	Description
200 OK	NodeFileListResult	Odpověď obsahující seznam souborů. Hlavičky client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

File list from task

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
FileProperties	Vlastnosti souboru na výpočetním uzlu.
NodeFile	Informace o souboru nebo adresáři na výpočetním uzlu.
NodeFileListResult	Výsledek výpisu souborů na výpočetním uzlu nebo souborů přidružených k úkolu na výpočetním uzlu.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

FileProperties

Vlastnosti souboru na výpočetním uzlu.

Name	Typ	Description
contentLength	integer	Délka souboru.
contentType	string	Typ obsahu souboru.
creationTime	string	Čas vytvoření souboru. Čas vytvoření se nevrací pro soubory na výpočetních uzlech s Linuxem.
fileMode	string	Atribut file mode v osmičkovém formátu. Režim souborů se vrátí jenom pro soubory na výpočetních uzlech s Linuxem.
lastModified	string	Čas poslední změny souboru.

NodeFile

Informace o souboru nebo adresáři na výpočetním uzlu.

Name	Typ	Description
isDirectory	boolean	Určuje, zda objekt představuje adresář.
name	string	Cesta k souboru.
properties	FileProperties	Vlastnosti souboru.
url	string	Adresa URL souboru.

NodeFileListResult

Výsledek výpisu souborů na výpočetním uzlu nebo souborů přidružených k úkolu na výpočetním uzlu.

Name	Typ	Description
odata.nextLink	string	Adresa URL pro získání další sady výsledků
value	NodeFile[]	Seznam souborů.