File - List From Compute Node

Tjänst:

Batch Service

API-version:

2024-07-01.20.0

Visar en lista över alla filer i aktivitetskataloger på den angivna beräkningsnoden.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch-tjänstbegäranden.
nodeId	path	True	string	ID:t för beräkningsnoden vars filer du vill lista.
poolId	path	True	string	ID:t för poolen som innehåller beräkningsnoden.
api-version	query	True	string	Klient-API-version.
$filter	query		string	En OData-$filter-sats. Mer information om hur du skapar det här filtret finns i https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults	query		integer int32	Det maximala antalet objekt som ska returneras i svaret. Högst 1 000 filer kan returneras.
recursive	query		boolean	Om underordnade i en katalog ska listas.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	NodeFileListResult	Ett svar som innehåller listan över filer. Sidhuvuden client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

File list from node

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
FileProperties	Egenskaperna för en fil på en beräkningsnod.
NodeFile	Information om en fil eller katalog på en beräkningsnod.
NodeFileListResult	Resultatet av att visa filerna på en beräkningsnod eller de filer som är associerade med en aktivitet på en beräkningsnod.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

FileProperties

Egenskaperna för en fil på en beräkningsnod.

Name	Typ	Description
contentLength	integer	Filens längd.
contentType	string	Filens innehållstyp.
creationTime	string	Tiden då filen skapades. Skapandetiden returneras inte för filer på Linux-beräkningsnoder.
fileMode	string	Fillägesattributet i oktalt format. Filläget returneras endast för filer på Linux-beräkningsnoder.
lastModified	string	Tidpunkten då filen senast ändrades.

NodeFile

Information om en fil eller katalog på en beräkningsnod.

Name	Typ	Description
isDirectory	boolean	Om objektet representerar en katalog.
name	string	Filsökvägen.
properties	FileProperties	Filegenskaperna.
url	string	URL:en för filen.

NodeFileListResult

Resultatet av att visa filerna på en beräkningsnod eller de filer som är associerade med en aktivitet på en beräkningsnod.

Name	Typ	Description
odata.nextLink	string	URL:en för att hämta nästa uppsättning resultat.
value	NodeFile[]	Listan över filer.