Path - List

  • Referencia
Servicio:
Storage Services
Versión de la API:
2023-08-03

Enumere las rutas de acceso y sus propiedades en el sistema de archivos especificado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
accountName
 path True

string

El nombre de la cuenta de Azure Storage.
dnsSuffix
 path True

string

Sufijo DNS para el punto de conexión de Azure Data Lake Storage.
filesystem
 path True

string

Identificador del sistema de archivos. El valor debe comenzar y terminar con una letra o un número y solo debe contener letras, números y el carácter de guión (-). No se permiten guiones consecutivos. Todas las letras deben estar en minúsculas. El valor debe tener entre 3 y 63 caracteres.

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

boolean

Si es "true", se muestran todas las rutas de acceso; De lo contrario, solo se muestran las rutas de acceso en la raíz del sistema de archivos. Si se especifica "directory", la lista solo incluirá rutas de acceso que compartan la misma raíz.
resource
 query True

FilesystemResourceType

El valor debe ser "filesystem" para todas las operaciones del sistema de archivos.
continuation
 query

string

El número de rutas de acceso devueltas con cada invocación es limitada. Si el número de rutas de acceso que se van a devolver supera este límite, se devuelve un token de continuación en el encabezado de respuesta x-ms-continuation. Cuando se devuelve un token de continuación en la respuesta, debe especificarse en una invocación posterior de la operación de lista para continuar enumerando las rutas de acceso. Tenga en cuenta que el token de continuación devuelto en el encabezado de respuesta x-ms-continuation debe estar codificado como dirección URL antes de usarse en una invocación posterior.
directory
 query

string

Filtra los resultados de las rutas de acceso dentro del directorio especificado. Se produce un error si el directorio no existe.
maxResults
 query

integer

int32

Valor opcional que especifica el número máximo de elementos que se van a devolver. Si se omite o superior a 5000, la respuesta incluirá hasta 5000 elementos.
timeout
 query

integer

int32

Un valor de tiempo de espera de operación opcional en segundos. El período comienza cuando el servicio recibe la solicitud. Si el valor de tiempo de espera transcurre antes de que se complete la operación, se produce un error en la operación.
upn
 query

boolean

Opcional. Válido solo cuando el espacio de nombres jerárquico está habilitado para la cuenta. Si es "true", los valores de identidad de usuario devueltos en los campos propietario y de grupo de cada entrada de lista se transformarán de identificadores de objeto de Azure Active Directory a nombres principales de usuario. Si es "false", los valores se devolverán como identificadores de objeto de Azure Active Directory. El valor predeterminado es false. Tenga en cuenta que los identificadores de objeto de grupo y aplicación no se traducen porque no tienen nombres descriptivos únicos.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string

UuID registrado en los registros de análisis para la solución de problemas y la correlación.

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

string

Especifica la hora universal coordinada (UTC) de la solicitud. Esto es necesario cuando se usa la autorización de clave compartida.
x-ms-version

string

Especifica la versión del protocolo REST que se usa para procesar la solicitud. Esto es necesario cuando se usa la autorización de clave compartida.

Respuestas

Nombre Tipo Description
200 OK

PathList

Aceptar

Encabezados

  • 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

