File - List From Compute Node

Service:

Batch Service

API-versie:

2024-07-01.20.0

Bevat alle bestanden in taakmappen op het opgegeven rekenknooppunt.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch-serviceaanvragen.
nodeId	path	True	string	De id van het rekenknooppunt waarvan u de bestanden wilt vermelden.
poolId	path	True	string	De id van de pool die het rekenknooppunt bevat.
api-version	query	True	string	Client-API-versie.
$filter	query		string	Een OData-$filter-component. Zie https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-filesvoor meer informatie over het maken van dit filter.
maxresults	query		integer int32	Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er kunnen maximaal 1000 bestanden worden geretourneerd.
recursive	query		boolean	Hiermee wordt aangegeven of onderliggende items van een map moeten worden vermeld.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	NodeFileListResult	Een antwoord met de lijst met bestanden. Kopteksten client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

File list from node

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
FileProperties	De eigenschappen van een bestand op een rekenknooppunt.
NodeFile	Informatie over een bestand of map op een rekenknooppunt.
NodeFileListResult	Het resultaat van het weergeven van de bestanden op een rekenknooppunt of de bestanden die zijn gekoppeld aan een taak op een rekenknooppunt.

BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

FileProperties

De eigenschappen van een bestand op een rekenknooppunt.

Name	Type	Description
contentLength	integer	De lengte van het bestand.
contentType	string	Het inhoudstype van het bestand.
creationTime	string	De aanmaaktijd van het bestand. De aanmaaktijd wordt niet geretourneerd voor bestanden op Linux-rekenknooppunten.
fileMode	string	Het kenmerk bestandsmodus in octale indeling. De bestandsmodus wordt alleen geretourneerd voor bestanden op Linux-rekenknooppunten.
lastModified	string	Het tijdstip waarop het bestand voor het laatst is gewijzigd.

NodeFile

Informatie over een bestand of map op een rekenknooppunt.

Name	Type	Description
isDirectory	boolean	Of het object een map vertegenwoordigt.
name	string	Het bestandspad.
properties	FileProperties	De bestandseigenschappen.
url	string	De URL van het bestand.

NodeFileListResult

Het resultaat van het weergeven van de bestanden op een rekenknooppunt of de bestanden die zijn gekoppeld aan een taak op een rekenknooppunt.

Name	Type	Description
odata.nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	NodeFile[]	De lijst met bestanden.