Получение метаданных общего ресурса
Операция Get Share Metadata
возвращает все пользовательские метаданные для общей папки Azure или общей папки snapshot.
Хотя этот API полностью поддерживается, он является устаревшим API управления. По этой причине рекомендуется использовать общие папки — Get, предоставляемые поставщиком ресурсов хранилища (Microsoft.Storage).
Дополнительные сведения о программном взаимодействии с ресурсами с помощью поставщика ресурсов хранилища см. в статье Операции с FileShare
общими файловыми ресурсами Azure.
Доступность протокола
Включенный протокол общей папки | Доступно |
---|---|
SMB | |
NFS |
Запрос
Запрос Get Share Metadata
составляется следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime> |
HTTP/1.1 |
Замените компоненты пути, отображаемые в URI запроса, собственными, как показано ниже.
Компонент path | Описание |
---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
Сведения об ограничениях именования путей см. в статье Имя и ссылочные общие папки, каталоги, файлы и метаданные.
Параметры универсального кода ресурса (URI)
В URI запроса можно указать следующие дополнительные параметры:
Параметр | Описание |
---|---|
sharesnapshot |
Необязательный элемент. Версия 17.04.2017 и более поздняя. Параметр sharesnapshot является непрозрачным значением даты и времени, которое при наличии указывает общий snapshot для запроса для получения метаданных. |
timeout |
Необязательный элемент. Параметр timeout указывается в секундах. Дополнительные сведения см. в статье Настройка времени ожидания для операций Файлы Azure. |
Заголовки запросов
Заголовок запроса | Описание |
---|---|
Authorization |
Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Файлы Azure. |
x-ms-lease-id:<ID> |
Необязательный элемент. Версия 10.02.2020 и более поздняя. Если указан заголовок, операция выполняется только в том случае, если аренда общей папки активна, а идентификатор аренды, указанный в запросе, соответствует идентификатору аренды общей папки. Если совпадения нет, операция завершается ошибкой с кодом состояния 412 (сбой условия). |
Текст запроса
Нет.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Дополнительные сведения о кодах состояния см. в разделе Коды состояния и ошибок.
Заголовки ответов
Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
Заголовок ответа | Описание |
---|---|
Last-Modified |
Возвращает дату и время последнего изменения общей папки. Дата в формате согласно RFC 1123. Дополнительные сведения см. в разделе Представление значений даты и времени в заголовках. Любая операция, которая изменяет общий ресурс или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения общего ресурса. |
x-ms-meta-name:value |
Набор пар "имя-значение", содержащих определяемые пользователем метаданные для общей папки. |
ETag |
Содержит значение, которое можно использовать для условного выполнения операций. Значение заключено в кавычки. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос и может использоваться для устранения неполадок с запросом. Дополнительные сведения см. в статье Устранение неполадок с операциями API. |
x-ms-version |
Указывает версию Файлы Azure, которая использовалась для выполнения запроса. |
Date или x-ms-date |
Значение даты и времени в формате UTC, созданное службой, которое указывает время инициации ответа. |
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:
Transfer-Encoding: chunked
x-ms-meta-name: somemetadata
Date: Mon, 27 Jan 2014 22:49:18 GMT
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT
x-ms-version: 2014-02-14
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Авторизация
Вызов этой операции доступен только владельцу учетной записи.
Комментарии
Эта операция возвращает только определяемые пользователем метаданные для общего ресурса. Чтобы также вернуть системные свойства, вызовите Get Share Properties.