Se produjo un error. A continuación se enumeran los posibles estados HTTP, código y cadenas de mensaje:

  • 400 Solicitud incorrecta, ContentLengthMustBeZero, "El encabezado de solicitud Content-Length debe ser cero".
  • 400 Solicitud incorrecta, InvalidAuthenticationInfo, "La información de autenticación no se proporciona en el formato correcto. Compruebe el valor del encabezado Authorization".
  • 400 Solicitud incorrecta, InvalidFlushPosition, "Los datos cargados no son contiguos o el valor del parámetro de consulta de posición no es igual a la longitud del archivo después de anexar los datos cargados".
  • 400 Solicitud incorrecta, InvalidHeaderValue, "El valor de uno de los encabezados HTTP no está en el formato correcto".
  • 400 Solicitud incorrecta, InvalidHttpVerb, "El verbo HTTP especificado no es válido: el servidor no lo reconoce".
  • 400 Solicitud incorrecta, InvalidInput, "Una de las entradas de solicitud no es válida".
  • 400 Solicitud incorrecta, InvalidPropertyName, "Un nombre de propiedad no puede estar vacío".
  • 400 Solicitud incorrecta, InvalidPropertyName, "El nombre de la propiedad contiene caracteres no válidos".
  • 400 Solicitud incorrecta, InvalidQueryParameterValue, "El valor de uno de los parámetros de consulta especificados en el URI de solicitud no es válido".
  • 400 Solicitud incorrecta, InvalidResourceName, "El nombre del recurso especificado contiene caracteres no válidos".
  • 400 Solicitud incorrecta, InvalidSourceUri, "El URI de origen no es válido".
  • 400 Solicitud incorrecta, InvalidUri, "El URI de solicitud no es válido".
  • 400 Solicitud incorrecta, MissingRequiredHeader, "No se especifica un encabezado HTTP obligatorio para esta solicitud".
  • 400 Solicitud incorrecta, MissingRequiredQueryParameter, "No se especifica un parámetro de consulta obligatorio para esta solicitud".
  • 400 Solicitud incorrecta, MultipleConditionHeadersNotSupported, "No se admiten varios encabezados de condición".
  • 400 Solicitud incorrecta, OutOfRangeInput, "Una de las entradas de solicitud está fuera del intervalo".
  • 400 Solicitud incorrecta, OutOfRangeQueryParameterValue, "Uno de los parámetros de consulta especificados en el URI de solicitud está fuera del intervalo permitido".
  • 400 Solicitud incorrecta, UnsupportedHeader, "No se admite uno de los encabezados especificados en la solicitud".
  • 400 Solicitud incorrecta, UnsupportedQueryParameter, "No se admite uno de los parámetros de consulta especificados en el URI de solicitud".
  • 400 Solicitud incorrecta, UnsupportedRestVersion, "La versión rest especificada no es compatible".
  • 403 Prohibido, AccountIsDisabled, "La cuenta especificada está deshabilitada".
  • 403 Prohibido, AuthorizationFailure, "Esta solicitud no está autorizada para realizar esta operación".
  • 403 Prohibido, InsufficientAccountPermissions, "La cuenta a la que se accede no tiene permisos suficientes para ejecutar esta operación".
  • 404 No encontrado, FilesystemNotFound, "El sistema de archivos especificado no existe".
  • 404 No encontrado, PathNotFound, "La ruta de acceso especificada no existe".
  • 404 No encontrado, RenameDestinationParentPathNotFound, "El directorio primario de la ruta de acceso de destino no existe".
  • 404 No encontrado, ResourceNotFound, "El recurso especificado no existe".
  • 404 No encontrado, SourcePathNotFound, "La ruta de acceso de origen para una operación de cambio de nombre no existe".
  • 405 Método no permitido, UnsupportedHttpVerb, "El recurso no admite el verbo HTTP especificado".
  • 409 Conflicto, DestinationPathIsBeingDeleted, "La ruta de acceso de destino especificada está marcada para eliminarse".
  • 409 Conflicto, DirectoryNotEmpty, "El valor del parámetro de consulta recursivo debe ser true para eliminar un directorio no vacío".
  • 409 Conflicto, FilesystemAlreadyExists, "El sistema de archivos especificado ya existe".
  • 409 Conflicto, FilesystemBeingDeleted, "Se está eliminando el sistema de archivos especificado".
  • 409 Conflicto, InvalidDestinationPath, "La ruta de acceso especificada, o un elemento de la ruta de acceso, existe y su tipo de recurso no es válido para esta operación". * 409 Conflicto, 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 Conflicto, InvalidRenameSourcePath, "El directorio de origen no puede ser el mismo que el directorio de destino, ni el destino puede ser un subdirectorio del directorio de origen".
  • 409 Conflicto, InvalidSourceOrDestinationResourceType, "El tipo de recurso de origen y destino debe ser idéntico".
  • 409 Conflicto, LeaseAlreadyPresent, "Ya hay una concesión presente".
  • 409 Conflicto, LeaseIdMismatchWithLeaseOperation, "El identificador de concesión especificado no coincide con el identificador de concesión del recurso con la operación de concesión especificada".
  • 409 Conflicto, LeaseIsAlreadyBroken, "La concesión ya se ha roto y no se puede romper de nuevo".
  • 409 Conflicto, LeaseIsBreakingAndCannotBeAcquired, "El identificador de concesión coincide, pero la concesión está actualmente en estado de interrupción y no se puede adquirir hasta que se interrumpe".
  • 409 Conflicto, LeaseIsBreakingAndCannotBeChanged, "El identificador de concesión coincide, pero la concesión está actualmente en estado de interrupción y no se puede cambiar".
  • 409 Conflicto, LeaseIsBrokenAndCannotBeRenewed, "El identificador de concesión coincide, pero la concesión se ha interrumpido explícitamente y no se puede renovar".
  • 409 Conflicto, LeaseNameMismatch, "El nombre de concesión especificado no coincide con el nombre de concesión existente".
  • 409 Conflicto, LeaseNotPresentWithLeaseOperation, "El identificador de concesión no está presente con la operación de concesión especificada".
  • 409 Conflicto, PathAlreadyExists, "La ruta de acceso especificada ya existe".
  • 409 Conflicto, PathConflict, "La ruta de acceso especificada o un elemento de la ruta de acceso existe y su tipo de recurso no es válido para esta operación".
  • 409 Conflicto, SourcePathIsBeingDeleted, "La ruta de acceso de origen especificada está marcada para eliminarse".
  • 409 Conflicto, ResourceTypeMismatch, "El tipo de recurso especificado en la solicitud no coincide con el tipo del recurso".
  • 412 Error de condición previa, ConditionNotMet, "No se cumple la condición especificada mediante encabezados condicionales HTTP".
  • 412 Error de condición previa, LeaseIdMismatch, "El identificador de concesión especificado no coincide con el identificador de concesión del recurso".
  • 412 Error de condición previa, LeaseIdMissing, "Actualmente hay una concesión en el recurso y no se especificó ningún identificador de concesión en la solicitud".
  • 412 Error de condición previa, LeaseNotPresent, "Actualmente no hay ninguna concesión en el recurso".
  • 412 Error de condición previa, LeaseLost, "Se especificó un identificador de concesión, pero la concesión del recurso ha expirado".
  • 412 Error de condición previa, SourceConditionNotMet, "No se cumple la condición de origen especificada mediante encabezados condicionales HTTP".
  • 413 Solicitar entidad demasiado grande, RequestBodyTooLarge, "El cuerpo de la solicitud es demasiado grande y supera el límite máximo permitido".
  • 416 Intervalo solicitado no satisfiable, InvalidRange, "El rango especificado no es válido para el tamaño actual del recurso".
  • 500 Error interno del servidor, InternalError, "El servidor encontró un error interno. Vuelva a intentar realizar la solicitud"
  • 500 Error interno del servidor, OperationTimedOut, "No se pudo completar la operación dentro del tiempo permitido".
  • 503 Servicio no disponible, ServerBusy, "La salida supera el límite de la cuenta".
  • 503 Servicio no disponible, ServerBusy, "La entrada supera el límite de la cuenta".
  • 503 Servicio no disponible, ServerBusy, "Las operaciones por segundo superan el límite de la cuenta".
  • 503 Servicio no disponible, ServerBusy, "El servidor no puede recibir solicitudes actualmente. Please retry your request". (El programa de instalación del clúster no pudo instalar los componentes en uno o más hosts. Vuelva a intentar realizar la solicitud)

