File - List From Task

Service:

Batch Service

API Version:

2023-11-01.18.0

Egy tevékenység könyvtárában lévő fájlokat sorolja fel a számítási csomóponton.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
jobId	path	True	string	A feladatot tartalmazó feladat azonosítója.
taskId	path	True	string	Annak a tevékenységnek az azonosítója, amelynek a fájljait listázni szeretné.
api-version	query	True	string	Ügyfél API-verziója.
$filter	query		string	OData $filter záradék. A szűrő felépítésével kapcsolatos további információkért lásd: https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer int32	A válaszban visszaadandó elemek maximális száma. Legfeljebb 1000 fájl adható vissza.
recursive	query		boolean	A Feladat könyvtár gyermekeinek listázása. Ez a paraméter a szűrőparaméterrel együtt használható adott fájltípusok listázására.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Válaszok

Name	Típus	Description
200 OK	NodeFileListResult	A fájlok listáját tartalmazó válasz. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

File list from task

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2023-11-01.18.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"
      }
    }
  ]
}

Definíciók

Name	Description
BatchError	A Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail	A Azure Batch hibaválaszban szereplő további információk egy eleme.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.
FileProperties	Egy számítási csomóponton lévő fájl tulajdonságai.
NodeFile	Egy számítási csomóponton található fájlra vagy könyvtárra vonatkozó információk.
NodeFileListResult	A számítási csomóponton lévő fájlok listázásának eredménye, vagy a számítási csomóponton lévő tevékenységhez társított fájlok.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Az Érték tulajdonság jelentését meghatározó azonosító.
value	string	A hibaválaszban szereplő további információk.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.

FileProperties

Egy számítási csomóponton lévő fájl tulajdonságai.

Name	Típus	Description
contentLength	integer	A fájl hossza.
contentType	string	A fájl tartalomtípusa.
creationTime	string	A fájllétrehozás ideje. A rendszer nem adja vissza a létrehozási időt a Linux számítási csomópontokon lévő fájlok esetében.
fileMode	string	A fájlmód attribútum oktális formátumban. A fájlmód csak Linux számítási csomópontokon lévő fájlok esetén lesz visszaadva.
lastModified	string	A fájl utolsó módosításának időpontja.

NodeFile

Egy számítási csomóponton található fájlra vagy könyvtárra vonatkozó információk.

Name	Típus	Description
isDirectory	boolean	Azt jelzi, hogy az objektum egy könyvtárat jelöl-e.
name	string	A fájl elérési útja.
properties	FileProperties	A fájl tulajdonságai.
url	string	A fájl URL-címe.

NodeFileListResult

A számítási csomóponton lévő fájlok listázásának eredménye, vagy a számítási csomóponton lévő tevékenységhez társított fájlok.

Name	Típus	Description
odata.nextLink	string	A következő eredményhalmaz lekéréséhez tartozó URL-cím.
value	NodeFile[]	A fájlok listája.