Identificadores de lista

Artículo
02/21/2025

La operación List Handles devuelve una lista de identificadores abiertos en un directorio o un archivo. Opcionalmente, puede enumerar de forma recursiva los identificadores abiertos en directorios y archivos. Esta API está disponible a partir de la versión 2018-11-09.

Disponibilidad del protocolo

Protocolo habilitado para recursos compartidos de archivos	Disponible
SMB
NFS

Pedir

La solicitud List Handles se construye de la siguiente manera. Se recomienda usar HTTPS.

Método	URI de solicitud	Versión HTTP
OBTENER	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfileordirectory?comp=listhandles`	HTTP/1.1

Reemplace los componentes de ruta de acceso que se muestran en el URI de solicitud por el suyo propio, como se indica a continuación:

Componente de ruta de acceso	Descripción
`myaccount`	Nombre de la cuenta de almacenamiento.
`myshare`	Nombre del recurso compartido de archivos.
`mydirectorypath`	Opcional. Ruta de acceso al directorio.
`myfileordirectory`	Nombre del archivo o 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 de URI

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

Parámetro	Descripción
`marker`	Opcional. Valor de cadena que identifica la parte de la lista que se va a devolver con la siguiente operación de `List Handles`. 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 del marcador es opaco para el cliente.
`maxresults`	Opcional. Especifica el número máximo de identificadores tomados en archivos o directorios que se van a devolver. Establecer `maxresults` en un valor menor o igual que cero da como resultado el código de respuesta de error 400 (solicitud incorrecta).
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para más información, consulte Configuración de tiempos de espera para las operaciones de Azure Files.
`sharesnapshot`	Opcional. El parámetro `sharesnapshot` 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 identificadores.

Encabezados de solicitud

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

Encabezado de solicitud	Descripción
`Authorization`	Obligatorio. Especifica el esquema de autorización, el nombre de la cuenta y la firma. Para más información, consulte Autorizar solicitudes a Azure Storage.
`Date` o `x-ms-date`	Obligatorio. Especifica la hora universal coordinada (UTC) de la solicitud. Para más información, consulte Autorizar solicitudes a Azure Storage.
`x-ms-version`	Necesario para todas las solicitudes autorizadas, opcional para las solicitudes anónimas. Especifica la versión de la operación que se va a usar para esta solicitud. Para más información, consulte Control de versiones de para 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 más información, consulte Monitor Azure Files.
`x-ms-recursive`	Opcional. Valor booleano que especifica si la operación también debe aplicarse a los archivos y subdirectorios del directorio especificado en el URI.
`x-ms-file-request-intent`	Obligatorio si `Authorization` encabezado especifica un token de OAuth. El valor aceptable es `backup`. Este encabezado especifica que se debe conceder el `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` o `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` si se incluyen en la directiva de RBAC asignada a la identidad autorizada mediante el encabezado `Authorization`. 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, vea Asignar nombres y hacer referencia a recursos compartidos, directorios, archivos y metadatos.

Cuerpo de la solicitud

Ninguno.

Respuesta

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

Código de estado

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

Encabezados de respuesta

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

Encabezados comunes

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 obtener más información, consulte Solución de problemas de operaciones de API.
`x-ms-version`	Indica la versión de Azure Files que se usa para ejecutar la solicitud.
`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 encabezado `x-ms-client-request-id`, si está presente en la solicitud. El valor tiene como máximo 1024 caracteres ASCII visibles. Si el encabezado `x-ms-client-request-id` no está presente en la solicitud, este encabezado no estará presente en la respuesta.

Cuerpo de la respuesta

El formato de la respuesta XML es el siguiente. Tenga en cuenta que los elementos Marker, ShareSnapshoty MaxResults solo están presentes si los especificó en el URI de solicitud. El elemento NextMarker tiene un valor solo si los resultados de la lista no están completos.

