Path - List

Service:

Storage Services

Version d'API:

2023-08-03

Répertorier les chemins d’accès et leurs propriétés dans le système de fichiers donné.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem

Avec des paramètres facultatifs:

GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte stockage Azure.
dnsSuffix	path	True	string	Suffixe DNS pour le point de terminaison Azure Data Lake Storage.
filesystem	path	True	string minLength: 3 maxLength: 63 pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$	Identificateur du système de fichiers. La valeur doit commencer et se terminer par une lettre ou un nombre et doit contenir uniquement des lettres, des chiffres et le caractère de tiret (-). Les tirets consécutifs ne sont pas autorisés. Toutes les lettres doivent être minuscules. La valeur doit comporter entre 3 et 63 caractères.
recursive	query	True	boolean	Si la valeur est « true », tous les chemins sont répertoriés ; sinon, seuls les chemins à la racine du système de fichiers sont répertoriés. Si « répertoire » est spécifié, la liste inclut uniquement les chemins d’accès qui partagent la même racine.
resource	query	True	FilesystemResourceType	La valeur doit être « filesystem » pour toutes les opérations de système de fichiers.
continuation	query		string	Le nombre de chemins retournés avec chaque appel est limité. Si le nombre de chemins à renvoyer dépasse cette limite, un jeton de continuation est retourné dans l’en-tête de réponse x-ms-continuation. Lorsqu’un jeton de continuation est retourné dans la réponse, il doit être spécifié dans un appel ultérieur de l’opération de liste pour continuer à répertorier les chemins d’accès. Notez que le jeton de continuation retourné dans l’en-tête de réponse x-ms-continuation doit être codé d’URL avant d’être utilisé dans un appel ultérieur.
directory	query		string	Filtre les résultats des chemins d’accès dans le répertoire spécifié. Une erreur se produit si le répertoire n’existe pas.
maxResults	query		integer (int32) minimum: 1	Valeur facultative qui spécifie le nombre maximal d’éléments à retourner. Si elle est omise ou supérieure à 5 000, la réponse inclut jusqu’à 5 000 éléments.
timeout	query		integer (int32) minimum: 1	Valeur de délai d’expiration d’opération facultative en secondes. La période commence lorsque la demande est reçue par le service. Si la valeur de délai d’expiration s’écoule avant la fin de l’opération, l’opération échoue.
upn	query		boolean	Optionnel. Valide uniquement lorsque l’espace de noms hiérarchique est activé pour le compte. Si la valeur est « true », les valeurs d’identité utilisateur retournées dans les champs propriétaire et groupe de chaque entrée de liste sont transformées des ID d’objet Azure Active Directory en noms d’utilisateur principaux. Si la valeur est « false », les valeurs sont retournées en tant qu’ID d’objet Azure Active Directory. La valeur par défaut est false. Notez que les ID d’objet de groupe et d’application ne sont pas traduits, car ils n’ont pas de noms conviviaux uniques.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$	Un UUID enregistré dans les journaux d’activité d’analytique pour la résolution des problèmes et la corrélation.
x-ms-date		string	Spécifie le temps universel coordonné (UTC) de la requête. Cela est nécessaire lors de l’utilisation de l’autorisation de clé partagée.
x-ms-version		string	Spécifie la version du protocole REST utilisée pour le traitement de la requête. Cela est nécessaire lors de l’utilisation de l’autorisation de clé partagée.

Réponses

