Directorios y archivos de lista

Artículo
03/29/2023

La operación List Directories and Files devuelve una lista de archivos o directorios en el directorio o recurso compartido especificado. Muestra el contenido únicamente de un solo nivel de la jerarquía de directorios.

Disponibilidad del protocolo

Protocolo de recurso compartido de archivos habilitado	Disponible
SMB
NFS

Solicitud

Puede construir la solicitud de la List Directories and Files siguiente manera. Se recomienda HTTPS.

Método	URI de solicitud	Versión de HTTP
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list`	HTTP/1.1
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list`	HTTP/1.1

Reemplace los componentes de la ruta de acceso que se muestran en el URI de solicitud por los suyos de la siguiente manera:

Componente de ruta de acceso	Descripción
`myaccount`	El nombre de la cuenta de almacenamiento.
`myshare`	El nombre del recurso compartido de archivos.
`mydirectorypath`	La ruta de acceso al directorio.

Para más información sobre las restricciones de nomenclatura de rutas de acceso, consulte Nomenclatura y referencia a recursos compartidos, directorios, archivos y metadatos.

Parámetros del identificador URI

Puede especificar los siguientes parámetros adicionales en el URI.

Parámetro	Descripción
`prefix`	Opcional. Versión 2016-05-31 y posteriores. Filtra los resultados para devolver solo archivos y directorios que tengan nombres que comiencen por el prefijo especificado.
`sharesnapshot`	Opcional. Versión 2017-04-17 y posteriores. El parámetro de instantánea de recurso compartido es un valor opaco `DateTime` que, cuando está presente, especifica la instantánea de recurso compartido que se va a consultar para la lista de archivos y directorios.
`marker`	Opcional. Valor de cadena que identifica la parte de la lista que se va a devolver con la siguiente operación de lista. La operación devuelve un valor de marcador dentro del cuerpo de la respuesta si la lista devuelta no se completó. A continuación, puede usar el valor del marcador en una llamada posterior para solicitar el siguiente conjunto de elementos de lista. El valor de marcador es opaco para el cliente.
`maxresults`	Opcional. Especifica el número máximo de archivos o directorios que se van a devolver. Si la solicitud no especifica `maxresults`o especifica un valor mayor que 5000, el servidor devolverá hasta 5000 elementos. Si se establece `maxresults` en un valor menor o igual que cero, se devolverá el código de respuesta de error 400 (Solicitud incorrecta).
`include={Timestamps, ETag, Attributes, PermissionKey}`	Opcionalmente, disponible a partir de la versión 2020-04-08. Especifica una o varias propiedades que se van a incluir en la respuesta: `Timestamps` `ETag` `Attributes` (Atributos de archivo Win32) `PermissionKey` Para especificar más de una de estas opciones en el URI, debe separar cada opción con una coma codificada por URL (`%82`). Se supone que el encabezado `x-ms-file-extended-info` es true implícitamente cuando se especifica este parámetro.
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para obtener más información, consulte Configuración de tiempos de espera para Azure Files operaciones.

Encabezados de solicitud

En la tabla siguiente se describen los encabezados de solicitud requeridos y opcionales.

Encabezado de solicitud	Descripción
`Authorization`	Necesario. Especifica el esquema de autorización, el nombre de cuenta y la firma. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`Date` o `x-ms-date`	Necesario. Especifica la hora universal coordinada (UTC) de la solicitud. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`x-ms-version`	Obligatorio para todas las solicitudes autorizadas, opcional para las solicitudes anónimas. Especifica la versión de la operación que se utiliza para esta solicitud. Para obtener más información, vea Versiones de los servicios de Azure Storage.
`x-ms-client-request-id`	Opcional. Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 kibibyte (KiB) que se registra en los registros cuando se configura el registro. Se recomienda encarecidamente usar este encabezado para correlacionar las actividades del lado cliente con las solicitudes que recibe el servidor. Para obtener más información, consulte Supervisión de Azure Files.
`x-ms-file-extended-info: {true}`	Opcional. Versión 2020-04-08 y posteriores. Se supone que este encabezado es true implícitamente si el `include` parámetro de consulta no está vacío. Si es true, la `Content-Length` propiedad estará actualizada. En las versiones 2020-04-08, 2020-06-12 y 2020-08-04, `FileId` solo se devuelven para archivos y directorios si este encabezado es true. En las versiones 2020-10-02 y posteriores, `FileId` siempre se devuelve para archivos y directorios.
`x-ms-file-request-intent`	Obligatorio si `Authorization` el encabezado especifica un token de OAuth. El valor aceptable es `backup`. Este encabezado especifica que se debe conceder o `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` si se incluyen en la directiva de RBAC asignada a la identidad autorizada mediante el `Authorization` encabezado . Disponible para la versión 2022-11-02 y posteriores.
`x-ms-allow-trailing-dot: { <Boolean> }`	Opcional. Versión 2022-11-02 y posteriores. El valor booleano especifica si se debe recortar o no un punto final presente en la dirección URL de solicitud. Para obtener más información, consulte Nomenclatura y referencia a recursos compartidos, directorios, archivos y metadatos.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta en formato XML.