Encabezados

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

Definiciones

Nombre Description
DataLakeStorageError
Error

Objeto de respuesta de error del servicio.
FilesystemResourceType

El valor debe ser "filesystem" para todas las operaciones del sistema de archivos.
Path
PathList

DataLakeStorageError

Nombre Tipo Description
error

Error

Objeto de respuesta de error del servicio.

Error

Objeto de respuesta de error del servicio.

Nombre Tipo Description
code

string

Código de error del servicio.
message

string

Mensaje de error del servicio.

FilesystemResourceType

El valor debe ser "filesystem" para todas las operaciones del sistema de archivos.

Nombre Tipo Description
filesystem

string

Path

Nombre Tipo Valor predeterminado Description
contentLength

integer

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Si el valor de la propiedad de contexto de cifrado se establece, devolverá el valor establecido. Válido solo cuando el espacio de nombres jerárquico está habilitado para la cuenta.
x-ms-encryption-key-sha256

string

El servidor hará eco del SHA256 de la clave de cifrado proporcionada por el cliente para validar la clave usada en la operación.
x-ms-encryption-scope

string

Si la solicitud usó un ámbito de cifrado, por lo que el cliente puede asegurarse de que el contenido de la solicitud se cifre correctamente mediante el ámbito de cifrado.
x-ms-server-encrypted: true/false

boolean

El valor de este encabezado se establece en true si el contenido de la solicitud se cifra correctamente mediante el algoritmo especificado.

PathList

Nombre Tipo Description
paths

Path[]