File - List From Compute Node

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Listet alle Dateien in Aufgabenverzeichnissen auf dem angegebenen Computeknoten auf.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
batchUrl
 path True

string

Die Basis-URL für alle Azure Batch-Dienstanforderungen.
nodeId
 path True

string

Die ID des Computeknotens, dessen Dateien Sie auflisten möchten.
poolId
 path True

string

Die ID des Pools, der den Computeknoten enthält.
api-version
 query True

string

Client-API-Version.
$filter
 query

string

Eine OData-$filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults
 query

integer

int32

Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Maximal 1000 Dateien können zurückgegeben werden.
recursive
 query

boolean

Gibt an, ob untergeordnete Elemente eines Verzeichnisses aufgeführt werden sollen.
timeout
 query

integer

int32

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
client-request-id

string

uuid

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date

string

date-time-rfc1123

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name Typ Beschreibung
200 OK

NodeFileListResult

Eine Antwort, die die Liste der Dateien enthält.

Header

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

File list from node

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.
ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
FileProperties

Die Eigenschaften einer Datei auf einem Computeknoten.
NodeFile

Informationen zu einer Datei oder einem Verzeichnis auf einem Computeknoten.
NodeFileListResult

Das Ergebnis der Auflistung der Dateien auf einem Computeknoten oder der Dateien, die einer Aufgabe auf einem Computeknoten zugeordnet sind.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message

ErrorMessage

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
values

BatchErrorDetail[]

Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch-Fehlerantwort enthalten sind.

Name Typ Beschreibung
key

string

Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value

string

Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

Name Typ Beschreibung
lang

string

Der Sprachcode der Fehlermeldung
value

string

Der Text der Nachricht.

FileProperties

Die Eigenschaften einer Datei auf einem Computeknoten.

Name Typ Beschreibung
contentLength

integer

Die Länge der Datei.
contentType

string

Der Inhaltstyp der Datei.
creationTime

string

Die Erstellungszeit der Datei.
Die Erstellungszeit wird für Dateien auf Linux-Computeknoten nicht zurückgegeben.
fileMode

string

Das Dateimodus-Attribut im oktalen Format.
Der Dateimodus wird nur für Dateien auf Linux-Computeknoten zurückgegeben.
lastModified

string

Der Zeitpunkt, zu dem die Datei zuletzt geändert wurde.

NodeFile

Informationen zu einer Datei oder einem Verzeichnis auf einem Computeknoten.

Name Typ Beschreibung
isDirectory

boolean

Gibt an, ob das Objekt ein Verzeichnis darstellt.
name

string

Der Dateipfad.
properties

FileProperties

Die Dateieigenschaften.
url

string

Die URL der Datei.

NodeFileListResult

Das Ergebnis der Auflistung der Dateien auf einem Computeknoten oder der Dateien, die einer Aufgabe auf einem Computeknoten zugeordnet sind.

Name Typ Beschreibung
odata.nextLink

string

Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value

NodeFile[]

Die Liste der Dateien.