Получение свойств общего ресурса
Запрос Get Share Properties возвращает свойства для указанного моментального снимка общего ресурса или общего ресурса.
Хотя этот API полностью поддерживается, это устаревший API управления. По этой причине рекомендуется использовать общих папок — получить, которая предоставляется поставщиком ресурсов хранилища (Microsoft.Storage).
Дополнительные сведения о программном взаимодействии с ресурсами FileShare с помощью поставщика ресурсов хранилища см. в разделе Operations on FileShares.
Доступность протокола
| Протокол общей папки с включенным доступом | Доступный |
|---|---|
| SMB |
|
| NFS |
|
Просьба
Запрос Get Share Properties может быть создан следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | URI запроса | ВЕРСИЯ HTTP |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
HTTP/1.1 |
Замените компоненты пути, отображаемые в URI запроса собственным, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя общей папки. |
Сведения об ограничениях именования путей см. в разделе Имя и справочные ресурсы, каталоги, файлы и метаданные.
Параметры URI
В URI запроса можно указать следующие дополнительные параметры:
| Параметр | Описание |
|---|---|
sharesnapshot |
Необязательный. Версия 2017-04-17 и более поздних версий. Параметр sharesnapshot — это непрозрачное значение даты и времени, указывающее моментальный снимок общей папки для получения свойств. |
timeout |
Необязательный. Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в статье Настройка времени ожидания операций службы "Файлы Azure". |
Заголовки запросов
Обязательные и необязательные заголовки описаны в следующей таблице:
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательно. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к службе хранилища Azure. |
Date или x-ms-date |
Обязательно. Указывает универсальное время (UTC) для запроса. Дополнительные сведения см. в статье Авторизация запросов к службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Указывает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями служб хранилища Azure. |
x-ms-client-request-id |
Необязательный. Предоставляет созданное клиентом непрозрачное значение с ограничением символов 1-kibibyte (KiB), записанным в журналах при настройке ведения журнала. Настоятельно рекомендуется использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в статье Monitor Azure Files. |
x-ms-lease-id:<ID> |
Необязательный. Версия 2020-02-10 и более поздних версий. Если заголовок указан, операция выполняется только в том случае, если аренда общей папки в настоящее время активна, а идентификатор аренды, указанный в запросе, соответствует идентификатору аренды общей папки. Если совпадения нет, операция завершается ошибкой с кодом состояния 412 (сбой предварительных условий). |
Текст запроса
Никакой.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Дополнительные сведения о кодах состояния см. в коды состояния и коды ошибок.
Заголовки ответа
Ответ для этой операции содержит следующие заголовки. Ответ также может включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
| Заголовок ответа | Описание |
|---|---|
Last-Modified |
Возвращает дату и время последнего изменения общей папки. Формат даты следует RFC 1123. Дополнительные сведения см. в разделе Представление значений Date-Time в заголовках. Любая операция, которая изменяет общую папку или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения общей папки. |
x-ms-meta-name:value |
Набор пар "имя-значение", содержащих пользовательские метаданные общей папки. |
ETag |
Содержит значение, которое можно использовать для условного выполнения операций. Значение заключено в кавычки. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос и может использоваться для устранения неполадок запроса. Дополнительные сведения см. в статье Устранение неполадок с операциями API. |
x-ms-version |
Версия файлов Azure, используемая для выполнения запроса. |
Date |
Значение даты и времени в формате UTC, созданное службой, указывающее время, когда был инициирован ответ. |
x-ms-share-quota |
Версия 2015-02-21 и более поздних версий. Возвращает текущую квоту общего ресурса в гибибайтах (GiB). |
x-ms-share-provisioned-iops |
Версия 2019-07-07 и более поздних версий. Возвращается только для общих папок класса Premium (общие папки в типе учетной записи хранения FileStorage). Возвращает количество операций ввода-вывода в секунду (операций ввода-вывода в секунду), подготовленных для общей папки premium. |
x-ms-share-provisioned-ingress-mbps |
Версия 2019-07-07 и более поздних версий. Возвращается только для общих папок класса Premium (общие папки в типе учетной записи хранения FileStorage). Возвращает входящий трафик в мебибайтах в секунду (MiB/s), как было подготовлено для общей папки premium. |
x-ms-share-provisioned-egress-mbps |
Версия 2019-07-07 и более поздних версий. Возвращается только для общих папок класса Premium (общие папки в типе учетной записи хранения FileStorage). Возвращает исходящие данные в MiB/s, как было подготовлено для общей папки premium. |
x-ms-share-provisioned-bandwidth-mibps |
Версия 2021-02-12 и более поздних версий. Возвращается только для общих папок класса Premium (общие папки в типе учетной записи хранения FileStorage). Возвращает объединенную пропускную способность (ingress + исходящий трафик) в MiB/s, как подготовлено для общей папки premium. |
x-ms-share-next-allowed-quota-downgrade-time |
Версия 2019-07-07 и более поздних версий. Возвращается только для общих папок класса Premium (общие папки в типе учетной записи хранения FileStorage). Значение даты и времени, указывающее, когда квота для общей папки класса Premium разрешена уменьшить. Формат даты следует RFC 1123. |
x-ms-access-tier |
Версия 2019-12-12 и более поздних версий. Возвращает текущий уровень доступа общей папки. В учетных записях хранения общего назначения версии 2 (GPv2) TransationOptimized — это уровень общего ресурса по умолчанию. В типах учетных записей хранения FileStorage Premium — это уровень по умолчанию общей папки. |
x-ms-access-tier-change-time |
Версия 2019-12-12 и более поздних версий. Возвращает дату и время последнего изменения уровня доступа в общей папке. |
x-ms-access-tier-transition-state |
Версия 2019-12-12 и более поздних версий. Если общий ресурс проходит переход на уровень, этот заголовок указывает уровень, с которым он переходит. |
x-ms-lease-duration:<fixed,infinite> |
Версия 2020-02-10 и более поздних версий. Указывает, является ли аренда общей папки бесконечной или фиксированной. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Версия 2020-02-10 и более поздних версий. При аренде общей папки этот заголовок указывает состояние аренды общей папки. |
x-ms-lease-status: <locked;unlocked> |
Версия 2020-02-10 и более поздних версий. При аренде общей папки этот заголовок указывает состояние аренды общей папки. |
x-ms-enabled-protocols: <SMB;NFS> |
Возвращает текущие протоколы с поддержкой общего доступа для версии 2019-07-07 и более поздних версий. - SMB. Доступ к общей папке можно получить с помощью SMBv3.0, SMBv2.1 и REST.- NFS. Доступ к общей папке можно получить с помощью NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Возвращает текущее поведение корневого скваширования общего ресурса для версии 2019-07-07 и более поздних версий. Только NFS. - NoRootSquash: корневое скваширование отключено.- RootSquash: запросы из UID/GID 0 сопоставляются с анонимным UID/GID.- AllSquash: все идентификаторы пользовательского интерфейса и GID сопоставляются с анонимным пользователем.Этот заголовок возвращается только для общих папок, а не для моментальных снимков. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Версия 2024-08-04 и более позднюю. Указывает, должен ли виртуальный каталог моментального снимка быть доступен в корне точки подключения общего ресурса при включении NFS. Этот заголовок возвращается только для общих папок, а не для моментальных снимков. |
x-ms-client-request-id |
Можно использовать для устранения неполадок запросов и соответствующих ответов. Значение этого заголовка равно значению заголовка x-ms-client-request-id, если оно присутствует в запросе, а значение содержит не более 1024 видимых символов ASCII. Если в запросе отсутствует заголовок x-ms-client-request-id, он не будет присутствовать в ответе. |
x-ms-share-paid-bursting-enabled: <true;false> |
Версия 2024-11-04 и более поздних версий. Возвращается только для общих папок класса Premium (общие папки в типе учетной записи хранения FileStorage). Указывает, включена ли платная вспышка. Этот заголовок возвращается только для общих папок, а не для моментальных снимков. |
x-ms-share-paid-bursting-max-iops |
Версия 2024-11-04 и более поздних версий. Возвращается только для общих папок класса Premium. Возвращает максимальное количество платных операций ввода-вывода в секунду, разрешенных для общей папки. Возвращается только в том случае, если x-ms-share-paid-bursting-enabled имеет значение true.Этот заголовок возвращается только для общих папок, а не для моментальных снимков. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Версия 2024-11-04 и более поздних версий. Возвращается только для общих папок класса Premium. Возвращает максимальное количество платных миБ/с, разрешенных для общей папки. Возвращается только в том случае, если x-ms-share-paid-bursting-enabled имеет значение true.Этот заголовок возвращается только для общих папок, а не для моментальных снимков. |
Текст ответа
Никакой.
Пример ответа
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Авторизация
Только владелец учетной записи может вызвать эту операцию.
Замечания
Никакой.