File - List From Compute Node

Référence

Service:: Batch Service

Version d'API:: 2024-07-01.20.0

Répertorie tous les fichiers dans les répertoires de tâches sur le nœud de calcul spécifié.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
nodeId	path	True	string	ID du nœud de calcul dont vous souhaitez lister les fichiers.
poolId	path	True	string	ID du pool qui contient le nœud de calcul.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults	query		integer int32	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 fichiers peuvent être retournés.
recursive	query		boolean	Indique s’il faut répertorier les enfants d’un répertoire.
timeout	query		integer int32	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place.

En-tête de la demande

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

Nom	Type	Description
client-request-id	string uuid	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Indique si le serveur doit retourner l’ID client-request-id dans la réponse.
ocp-date	string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

Réponses

Nom	Type	Description
200 OK	NodeFileListResult	Réponse contenant la liste des fichiers. En-têtes client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch.

Nom

Type

Description

200 OK

NodeFileListResult

Réponse contenant la liste des fichiers.

En-têtes

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

Other Status Codes

BatchError

Erreur du service Batch.

Sécurité

azure_auth

Flux de code d’authentification Microsoft Entra OAuth 2.0

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
Dans: header

Exemples

File list from node

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
FileProperties	Propriétés d’un fichier sur un nœud de calcul.
NodeFile	Informations sur un fichier ou un répertoire sur un nœud de calcul.
NodeFileListResult	Résultat de la liste des fichiers sur un nœud de calcul ou des fichiers associés à une tâche sur un nœud de calcul.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.

FileProperties

Propriétés d’un fichier sur un nœud de calcul.

Nom	Type	Description
contentLength	integer	Longueur du fichier.
contentType	string	Type de contenu du fichier.
creationTime	string	Heure de création du fichier. L’heure de création n’est pas retournée pour les fichiers sur les nœuds de calcul Linux.
fileMode	string	Attribut du mode fichier au format octal. Le mode fichier est retourné uniquement pour les fichiers sur les nœuds de calcul Linux.
lastModified	string	Heure à laquelle le fichier a été modifié pour la dernière fois.

NodeFile

Informations sur un fichier ou un répertoire sur un nœud de calcul.

Nom	Type	Description
isDirectory	boolean	Indique si l’objet représente un répertoire.
name	string	Chemin d'accès au fichier.
properties	FileProperties	Propriétés du fichier.
url	string	URL du fichier.

NodeFileListResult

Résultat de la liste des fichiers sur un nœud de calcul ou des fichiers associés à une tâche sur un nœud de calcul.

Nom	Type	Description
odata.nextLink	string	URL permettant d’obtenir le jeu de résultats suivant.
value	NodeFile[]	Liste des fichiers.

Partager via

File - List From Compute Node

Paramètres URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Étendues

Authorization

Exemples

File list from node

Exemple de requête

Exemple de réponse

Définitions

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

Ressources supplémentaires