File - List From Compute Node

Riferimento

Service:: Batch Service

API Version:: 2023-11-01.18.0

Elenca tutti i file nelle directory attività nel nodo di calcolo specificato.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste di servizio Azure Batch.
nodeId	path	True	string	ID del nodo di calcolo i cui file da elencare.
poolId	path	True	string	ID del pool contenente il nodo di calcolo.
api-version	query	True	string	Versione dell'API client.
$filter	query		string	Clausola OData $filter. Per altre informazioni sulla costruzione di questo filtro, vedere https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults	query		integer int32	Numero massimo di elementi da restituire nella risposta. È possibile restituire un massimo di 1000 file.
recursive	query		boolean	Indica se elencare elementi figlio di una directory.
timeout	query		integer int32	Tempo massimo per cui il server può trascorrere l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

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

Nome	Tipo	Descrizione
client-request-id	string uuid	Identità richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50E-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se il server deve restituire l'ID richiesta client nella risposta.
ocp-date	string date-time-rfc1123	Ora in cui è stata eseguita la richiesta. Le librerie client in genere impostano l'ora dell'orologio del sistema corrente; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome	Tipo	Descrizione
200 OK	NodeFileListResult	Risposta contenente l'elenco di file. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Errore dal servizio Batch.

Nome

Tipo

Descrizione

200 OK

NodeFileListResult

Risposta contenente l'elenco di file.

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Errore dal servizio Batch.

Sicurezza

azure_auth

Microsoft Entra flusso di codice di autenticazione OAuth 2.0

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

File list from node

Sample Request

HTTP

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

Sample Response

Status code:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore Azure Batch.
FileProperties	Proprietà di un file in un nodo di calcolo.
NodeFile	Informazioni su un file o una directory in un nodo di calcolo.
NodeFileListResult	Risultato dell'elenco dei file in un nodo di calcolo o dei file associati a un'attività in un nodo di calcolo.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta all'errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice del linguaggio del messaggio di errore
value	string	Testo del messaggio.

FileProperties

Proprietà di un file in un nodo di calcolo.

Nome	Tipo	Descrizione
contentLength	integer	Lunghezza del file.
contentType	string	Il tipo di contenuto del file.
creationTime	string	Ora di creazione del file. Il tempo di creazione non viene restituito per i file nei nodi di calcolo Linux.
fileMode	string	Attributo della modalità file in formato ottale. La modalità file viene restituita solo per i file nei nodi di calcolo Linux.
lastModified	string	Ora in cui il file è stato modificato.

NodeFile

Informazioni su un file o una directory in un nodo di calcolo.

Nome	Tipo	Descrizione
isDirectory	boolean	Indica se l'oggetto rappresenta una directory.
name	string	Percorso del file.
properties	FileProperties	Proprietà del file.
url	string	URL del file.

NodeFileListResult

Risultato dell'elenco dei file in un nodo di calcolo o dei file associati a un'attività in un nodo di calcolo.

Nome	Tipo	Descrizione
odata.nextLink	string	URL per ottenere il set successivo di risultati.
value	NodeFile[]	Elenco di file.

Share via

File - List From Compute Node

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Authorization

Esempio

File list from node

Sample Request

Sample Response

Definizioni

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

Risorse aggiuntive