ClientName campo en respuesta es opcional y solo se devuelve cuando está disponible para el servicio.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults>
    <HandleList>
        <Handle>
            <HandleId>handle-id</HandleId>
            <Path>file-or-directory-name-including-full-path</Path>
            <FileId>file-id</FileId>
            <ParentId>parent-file-id</ParentId>
            <SessionId>session-id</SessionId>
            <ClientIp>client-ip</ClientIp>
            <ClientName>client-name</ClientName>
            <OpenTime>opened-time</OpenTime>
            <LastReconnectTime>lastreconnect-time</LastReconnectTime>
            <AccessRightList>
                <AccessRight>Read</AccessRight>
                <AccessRight>Write</AccessRight>
                <AccessRight>Delete</AccessRight>
            </AccessRightList>
        </Handle>
        ...
    </HandleList>
    <NextMarker>next-marker</NextMarker>
</EnumerationResults>

En la tabla siguiente se describen los campos del cuerpo de la respuesta:

Campo	Descripción	Propósito
`HandleId`	Identificador de identificador del servicio XSMB, UINT64.	Se usa para identificar el identificador.
`Path`	Nombre de archivo, incluida la ruta de acceso completa, empezando por la raíz del recurso compartido. Cuerda.	Se usa para identificar el nombre del objeto para el que está abierto el identificador.
`ClientIp`	Dirección IP del cliente que abrió el identificador. Cuerda.	Se usa para decidir si es posible que se haya filtrado el identificador.
`ClientName`	Campo opcional. Se admite en 2024-02-04 y versiones posteriores. Nombre de cliente (nombre de usuario de estación de trabajo o sistema operativo) que abrió el identificador. Cuerda.	Se usa para decidir si es posible que se haya filtrado el identificador.
`OpenTime`	Se abrió el identificador de hora (UTC). `DateTime` como String.	Se usa para decidir si es posible que se haya filtrado el identificador. Los identificadores filtrados normalmente se han abierto durante mucho tiempo.
`LastReconnectTime`	Se abrió el identificador de hora (UTC). `DateTime` como String.	Se usa para decidir si el identificador se ha vuelto a abrir después de una desconexión del cliente o servidor, debido a las redes u otros errores. El campo se incluye en el cuerpo de la respuesta solo si se produjo el evento de desconexión y se reabrió el identificador.
`FileId`	Id. de archivo, UINT64.	`FileId` identifica de forma única el archivo. Es útil durante los cambios de nombre, ya que el `FileId` no cambia.
`ParentId`	Id. de archivo primario, UINT64.	`ParentId` identifica de forma única el directorio. Esto resulta útil durante los cambios de nombre, ya que el `ParentId` no cambia.
`SessionId`	Identificador de sesión SMB que especifica el contexto en el que se abrió el identificador de archivo. UINT64.	`SessionId` se incluye en los registros del visor de eventos cuando las sesiones se desconectan forzadamente. Permite asociar un lote específico de identificadores filtrados a un incidente de red específico.
`AccessRightList`	Permisos de acceso concedidos al identificador abierto en el archivo o directorio.	Disponible en la versión del servicio 2023-01-03 y versiones posteriores. Se usa para consultar los permisos de acceso mantenidos en un archivo o directorio mediante varios identificadores abiertos. Los valores posibles son READ, WRITE y DELETE, o una combinación de estos valores.
`NextMarker`	Cadena que describe el siguiente identificador que se va a enumerar. Se devuelve cuando se deben enumerar más identificadores para completar la solicitud.	La cadena se usa en las solicitudes posteriores para enumerar los identificadores restantes. La ausencia de `NextMarker` indica que se enumeraron todos los identificadores pertinentes.

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

ClientName se admite en la versión 2024-02-04 y posteriores.

Autorización

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

Observaciones

El HandleId es un identificador de identificador de identificador del lado del servicio, distinto del identificador de identificador de cliente. La asignación entre los dos es posible en el cliente.

Consulte también

Operaciones de en archivos
Operaciones de en directorios

Compartir a través de