Получение свойств файла
Операция Get File Properties возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства файла. Он не возвращает содержимое файла.
Доступность протокола
| Включенный протокол общей папки | Доступно |
|---|---|
| SMB |
|
| NFS |
|
Запрос
Запрос Get File Properties можно составить следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
|---|---|---|
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime> |
HTTP/1.1 |
Замените компоненты пути, отображаемые в URI запроса, собственными, как показано ниже.
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
mydirectorypath |
Необязательный элемент. Родительский каталог файла. |
myfile |
Имя файла. |
Сведения об ограничениях именования путей см. в разделе Имена и ссылочные общие папки, каталоги, файлы и метаданные.
Параметры универсального кода ресурса (URI)
В URI запроса можно указать следующие дополнительные параметры:
| Параметр | Описание |
|---|---|
sharesnapshot |
Необязательный элемент. Версия 17.04.2017 и более поздняя. Параметр sharesnapshot является непрозрачным значением DateTime, которое при его наличии указывает общую snapshot для запроса свойств файла. |
timeout |
Необязательный элемент. Параметр timeout указывается в секундах. Дополнительные сведения см. в разделе Установка времени ожидания для операций Файлы Azure. |
Заголовки запросов
Обязательные и необязательные заголовки запросов описаны в следующей таблице:
| Заголовок запроса | Описание |
|---|---|
| Авторизация | Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-lease-id:<ID> |
Необязательный элемент. Версия 2019-02-02 и более поздние. Если указан заголовок, операция выполняется только в том случае, если аренда файла в данный момент активна, а идентификатор аренды, указанный в запросе, соответствует идентификатору аренды файла. Если оно не совпадает, операция завершается ошибкой с кодом состояния 412 (сбой предварительного условия). |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы аналитики при включении ведения журнала azure Аналитика Службы хранилища. Мы настоятельно рекомендуем использовать этот заголовок при сопоставлении действий на стороне клиента с запросами, полученными сервером. Дополнительные сведения см. в разделе Мониторинг Хранилище BLOB-объектов Azure. |
x-ms-file-request-intent |
Требуется, если Authorization заголовок указывает токен OAuth. Допустимое значение — backup. Этот заголовок указывает, что Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action или должны быть предоставлены, если они включены в политику RBAC, назначенную удостоверению, которое авторизовано с помощью заголовка Authorization . Доступно для версии 2022-11-02 и более поздних версий. |
x-ms-allow-trailing-dot: { <Boolean> } |
Необязательный элемент. Версия 2022-11-02 и более поздние версии. Логическое значение указывает, следует ли обрезать завершающую точку в URL-адресе запроса. Дополнительные сведения см. в статье Именование общих папок, каталогов, файлов и метаданных и ссылки на нее. |
Текст запроса
Нет.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Дополнительные сведения о кодах состояния см. в разделе Коды состояния и ошибок.
Заголовки ответов
Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
| Заголовок ответа | Описание |
|---|---|
Last-Modified |
Возвращает дату и время последнего изменения файла. Дата в формате согласно RFC 1123. Дополнительные сведения см. в разделе Представление значений даты и времени в заголовках. Любая операция, изменяющая файл или его свойства, обновляет время последнего изменения. |
x-ms-meta-name:value |
Набор пар "имя-значение", связанных с этим файлом в качестве определяемых пользователем метаданных. |
x-ms-type: <File> |
Тип возвращаемого значения — File. Зарезервировано для последующего использования. |
Content-Length |
Размер файла в байтах. Этот заголовок возвращает значение заголовка x-ms-content-length , хранящегося в файле . |
Content-Type |
Тип контента, указанный для файла. Если тип контента не указан, по умолчанию используется application/octet-streamтип контента . |
ETag |
ETag содержит значение, которое позволяет выполнять операции условно. Значение заключено в кавычки. |
Content-MD5 |
Если заголовок Content-MD5 задан для файла, то возвращается заголовок ответа Content-MD5, чтобы клиент мог проверить целостность содержимого сообщения. |
Content-Encoding |
Если заголовок запроса Content-Encoding уже был задан для файла, то значение Content-Encoding возвращается в этом заголовке. |
Content-Language |
Если заголовок запроса Content-Language уже был задан для файла, то значение Content-Language возвращается в этом заголовке. |
Cache-Control |
Если заголовок запроса Cache-Control уже был задан для файла, то значение Cache-Control возвращается в этом заголовке. |
Content-Disposition |
Возвращает значение, указанное для заголовка x-ms-content-disposition, и указывает, как обработать ответ.Поле Content-Disposition заголовка ответа содержит дополнительные сведения о том, как обрабатывать полезные данные ответа, и его можно использовать для вложения дополнительных метаданных. Например, если задано значение attachment, Content-Disposition означает, что агент пользователя не должен отображать ответ, но вместо этого должно отобразиться окно Сохранить как. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос и может использоваться для устранения неполадок с запросом. Дополнительные сведения см. в разделе Устранение неполадок с операциями API. |
x-ms-version |
Указывает версию службы, которая использовалась для выполнения запроса. |
Date |
Значение даты и времени в формате UTC, созданное службой, указывающее время, когда был инициирован ответ. |
x-ms-copy-completion-time:<datetime> |
Версия 21.02.2015 и более поздняя. Время завершения последней попытки операции копирования файла , где этот файл был целевым файлом. Это значение может указывать время завершенной, отмененной или неуспешной попытки копирования. Этот заголовок не отображается, если копирование ожидается, если этот файл никогда не был назначением в операции копирования файла или если этот файл был изменен после завершения операции копирования файла с помощью команды Задать свойства файла или Создать файл. |
x-ms-copy-status-description: <error string> |
Версия 21.02.2015 и более поздняя. Отображается только при x-ms-copy-statusсбое или ожидании. В нем описывается причина неустранимого или неустранимого сбоя операции копирования. Этот заголовок не отображается, если копирование ожидается, если этот файл никогда не был назначением в операции копирования файла или если этот файл был изменен после завершения операции копирования файла с помощью команды Задать свойства файла или Создать файл. |
x-ms-copy-id: <id> |
Версия 21.02.2015 и более поздняя. Строковый идентификатор последней попытки операции копирования файла , где этот файл был целевым файлом. Этот заголовок не отображается, если этот файл никогда не был местом назначения в операции копирования файла или если этот файл был изменен после завершения операции копирования файла с помощью команды Задать свойства файла или Создать файл. |
x-ms-copy-progress: <bytes copied/bytes total> |
Версия 21.02.2015 и более поздняя. Содержит количество скопированных байтов и общее количество байтов в источнике в последней попытке операции копирования файла , где этот файл был целевым файлом. Может отображать от 0 до количества скопированных Content-Length байтов. Этот заголовок не отображается, если этот файл никогда не был местом назначения в операции копирования файла или если этот файл был изменен после завершения операции копирования файла с помощью команды Задать свойства файла или Создать файл. |
x-ms-copy-source: url |
Версия 21.02.2015 и более поздняя. URL-адрес размером до 2 КБ, указывающий исходный файл, который использовался при последней попытке операции копирования файла , где этот файл был целевым файлом. Этот заголовок не отображается, если этот файл никогда не был местом назначения в операции копирования файла или если этот файл был изменен после завершения операции копирования файла с помощью команды Задать свойства файла или Создать файл. |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
Версия 21.02.2015 и более поздняя. Состояние операции копирования, определяемой с помощью x-ms-copy-id, со следующими значениями:- Успех: Копирование выполнено успешно. - Ожидающие: Выполняется копирование. Проверьте x-ms-copy-status-description , не препятствуют ли периодические неустранимые ошибки, которые препятствуют выполнению копирования, но не приводят к сбою.- Прервана: Копирование было завершено путем прерывания копирования файла. - Сбой при: Сбой копирования. Дополнительные сведения об ошибке см. в разделе x-ms-copy-status-description.Этот заголовок не отображается, если этот файл никогда не был местом назначения в операции копирования файла или если этот файл был изменен после завершения операции копирования файла с помощью команды Задать свойства файла или Создать файл. |
x-ms-server-encrypted: true/false |
Версия 17.04.2017 и более поздняя. Этот заголовок имеет значение , true если данные файла и метаданные приложения полностью зашифрованы с помощью указанного алгоритма. Если файл не зашифрован или зашифрованы только части файла или метаданных приложения, задается false значение . |
x-ms-file-permission-key |
Версия 2019-02-02 и более поздние. Ключ разрешения для файла. |
x-ms-file-attributes |
Версия 2019-02-02 и более поздние. Атрибуты файловой системы файла. Дополнительные сведения см. в списке доступных атрибутов. |
x-ms-file-creation-time |
Версия 2019-02-02 и более поздние. Значение даты и времени в формате UTC, представляющее свойство времени создания файла. |
x-ms-file-last-write-time |
Версия 2019-02-02 и более поздние. Значение даты и времени в формате UTC, представляющее свойство времени последней записи для файла. |
x-ms-file-change-time |
Версия 2019-02-02 и более поздние. Значение даты и времени в формате UTC, представляющее свойство времени изменения для файла. |
x-ms-file-file-id |
Версия 2019-02-02 и более поздние. Идентификатор файла. |
x-ms-file-parent-id |
Версия 2019-02-02 и более поздние. Идентификатор родительского файла. |
x-ms-lease-duration:infinite |
Версия 2019-02-02 и более поздние. При аренде файла указывает, что аренда имеет бесконечный срок. |
x-ms-lease-state:<available;leased;broken> |
Версия 2019-02-02 и более поздние. При аренде файла указывает состояние аренды файла. |
x-ms-lease-status:<locked;unlocked> |
Версия 2019-02-02 и более поздние. При аренде файла указывает состояние аренды файла. |
x-ms-client-request-id |
Может использоваться для устранения неполадок с запросами и соответствующими ответами. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, он отсутствует в ответе. |
Текст ответа
Нет.
Пример ответа
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
Авторизация
Вызов этой операции доступен только владельцу учетной записи.