Nom	Type	Description
200 OK	PathList	D’accord En-têtes Date: string ETag: string Last-Modified: string x-ms-request-id: string x-ms-version: string x-ms-continuation: string x-ms-encryption-scope: string
Other Status Codes	DataLakeStorageError	Une erreur s’est produite. L’état HTTP, le code et les chaînes de message possibles sont répertoriés ci-dessous : 400 Demande incorrecte, ContentLengthMustBeZero, « L’en-tête de requête Content-Length doit être égal à zéro ». 400 Demande incorrecte, InvalidAuthenticationInfo, « Les informations d’authentification ne sont pas fournies au format correct. Vérifiez la valeur de l’en-tête d’autorisation. » 400 Demande incorrecte, InvalidFlushPosition, « Les données chargées ne sont pas contiguës ou la valeur du paramètre de requête position n’est pas égale à la longueur du fichier après l’ajout des données chargées ». 400 Requête incorrecte, InvalidHeaderValue, « La valeur de l’un des en-têtes HTTP n’est pas au format correct ». 400 Requête incorrecte, InvalidHttpVerb, « Le verbe HTTP spécifié n’est pas valide ; il n’est pas reconnu par le serveur ». 400 Demande incorrecte, InvalidInput, « L’une des entrées de requête n’est pas valide ». 400 Requête incorrecte, InvalidPropertyName, « Un nom de propriété ne peut pas être vide ». 400 Requête incorrecte, InvalidPropertyName, « Le nom de la propriété contient des caractères non valides ». 400 Requête incorrecte, InvalidQueryParameterValue, « La valeur de l’un des paramètres de requête spécifiés dans l’URI de requête n’est pas valide ». 400 Requête incorrecte, InvalidResourceName, « Le nom de ressource spécifié contient des caractères non valides ». 400 Requête incorrecte, InvalidSourceUri, « L’URI source n’est pas valide ». 400 Requête incorrecte, InvalidUri, « L’URI de la requête n’est pas valide ». 400 Requête incorrecte, MissingRequiredHeader, « Un en-tête HTTP obligatoire pour cette requête n’est pas spécifié ». 400 Requête incorrecte, MissingRequiredQueryParameter, « Paramètre de requête obligatoire pour cette requête n’est pas spécifié ». 400 Demande incorrecte, MultipleConditionHeadersNotSupported, « Les en-têtes de condition multiples ne sont pas pris en charge ». 400 Requête incorrecte, OutOfRangeInput, « L’une des entrées de requête est hors limites ». 400 Requête incorrecte, OutOfRangeQueryParameterValue, « L’un des paramètres de requête spécifiés dans l’URI de requête est en dehors de la plage autorisée ». 400 Demande incorrecte, UnsupportedHeader, « L’un des en-têtes spécifiés dans la requête n’est pas pris en charge ». 400 Requête incorrecte, UnsupportedQueryParameter, « L’un des paramètres de requête spécifiés dans l’URI de requête n’est pas pris en charge ». 400 Demande incorrecte, UnsupportedRestVersion, « La version rest spécifiée n’est pas prise en charge ». 403 Interdit, AccountIsDisabled, « Le compte spécifié est désactivé ». 403 Interdit, AuthorizationFailure, « Cette demande n’est pas autorisée à effectuer cette opération. » 403 Interdit, InsufficientAccountPermissions, « Le compte accessible ne dispose pas des autorisations suffisantes pour exécuter cette opération ». 404 Introuvable, FilesystemNotFound, « Le système de fichiers spécifié n’existe pas ». 404 Introuvable, PathNotFound, « Le chemin spécifié n’existe pas ». 404 Introuvable, RenameDestinationParentPathNotFound, « Le répertoire parent du chemin de destination n’existe pas ». 404 Introuvable, ResourceNotFound, « La ressource spécifiée n’existe pas ». 404 Introuvable, SourcePathNotFound, « Le chemin source d’une opération de renommage n’existe pas ». Méthode 405 Non autorisée, UnsupportedHttpVerb, « La ressource ne prend pas en charge le verbe HTTP spécifié ». Conflit 409, DestinationPathIsBeingDeleted, « Le chemin de destination spécifié est marqué pour être supprimé ». 409 Conflict, DirectoryNotEmpty, « La valeur du paramètre de requête récursive doit être true pour supprimer un répertoire non vide ». Conflit 409, FilesystemAlreadyExists, « Le système de fichiers spécifié existe déjà ». 409 Conflit, FilesystemBeingDeleted, « Le système de fichiers spécifié est supprimé ». 409 Conflict, InvalidDestinationPath, « The specified path, or an element of the path, exists and its resource type is invalid for this operation ». * 409 Conflict, InvalidFlushOperation, « La ressource a été créée ou modifiée par l’API du service Blob et ne peut pas être écrite par l’API du service Data Lake Storage ». 409 Conflict, InvalidRenameSourcePath, « Le répertoire source ne peut pas être identique au répertoire de destination, ni la destination ne peut pas être un sous-répertoire du répertoire source ». 409 Conflict, InvalidSourceOrDestinationResourceType, « Le type de ressource source et de destination doit être identique ». 409 Conflit, LeaseAlreadyPresent, « Il y a déjà un bail présent. » 409 Conflict, LeaseIdMismatchWithLeaseOperation, « L’ID de bail spécifié ne correspondait pas à l’ID de bail de la ressource avec l’opération de bail spécifiée. » 409 Conflit, LeaseIsAlreadyBroken, « Le bail a déjà été rompu et ne peut pas être rompu à nouveau. » 409 Conflit, LeaseIsBreakingAndCannotBeAcquired, « L’ID de bail mis en correspondance, mais le bail est actuellement en état de rupture et ne peut pas être acquis tant qu’il n’est pas rompu ». 409 Conflit, LeaseIsBreakingAndCannotBeChanged, « L’ID de bail correspond, mais le bail est actuellement en état cassant et ne peut pas être modifié ». 409 Conflit, LeaseIsBrokenAndCannotBeRenewed, « L’ID de bail correspond, mais le bail a été rompu explicitement et ne peut pas être renouvelé ». 409 Conflit, LeaseNameMismatch, « Le nom du bail spécifié ne correspondait pas au nom de bail existant ». 409 Conflit, LeaseNotPresentWithLeaseOperation, « L’ID de bail n’est pas présent avec l’opération de bail spécifiée ». 409 Conflit, PathAlreadyExists, « Le chemin spécifié existe déjà ». 409 Conflict, PathConflict, « The specified path, or an element of the path, exists and its resource type is invalid for this operation ». 409 Conflict, SourcePathIsBeingDeleted, « Le chemin source spécifié est marqué pour être supprimé ». 409 Conflit, ResourceTypeMismatch, « Le type de ressource spécifié dans la requête ne correspond pas au type de la ressource ». 412 Échec de la condition préalable, ConditionNotMet, « La condition spécifiée à l’aide des en-têtes conditionnels HTTP n’est pas remplie ». 412 Échec de la condition préalable, LeaseIdMismatch, « L’ID de bail spécifié ne correspondait pas à l’ID de bail de la ressource ». 412 Échec de la condition préalable, LeaseIdMissing, « Il existe actuellement un bail sur la ressource et aucun ID de bail n’a été spécifié dans la demande. » 412 Échec de la condition préalable, LeaseNotPresent, « Il n’existe actuellement aucun bail sur la ressource ». 412 Échec de la condition préalable, LeaseLost, « Un ID de bail a été spécifié, mais le bail de la ressource a expiré ». 412 Échec de la condition préalable, SourceConditionNotMet, « La condition source spécifiée à l’aide des en-têtes conditionnels HTTP n’est pas remplie ». 413 Entité de requête trop grande, RequestBodyTooLarge, « Le corps de la requête est trop grand et dépasse la limite maximale autorisée ». 416 Plage demandée non satisfiable, InvalidRange, « La plage spécifiée n’est pas valide pour la taille actuelle de la ressource ». 500 Erreur de serveur interne, InternalError, « Le serveur a rencontré une erreur interne. Réessayez la demande. » Erreur de serveur interne 500, OperationTimedOut, « L’opération n’a pas pu être terminée dans le délai autorisé ». 503 Service indisponible, ServerBusy, « La sortie dépasse la limite de compte ». 503 Service indisponible, ServerBusy, « Entrée dépasse la limite de compte ». 503 Service indisponible, ServerBusy, « Les opérations par seconde dépassent la limite de compte ». 503 Service indisponible, ServerBusy, « Le serveur n’est actuellement pas en mesure de recevoir des demandes. Veuillez réessayer votre demande. En-têtes x-ms-request-id: string x-ms-version: string

