Get File
La operación Get File lee o descarga un archivo del sistema, incluidos sus metadatos y propiedades.
Disponibilidad del protocolo
| Protocolo de recurso compartido de archivos habilitado | Disponible |
|---|---|
| SMB |
|
| NFS |
|
Solicitud
La solicitud Get File se puede construir como sigue. Se recomienda usar HTTPS.
| Método | URI de solicitud | Versión de HTTP |
|---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
Reemplace los componentes de ruta de acceso que se muestran en el URI de solicitud por los suyos propios, como se indica a continuación:
| 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. |
myfile |
Nombre del archivo. |
Para obtener información sobre las restricciones de nomenclatura de rutas de acceso, vea Recursos compartidos de nombres y referencia, directorios, archivos y metadatos.
Parámetros del identificador URI
Se pueden especificar los siguientes parámetros adicionales en el URI de solicitud:
| Parámetro | Descripción |
|---|---|
timeout |
Opcional. El parámetro timeout se expresa en segundos. Para obtener más información, consulte Establecer tiempos de espera para las operaciones de Azure Files. |
Encabezados de solicitud
Los encabezados de solicitud obligatorios y opcionales se describen en la tabla siguiente:
| 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. 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. |
Range |
Opcional. Devuelve datos de archivo solo del intervalo de bytes especificado. |
x-ms-range |
Opcional. Devuelve datos de archivo solo del intervalo de bytes especificado. Si se especifican Range y x-ms-range, el servicio utiliza el valor de x-ms-range. Si no se especifica ninguno, se devuelve todo el contenido del archivo. Consulte Especificar el encabezado de intervalo para Azure Files operaciones para obtener más información. |
x-ms-range-get-content-md5: true |
Opcional. Cuando este encabezado se establece true en y se especifica junto con el Range encabezado , el servicio devuelve el hash MD5 para el rango, siempre que el intervalo sea menor o igual que 4 mebibytes (MiB) en tamaño.Si se especifica este encabezado sin el encabezado Range, el servicio devuelve el código de estado 400 (Solicitud incorrecta).Si este encabezado se establece true en cuando el intervalo supera los 4 MiB de tamaño, el servicio devuelve el código de estado 400 (solicitud incorrecta). |
x-ms-lease-id:<ID> |
Opcional. Versión 2019-02-02 y posteriores. Si se especifica el encabezado, la operación solo se realiza si la concesión del archivo está activa actualmente y el identificador de concesión especificado en la solicitud coincide con el identificador de concesión del archivo. De lo contrario, se produce un error en la operación con el código de estado 412 (error de condición previa). |
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-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 el cuerpo de respuesta, que incluye el contenido del archivo.
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 error.
Encabezados de respuesta
La respuesta para esta operación incluye los encabezados siguientes. 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.
| Encabezado de respuesta | Descripción |
|---|---|
Last-Modified |
Devuelve la fecha y hora en que se modificó por última vez el archivo. El formato de la fecha sigue las convenciones de RFC 1123. Para obtener más información, vea Representar valores de fecha y hora en encabezados. Cualquier operación que modifique el archivo o sus propiedades actualiza la hora de la última modificación. |
x-ms-meta-name:value |
Conjunto de pares nombre-valor asociados a este archivo como metadatos definidos por el usuario. |
Content-Length |
El número de bytes presentes en el cuerpo de respuesta. |
Content-Type |
El tipo de contenido especificado para el archivo. El tipo de contenido predeterminado es application/octet-stream. |
Content-Range |
Intervalo de bytes devuelto si el cliente solicitó un subconjunto del archivo estableciendo el Range encabezado de solicitud. |
ETag |
Contiene un valor que puede usar para realizar operaciones condicionalmente. El valor se incluye entre comillas. |
Content-MD5 |
Si el archivo tiene un hash MD5 y esta solicitud tiene como fin leer el archivo completo, se devuelve este encabezado de respuesta para que el cliente pueda comprobar la integridad del contenido del mensaje. Si la solicitud es leer un intervalo especificado y x-ms-range-get-content-md5 se establece trueen , la solicitud devuelve un hash MD5 para el intervalo, siempre que el tamaño del intervalo sea menor o igual que 4 MiB.Si ninguno de estos conjuntos de condiciones es true, no se devuelve ningún valor para el Content-MD5 encabezado .Si x-ms-range-get-content-md5 se especifica sin el encabezado de intervalo, el servicio devuelve el código de estado 400 (solicitud incorrecta).Si x-ms-range-get-content-md5 se establece true en cuando el intervalo supera 4 MiB, el servicio devuelve el código de estado 400 (solicitud incorrecta). |
Content-Encoding |
Devuelve el valor especificado para el encabezado de Content-Encoding solicitud. |
Content-Language |
Devuelve el valor especificado para el encabezado de Content-Language solicitud. |
Cache-Control |
Se devuelve si se especificó anteriormente para el archivo. |
Content-Disposition |
Devuelve el valor especificado para el encabezado x-ms-content-disposition y especifica cómo procesar la respuesta.El Content-Disposition campo de encabezado de respuesta transmite información adicional sobre cómo procesar la carga de respuesta y también se puede usar para adjuntar metadatos adicionales. Por ejemplo, si se establece attachmenten , Content-Disposition indica que el agente de usuario no debe mostrar la respuesta, sino que, en su lugar, debe mostrar una ventana Guardar como. |
x-ms-request-id |
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 |
Versión del servicio que se usó para ejecutar la solicitud. |
Accept-Ranges: bytes |
Indica que el servicio admite solicitudes de contenido parcial de archivos. |
Date |
Date |
x-ms-copy-completion-time:<datetime> |
Versión 2015-02-21 y posteriores. Hora de conclusión de la última operación de copiar archivo en la que este archivo era el archivo de destino. Este valor puede especificar la hora de un intento de copia completado, anulado o con errores. Este encabezado no aparece si una copia está pendiente, si este archivo nunca ha sido el destino en una operación Copiar archivo , o si este archivo se ha modificado después de una operación de copia de archivo finalizada que usó Establecer propiedades de archivo o Crear archivo. |
x-ms-copy-status-description: <error string> |
Versión 2015-02-21 y posteriores. Solo aparece cuando x-ms-copy-status se produce un error o está pendiente. Describe la causa de un error de operación de copia grave o no grave. Este encabezado no aparece si este archivo nunca ha sido el destino en una operación Copiar archivo o si este archivo se ha modificado después de una operación de copia de archivo finalizada que usó Establecer propiedades de archivo o Crear archivo. |
x-ms-copy-id: <id> |
Versión 2015-02-21 y posteriores. Identificador de cadena de la última operación de copiar archivo en la que este archivo era el archivo de destino. Este encabezado no aparece si el archivo nunca ha sido el destino en una operación Copiar archivo o si este archivo se ha modificado después de una operación de copia de archivo finalizada que usó Establecer propiedades de archivo o Crear archivo. |
x-ms-copy-progress: <bytes copied/bytes total> |
Versión 2015-02-21 y posteriores. Contiene el número de bytes que se copiaron y el total de bytes del origen en la última operación de copiar archivo en la que este archivo era el archivo de destino. Puede mostrar de 0 al número de bytes copiados Content-Length . Este encabezado no aparece si este archivo nunca ha sido el destino en una operación Copiar archivo o si este archivo se ha modificado después de una operación de copia de archivo finalizada que usó Establecer propiedades de archivo o Crear archivo. |
x-ms-copy-source: url |
Versión 2015-02-21 y posteriores. Dirección URL de hasta 2 KB de longitud que especifica el archivo de origen que se usó en la última operación de copiar archivo en la que este archivo era el archivo de destino. Este encabezado no aparece si este archivo nunca ha sido el destino en una operación Copiar archivo o si este archivo se ha modificado después de una operación de copia de archivo finalizada que usó Establecer propiedades de archivo o Crear archivo. |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
Versión 2015-02-21 y posteriores. Estado de la operación de copia identificada por x-ms-copy-id, con estos valores:- pending: la copia está en curso. Compruebe x-ms-copy-status-description si los errores intermitentes y no irrecuperables impiden el progreso de la copia, pero no provocan errores.- success: la copia se completó correctamente.- aborted: La copia finalizó anulando el archivo de copia.- failed: error de copia. Para obtener información sobre los errores, vea x-ms-copy-status-description.Este encabezado no aparece si este archivo nunca ha sido el destino en una operación Copiar archivo o si este archivo se ha modificado después de una operación de copia de archivo completada que usó Establecer propiedades de archivo o Crear archivo. |
x-ms-content-md5 |
A partir de la versión 2016-05-31, si el archivo tiene un hash MD5 y si la solicitud contiene un encabezado de intervalo (range o x-ms-range), este encabezado de respuesta se devuelve con el valor del valor MD5 de todo el archivo. Este valor podría ser o no igual al valor que se devuelve en el Content-MD5 encabezado , que se calcula a partir del intervalo solicitado. |
x-ms-server-encrypted: true/false |
Versión 2017-04-17 y posteriores. El valor de este encabezado se establece true en si los datos de archivo y los metadatos de la aplicación se cifran completamente mediante el algoritmo especificado. Si el archivo no está cifrado, o si solo se cifran partes de los metadatos de archivo o aplicación, el valor se establece falseen . |
x-ms-file-permission-key |
Clave del permiso del archivo. |
x-ms-file-attributes |
Atributos del sistema de archivos en el archivo. Para obtener más información, consulte la lista de atributos disponibles. |
x-ms-file-creation-time |
Valor de fecha y hora UTC que representa la propiedad de hora de creación del archivo. |
x-ms-file-last-write-time |
Valor de fecha y hora UTC que representa la última propiedad de hora de escritura del archivo. |
x-ms-file-change-time |
Fecha y hora UTC que representa la propiedad de hora de cambio del archivo. |
x-ms-file-file-id |
Identificador de archivo del archivo. |
x-ms-file-parent-id |
Identificador de archivo primario del archivo. |
x-ms-lease-duration:infinite |
Versión 2019-02-02 y posteriores. Cuando se alquila un archivo, especifica que la concesión es de duración infinita. |
x-ms-lease-state: <available, leased, broken> |
Versión 2019-02-02 y posteriores. Cuando se alquila un archivo, especifica el estado de concesión del archivo. |
x-ms-lease-status: <locked, unlocked> |
Versión 2019-02-02 y posteriores. Cuando se alquila un archivo, especifica el estado de concesión del archivo. |
x-ms-client-request-id |
Se puede usar para solucionar problemas de solicitudes y sus respuestas correspondientes. El valor de este encabezado es igual al valor del x-ms-client-request-id encabezado si está presente en la solicitud y el valor no contiene más de 1024 caracteres ASCII visibles. Si el x-ms-client-request-id encabezado no está presente en la solicitud, no está presente en la respuesta. |
Response body
El cuerpo de la respuesta contiene el contenido del archivo.
Respuesta de muestra
Response Status:
HTTP/1.1 200 OK
Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2019-02-02
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6
x-ms-copy-source: <url>
x-ms-copy-status: success
x-ms-copy-progress: 11/11
x-ms-copy-completion-time: <date>
x-ms-lease-duration: infinite
x-ms-lease-state: leased
x-ms-lease-status: locked
Authorization
Solo el propietario de la cuenta puede llamar a esta operación.
Observaciones
Llamar a Get File través de un intervalo que aún no tiene contenido o que se ha borrado devuelve 0 para esos bytes.
Si llama a Get File sin intervalo especificado, el servicio devuelve el intervalo de bytes hasta el valor especificado para el x-ms-content-length encabezado. En el caso de los intervalos que carecen de contenido, el servicio devuelve 0 para esos bytes.
Una Get File operación se permite que se completen dos minutos por MiB. Las operaciones que tardan más de dos minutos por MiB en promedio agotarán el tiempo de espera.