status code

Una operación correcta devuelve el código de estado 200 Correcto. Para obtener información sobre los códigos de estado, consulte Códigos de estado y error.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir encabezados HTTP adicionales estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta	Descripción
`Content-Type`	Especifica el formato en el que se devuelven los resultados. Actualmente, este valor es `application/xml`.
`x-ms-request-id`	Este encabezado identifica de forma única la solicitud que se realizó y se puede usar para solucionar problemas de la solicitud. Para más información, consulte Solución de problemas de operaciones de API.
`x-ms-version`	Indica la versión de Azure Files usada para ejecutar la solicitud.
`Date` o `x-ms-date`	Valor de fecha y hora UTC que indica la hora a la que se inició la respuesta. El servicio genera este valor.
`x-ms-client-request-id`	Puede usar este encabezado para solucionar problemas de solicitudes y respuestas correspondientes. El valor de este encabezado es igual al valor del `x-ms-client-request-id` encabezado, si está presente en la solicitud. El valor es como máximo 1024 caracteres ASCII visibles. Si el `x-ms-client-request-id` encabezado no está presente en la solicitud, este encabezado no estará presente en la respuesta.

Response body

El formato de la respuesta XML es el siguiente.

Tenga en cuenta que los Markerelementos , ShareSnapshoty MaxResults solo están presentes si los especifica en el URI de solicitud. El NextMarker elemento solo tiene un valor si los resultados de la lista no están completos.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.file.core.windows.net/" ShareName="myshare" ShareSnapshot="date-time" DirectoryPath="directory-path">  
  <Marker>string-value</Marker>
  <Prefix>string-value</Prefix>
  <MaxResults>int-value</MaxResults>
  <DirectoryId>directory-id</DirectoryId>
  <Entries>
    <File>
      <FileId>file-id</FileId>
      <Name>file-name</Name>  
      <Properties>  
        <Content-Length>size-in-bytes</Content-Length>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </File>  
    <Directory>
      <FileId>file-id</FileId>
      <Name>directory-name</Name>  
      <Properties>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </Directory>  
  </Entries>  
  <NextMarker />  
</EnumerationResults>

Tenga en cuenta que en la lista se devuelve el elemento Content-Length. Sin embargo, es posible que este valor no esté actualizado, ya que un cliente SMB podría haber modificado el archivo localmente. Es posible que el valor de Content-Length no refleje ese hecho hasta que se cierre el identificador o se rompa el bloqueo de operación. Para recuperar los valores de propiedad actuales, use x-ms-file-extended-info: trueo llame a Obtener propiedades de archivo.

En las versiones 2020-04-08, 2020-06-12 y 2020-08-04, FileId se devuelve para archivos y directorios si el encabezado x-ms-file-extended-info es true. En la versión 2020-10-02 y posteriores, FileId siempre se devuelve para archivos y directorios.

En la versión 2020-04-08, include={timestamps} devuelve las siguientes propiedades de marca de tiempo: CreationTime, LastAccessTimey LastWriteTime. En la versión 2020-06-12 y versiones posteriores, include={timestamps} devuelve las siguientes propiedades de marca de tiempo: CreationTime, LastAccessTime, LastWriteTime, ChangeTimey Last-Modified.

En la versión 2020-10-02 y posteriores, DirectoryId se devuelve en la respuesta. Especifica el FileId del directorio en el que se llama a la API.

En las versiones 2021-12-02 y posteriores, List Directory and Files codificará por porcentaje (por RFC 2396) todos los FileNamevalores de elemento , PrefixDirectoryNameo DirectoryPath que contienen caracteres no válidos en XML (en concreto, U+FFFE o U+FFFF). Si se codifica, el Nameelemento , Prefix o EnumerationResults incluirá un Encoded=true atributo . Tenga en cuenta que esto solo se producirá para los valores de Name elemento que contienen los caracteres no válidos en XML, no para los elementos restantes Name de la respuesta.

Formato de fecha y hora y versión de api para campos de marca de tiempo

Elemento	Formato de fecha y hora	Valor de ejemplo	Versión de API
`CreationTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 y versiones posteriores
`LastAccessTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 y versiones posteriores
`LastWriteTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 y versiones posteriores
`ChangeTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-06-12 y versiones posteriores
`Last-Modified`	RFC 1123	`Thu, 17 Sep 2020 13:38:07 GMT`	2020-06-12 y versiones posteriores

Authorization

Solo el propietario de la cuenta puede llamar a esta operación.

Observaciones

El valor devuelto en el Content-Length elemento corresponde al valor del encabezado del x-ms-content-length archivo.

Tenga en cuenta que cada elemento Directory devuelto se tiene en cuenta para calcular el número máximo de resultados, de la misma manera que los elementos File. Los archivos y directorios se enumeran entremezclados, en orden léxico en el cuerpo de la respuesta.

La lista está limitada a un solo nivel de la jerarquía de directorios. Para enumerar varios niveles, puede realizar varias llamadas de forma iterativa. Use el Directory valor devuelto de un resultado en una llamada posterior a List Directories and Files.

Consulte también

Operaciones en directorios