Définitions

Nom	Description
DataLakeStorageError
Error	Objet de réponse d’erreur de service.
FilesystemResourceType	La valeur doit être « filesystem » pour toutes les opérations de système de fichiers.
Path
PathList

DataLakeStorageError

Object

Nom	Type	Description
error	Error	Objet de réponse d’erreur de service.

Error

Object

Objet de réponse d’erreur de service.

Nom	Type	Description
code	string	Code d’erreur du service.
message	string	Message d’erreur du service.

FilesystemResourceType

Énumération

La valeur doit être « filesystem » pour toutes les opérations de système de fichiers.

Valeur	Description
filesystem

Path

Object

Nom	Type	Valeur par défaut	Description
contentLength	integer (int64)
etag	string
group	string
isDirectory	boolean	False
lastModified	string
name	string
owner	string
permissions	string
x-ms-encryption-context	string		Si la valeur de la propriété de contexte de chiffrement est définie, elle retourne la valeur définie. Valide uniquement lorsque l’espace de noms hiérarchique est activé pour le compte.
x-ms-encryption-key-sha256	string		Le serveur renvoie la sha256 de la clé de chiffrement fournie par le client pour valider la clé utilisée dans l’opération.
x-ms-encryption-scope	string		Si la demande a utilisé une étendue de chiffrement, le client peut s’assurer que le contenu de la requête est correctement chiffré à l’aide de l’étendue de chiffrement.
x-ms-server-encrypted: true/false	boolean		La valeur de cet en-tête est définie sur true si le contenu de la requête est correctement chiffré à l’aide de l’algorithme spécifié.

PathList

Object

Nom	Type	Description
paths	Path[]