Share via

Path - List

  • Reference
Service:
Storage Services
API Version:
2023-08-03

List paths and their properties in given filesystem.

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

URI Parameters

Name In Required Type Description
accountName
 path True

string

The Azure Storage account name.
dnsSuffix
 path True

string

The DNS suffix for the Azure Data Lake Storage endpoint.
filesystem
 path True

string

The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters.

Regex pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

If "true", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If "directory" is specified, the list will only include paths that share the same root.
resource
 query True

FilesystemResourceType

The value must be "filesystem" for all filesystem operations.
continuation
 query

string

The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths. Note that the continuation token returned in the response header x-ms-continuation must be URL encoded before being used in a subsequent invocation.
directory
 query

string

Filters results to paths within the specified directory. An error occurs if the directory does not exist.
maxResults
 query

integer

int32

An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.
timeout
 query

integer

int32

An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.
upn
 query

boolean

Optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.

Request Header

Name Required Type Description
x-ms-client-request-id

string

A UUID recorded in the analytics logs for troubleshooting and correlation.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.
x-ms-version

string

Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.

Responses

Name Type Description
200 OK

PathList

Ok

Headers

  • 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

An error occurred. The possible HTTP status, code, and message strings are listed below:

  • 400 Bad Request, ContentLengthMustBeZero, "The Content-Length request header must be zero."
  • 400 Bad Request, InvalidAuthenticationInfo, "Authentication information is not given in the correct format. Check the value of Authorization header."
  • 400 Bad Request, InvalidFlushPosition, "The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data."
  • 400 Bad Request, InvalidHeaderValue, "The value for one of the HTTP headers is not in the correct format."
  • 400 Bad Request, InvalidHttpVerb, "The HTTP verb specified is invalid - it is not recognized by the server."
  • 400 Bad Request, InvalidInput, "One of the request inputs is not valid."
  • 400 Bad Request, InvalidPropertyName, "A property name cannot be empty."
  • 400 Bad Request, InvalidPropertyName, "The property name contains invalid characters."
  • 400 Bad Request, InvalidQueryParameterValue, "Value for one of the query parameters specified in the request URI is invalid."
  • 400 Bad Request, InvalidResourceName, "The specified resource name contains invalid characters."
  • 400 Bad Request, InvalidSourceUri, "The source URI is invalid."
  • 400 Bad Request, InvalidUri, "The request URI is invalid."
  • 400 Bad Request, MissingRequiredHeader, "An HTTP header that's mandatory for this request is not specified."
  • 400 Bad Request, MissingRequiredQueryParameter, "A query parameter that's mandatory for this request is not specified."
  • 400 Bad Request, MultipleConditionHeadersNotSupported, "Multiple condition headers are not supported."
  • 400 Bad Request, OutOfRangeInput, "One of the request inputs is out of range."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "One of the query parameters specified in the request URI is outside the permissible range."
  • 400 Bad Request, UnsupportedHeader, "One of the headers specified in the request is not supported."
  • 400 Bad Request, UnsupportedQueryParameter, "One of the query parameters specified in the request URI is not supported."
  • 400 Bad Request, UnsupportedRestVersion, "The specified Rest Version is Unsupported."
  • 403 Forbidden, AccountIsDisabled, "The specified account is disabled."
  • 403 Forbidden, AuthorizationFailure, "This request is not authorized to perform this operation."
  • 403 Forbidden, InsufficientAccountPermissions, "The account being accessed does not have sufficient permissions to execute this operation."
  • 404 Not Found, FilesystemNotFound, "The specified filesystem does not exist."
  • 404 Not Found, PathNotFound, "The specified path does not exist."
  • 404 Not Found, RenameDestinationParentPathNotFound, "The parent directory of the destination path does not exist."
  • 404 Not Found, ResourceNotFound, "The specified resource does not exist."
  • 404 Not Found, SourcePathNotFound, "The source path for a rename operation does not exist."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "The resource doesn't support the specified HTTP verb."
  • 409 Conflict, DestinationPathIsBeingDeleted, "The specified destination path is marked to be deleted."
  • 409 Conflict, DirectoryNotEmpty, "The recursive query parameter value must be true to delete a non-empty directory."
  • 409 Conflict, FilesystemAlreadyExists, "The specified filesystem already exists."
  • 409 Conflict, FilesystemBeingDeleted, "The specified filesystem is being deleted."
  • 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, "The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API."
  • 409 Conflict, InvalidRenameSourcePath, "The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "The source and destination resource type must be identical."
  • 409 Conflict, LeaseAlreadyPresent, "There is already a lease present."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "The lease ID specified did not match the lease ID for the resource with the specified lease operation."
  • 409 Conflict, LeaseIsAlreadyBroken, "The lease has already been broken and cannot be broken again."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is currently in breaking state and cannot be changed."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "The lease ID matched, but the lease has been broken explicitly and cannot be renewed."
  • 409 Conflict, LeaseNameMismatch, "The lease name specified did not match the existing lease name."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "The lease ID is not present with the specified lease operation."
  • 409 Conflict, PathAlreadyExists, "The specified path already exists."
  • 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, "The specified source path is marked to be deleted."
  • 409 Conflict, ResourceTypeMismatch, "The resource type specified in the request does not match the type of the resource."
  • 412 Precondition Failed, ConditionNotMet, "The condition specified using HTTP conditional header(s) is not met."
  • 412 Precondition Failed, LeaseIdMismatch, "The lease ID specified did not match the lease ID for the resource."
  • 412 Precondition Failed, LeaseIdMissing, "There is currently a lease on the resource and no lease ID was specified in the request."
  • 412 Precondition Failed, LeaseNotPresent, "There is currently no lease on the resource."
  • 412 Precondition Failed, LeaseLost, "A lease ID was specified, but the lease for the resource has expired."
  • 412 Precondition Failed, SourceConditionNotMet, "The source condition specified using HTTP conditional header(s) is not met."
  • 413 Request Entity Too Large, RequestBodyTooLarge, "The request body is too large and exceeds the maximum permissible limit."
  • 416 Requested Range Not Satisfiable, InvalidRange, "The range specified is invalid for the current size of the resource."
  • 500 Internal Server Error, InternalError, "The server encountered an internal error. Please retry the request."
  • 500 Internal Server Error, OperationTimedOut, "The operation could not be completed within the permitted time."
  • 503 Service Unavailable, ServerBusy, "Egress is over the account limit."
  • 503 Service Unavailable, ServerBusy, "Ingress is over the account limit."
  • 503 Service Unavailable, ServerBusy, "Operations per second is over the account limit."
  • 503 Service Unavailable, ServerBusy, "The server is currently unable to receive requests. Please retry your request."

Headers

  • x-ms-request-id: string
  • x-ms-version: string

Definitions

Name Description
DataLakeStorageError
Error

The service error response object.
FilesystemResourceType

The value must be "filesystem" for all filesystem operations.
Path
PathList

DataLakeStorageError

Name Type Description
error

Error

The service error response object.

Error

The service error response object.

Name Type Description
code

string

The service error code.
message

string

The service error message.

FilesystemResourceType

The value must be "filesystem" for all filesystem operations.

Name Type Description
filesystem

string

Path

Name Type Default value Description
contentLength

integer

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

If the encryption context property value is set it will return the set value. Valid only when Hierarchical Namespace is enabled for the account.
x-ms-encryption-key-sha256

string

The server will echo the SHA256 of the customer-provided encryption key to validate the key used in the operation.
x-ms-encryption-scope

string

If the request used an encryption scope, so the client can ensure the contents of the request are successfully encrypted using the encryption scope.
x-ms-server-encrypted: true/false

boolean

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm.

PathList

Name Type Description
paths

Path[]