Identificadores de lista

Artículo
06/01/2023

La List Handles operación 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 de recurso compartido de archivos habilitado	Disponible
SMB
NFS

Solicitud

Puede construir la List Handles solicitud como se indica a continuación. Se recomienda HTTPS.

Método	URI de solicitud	Versión de HTTP
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfileordirectory?comp=listhandles`	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`	Opcional. La 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 del identificador 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 `List Handles` operación. 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 identificadores tomados en archivos o directorios que se van a devolver. Si se establece `maxresults` en un valor menor o igual que cero, se devolverá el código de respuesta de error 400 (Solicitud incorrecta).
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para obtener más información, consulte Configuración de tiempos de espera para operaciones de Azure Files.
`sharesnapshot`	Opcional. El `sharesnapshot` parámetro 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 requeridos y opcionales.

Encabezado de solicitud	Descripción
`Authorization`	Necesario. Especifica el esquema de autorización, el nombre de la 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, vea Supervisar 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` 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 la 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, vea Códigos de estado y de error.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir encabezados HTTP adicionales y 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`	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.

Cuerpo de la respuesta

El formato de la respuesta XML es el siguiente. Tenga en cuenta que los Markerelementos , ShareSnapshoty MaxResults solo están presentes si los especificó 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>
    <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>
            <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. String.	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. String.	Se usa para decidir si el identificador podría haberse filtrado.
`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 controladores filtrados suelen estar abiertos durante mucho tiempo.
`LastReconnectTime`	Se abrió el identificador de hora (UTC). `DateTime` como String.	Se usa para decidir si el identificador se volvió a abrir después de una desconexión de cliente o servidor, debido a 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 volvió a abrir el identificador.
`FileId`	Id. de archivo, UINT64.	`FileId` identifica de forma única el archivo. Es útil durante los cambios de nombre, ya `FileId` que no cambia .
`ParentId`	Id. de archivo primario, UINT64.	`ParentId` identifica de forma única el directorio. Esto es útil durante los cambios de nombre, ya `ParentId` que no cambia .
`SessionId`	Identificador de sesión de 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 forzosamente. 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 por 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 Path valores de elemento que contienen caracteres no válidos en XML (en concreto, U+FFFE o U+FFFF). Si se codifica, el Path elemento incluirá un Encoded=true atributo . Tenga en cuenta que esto solo se producirá para los valores de Path elemento que contienen los caracteres no válidos en XML, no para los elementos restantes Path de la respuesta.

Authorization

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

Comentarios

HandleId es un 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.