Path - Get Properties

  • Ссылка
Service:
Storage Services
API Version:
2021-10-04

Получение свойств | Получение | состояния Получение | списка контроль доступа Проверка доступа
Функция Get Properties возвращает все системные и пользовательские свойства для пути. Возвращает все системные свойства для пути. Получение контроль доступа List возвращает список управления доступом для пути. Эта операция поддерживает условные HTTP-запросы. Дополнительные сведения см. в статье Указание условных заголовков для операций службы BLOB-объектов.

HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}
With optional parameters: 
HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&upn={upn}&fsAction={fsAction}&timeout={timeout}

Параметры URI

Name In Required Type Description
accountName
 path True
  • string

Имя учетной записи служба хранилища Azure.
dnsSuffix
 path True
  • string

DNS-суффикс для конечной точки Azure Data Lake Storage.
filesystem
 path True
  • string

Идентификатор файловой системы.

Regex pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
path
 path True
  • string

Путь к файлу или каталогу.
action
 query

Необязательный элемент. Если значение равно getStatus, возвращаются только системные свойства, определенные для пути. Если значение равно "getAccessControl", список управления доступом возвращается в заголовках ответа (иерархическое пространство имен должно быть включено для учетной записи), в противном случае возвращаются свойства.
fsAction
 query
  • string

Требуется только для проверки действия доступа. Действителен только в том случае, если для учетной записи включено иерархическое пространство имен. Операция чтения и записи и выполнения файловой системы в строковой форме, соответствующая шаблону регулярного выражения "[rwx-]{3}"
timeout
 query
  • integer
int32

Необязательное значение времени ожидания операции в секундах. Период начинается, когда служба получает запрос. Если значение времени ожидания истекает до завершения операции, операция завершается ошибкой.
upn
 query
  • boolean

Необязательный элемент. Действителен только в том случае, если для учетной записи включено иерархическое пространство имен. Если задано значение true, значения идентификаторов пользователя, возвращаемые в заголовках ответа x-ms-owner, x-ms-group и x-ms-acl, будут преобразованы из идентификаторов объектов Azure Active Directory в имена субъектов-пользователей. Если значение равно false, значения будут возвращены в виде идентификаторов объектов Azure Active Directory. Значением по умолчанию является false. Обратите внимание, что идентификаторы объектов групп и приложений не преобразуются, так как они не имеют уникальных понятных имен.

Заголовок запроса

Name Required Type Description
x-ms-lease-id
  • string

Необязательный элемент. Если этот заголовок указан, операция будет выполнена только в том случае, если выполняются оба следующих условия: i) аренда пути в настоящее время активна и ii) идентификатор аренды, указанный в запросе, соответствует этому пути.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
If-Match
  • string

Необязательный элемент. Значение ETag. Укажите этот заголовок для выполнения операции только в том случае, если ETag ресурса соответствует указанному значению. ETag должен быть указан в кавычках.
If-None-Match
  • string

Необязательный элемент. Значение ETag или специальное значение подстановочного знака ("*"). Укажите этот заголовок для выполнения операции только в том случае, если ETag ресурса не соответствует указанному значению. ETag должен быть указан в кавычках.
If-Modified-Since
  • string

Необязательный элемент. Значение даты и времени. Укажите этот заголовок для выполнения операции, только если ресурс был изменен с указанной даты и времени.
If-Unmodified-Since
  • string

Необязательный элемент. Значение даты и времени. Укажите этот заголовок для выполнения операции, только если ресурс не был изменен с указанной даты и времени.
x-ms-encryption-key
  • string

Необязательный элемент. Ключ шифрования AES-256 с кодировкой Base64.
x-ms-encryption-key-sha256
  • string

Необязательный элемент. Хэш SHA256 в кодировке Base64 ключа шифрования.
x-ms-encryption-algorithm: AES256
  • string

Необязательный элемент. Задает алгоритм, используемый для шифрования. Значение этого заголовка должно быть AES256.
x-ms-client-request-id
  • string

UUID, записанный в журналах аналитики для устранения неполадок и корреляции.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date
  • string

Задает время запроса в формате UTC. Это необходимо при использовании авторизации общего ключа.
x-ms-version
  • string

Указывает версию протокола REST, используемого для обработки запроса. Это необходимо при использовании авторизации общего ключа.

Ответы

Name Type Description
200 OK

Возвращает все свойства файла или каталога.

Headers

  • Accept-Ranges: string
  • Cache-Control: string
  • Content-Disposition: string
  • Content-Encoding: string
  • Content-Language: string
  • Content-Length: integer
  • Content-Range: string
  • Content-Type: string
  • Content-MD5: string
  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-resource-type: string
  • x-ms-properties: string
  • x-ms-owner: string
  • x-ms-group: string
  • x-ms-permissions: string
  • x-ms-acl: string
  • x-ms-lease-duration: string
  • x-ms-lease-state: string
  • x-ms-lease-status: string
  • x-ms-server-encrypted: true/false: boolean
  • x-ms-encryption-key-sha256: string
  • x-ms-encryption-context: string
  • x-ms-encryption-scope: string
Other Status Codes

Произошла ошибка. Ниже перечислены возможные состояния HTTP, код и строки сообщений:

  • 400 Bad Request, ContentLengthMustBeZero, "Заголовок запроса Content-Length должен быть равен нулю".
  • 400 Bad Request, InvalidAuthenticationInfo, "Сведения о проверке подлинности не указаны в правильном формате. Проверьте значение заголовка авторизации".
  • 400 Bad Request, InvalidFlushPosition, "Переданные данные не являются непрерывными, или значение параметра запроса позиции не равно длине файла после добавления отправленных данных".
  • 400 Bad Request, InvalidHeaderValue, "Значение для одного из заголовков HTTP не имеет правильного формата".
  • 400 Недопустимый запрос, InvalidHttpVerb, "Указанная http-команда недопустима — она не распознается сервером".
  • 400 Недопустимый запрос, InvalidInput, "Один из входных данных запроса недопустим".
  • 400 Bad Request, InvalidPropertyName, "Имя свойства не может быть пустым".
  • 400 Bad Request, InvalidPropertyName, "Имя свойства содержит недопустимые символы".
  • 400 Bad Request, InvalidQueryParameterValue, "Значение для одного из параметров запроса, указанных в URI запроса, недопустимо".
  • 400 Bad Request, InvalidResourceName, "Указанное имя ресурса содержит недопустимые символы".
  • 400 Bad Request, InvalidSourceUri, "Исходный URI недопустим".
  • 400 Bad Request, InvalidUri, "Недопустимый URI запроса".
  • 400 Bad Request, MissingRequiredHeader, "Заголовок HTTP, обязательный для этого запроса не указан".
  • 400 Bad Request, MissingRequiredQueryParameter, "Параметр запроса, обязательный для этого запроса, не указан".
  • 400 Bad Request, MultipleConditionHeadersNotSupported, "Несколько заголовков условий не поддерживаются".
  • 400 Bad Request, OutOfRangeInput, "Один из входных данных запроса выходит за пределы диапазона".
  • 400 Bad Request, OutOfRangeQueryParameterValue, "Один из параметров запроса, указанных в URI запроса, находится вне допустимого диапазона".
  • 400 Bad Request, UnsupportedHeader, "Один из заголовков, указанных в запросе, не поддерживается".
  • 400 Bad Request, UnsupportedQueryParameter, "Один из параметров запроса, указанных в URI запроса, не поддерживается".
  • 400 Bad Request, UnsupportedRestVersion, "Указанная версия REST не поддерживается".
  • 403 Запрещено, AccountIsDisabled, "Указанная учетная запись отключена".
  • 403 Запрещено, AuthorizationFailure: "Этот запрос не авторизован для выполнения этой операции".
  • 403 Запрещено, InsufficientAccountPermissions: "Доступ к учетной записи не имеет достаточных разрешений для выполнения этой операции".
  • 404 Not Found, FilesystemNotFound, "Указанная файловая система не существует".
  • 404 Not Found, PathNotFound, "Указанный путь не существует".
  • 404 Not Found, RenameDestinationParentPathNotFound, "Родительский каталог пути назначения не существует".
  • 404 Not Found, ResourceNotFound, "Указанный ресурс не существует".
  • 404 Not Found, SourcePathNotFound, "Исходный путь для операции переименования не существует".
  • Метод 405 Не разрешен, unsupportedHttpVerb, "Ресурс не поддерживает указанную http-команду".
  • 409 Conflict, DestinationPathIsBeingDeleted, "Указанный путь назначения помечен для удаления".
  • 409 Conflict, DirectoryNotEmpty, "Значение параметра рекурсивного запроса должно иметь значение true, чтобы удалить непустый каталог".
  • 409 Conflict, FilesystemAlreadyExists, "Указанная файловая система уже существует".
  • 409 Conflict, FilesystemBeingDeleted, "Указанная файловая система удаляется".
  • 409 Conflict, InvalidDestinationPath, "Указанный путь или элемент пути существует, и его тип ресурса недопустим для этой операции". * 409 Conflict, InvalidFlushOperation, "Ресурс был создан или изменен API службы BLOB-объектов и не может быть записан в API службы Data Lake Storage".
  • 409 Conflict, InvalidRenameSourcePath, "Исходный каталог не может совпадать с целевым каталогом, а назначение не может быть подкаталогом исходного каталога".
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "Тип исходного и целевого ресурсов должен быть идентичным".
  • 409 Conflict, LeaseAlreadyPresent, "Существует уже арендная аренда".
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "Указанный идентификатор аренды не совпадает с идентификатором аренды ресурса с указанной операцией аренды".
  • 409 Конфликт, LeaseIsAlreadyBroken, "Аренда уже нарушена и не может быть нарушена снова".
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "Идентификатор аренды сопоставлен, но аренда в настоящее время находится в критическом состоянии и не может быть приобретена до тех пор, пока она не будет нарушена".
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "Идентификатор аренды сопоставлен, но аренда в настоящее время находится в критическом состоянии и не может быть изменена".
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "Идентификатор аренды совпадал, но аренда была нарушена явным образом и не может быть продлена".
  • 409 Conflict, LeaseNameMismatch, "Указанное имя аренды не совпадает с существующим именем аренды".
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "Идентификатор аренды отсутствует с указанной операцией аренды".
  • 409 Conflict, PathAlreadyExists, "Указанный путь уже существует".
  • 409 Conflict, PathConflict, "Указанный путь или элемент пути существует, и его тип ресурса недопустим для этой операции".
  • 409 Conflict, SourcePathIsBeingDeleted, "Указанный исходный путь помечен для удаления".
  • 409 Conflict, ResourceTypeMismatch: "Тип ресурса, указанный в запросе, не соответствует типу ресурса".
  • 412 Сбой предварительного условия, ConditionNotMet, "Условие, указанное с использованием условных заголовков HTTP, не выполняется".
  • 412 Сбой предварительного условия, LeaseIdMismatch, "Указанный идентификатор аренды не совпадает с идентификатором аренды ресурса".
  • 412 Сбой предварительного условия, LeaseIdMissing: "В настоящее время имеется аренда ресурса и идентификатор аренды не указан в запросе".
  • 412 Сбой предварительного условия, LeaseNotPresent: "В настоящее время нет аренды ресурса".
  • 412 Сбой предварительного условия, LeaseLost, "Был указан идентификатор аренды, но срок аренды ресурса истек".
  • 412 Сбой предварительного условия, SourceConditionNotMet, "Исходное условие, указанное с использованием условных заголовков HTTP, не выполняется".
  • 413. Слишком большая сущность запроса, RequestBodyTooLarge: "Текст запроса слишком велик и превышает максимально допустимое ограничение".
  • 416 Запрошенный диапазон не удовлетворяется, InvalidRange, "Указанный диапазон недопустим для текущего размера ресурса".
  • 500 Внутренняя ошибка сервера, InternalError, "Сервер столкнулся с внутренней ошибкой. Пожалуйста, повторите запрос".
  • 500 Внутренняя ошибка сервера, OperationTimedOut, "Не удалось завершить операцию в течение разрешенного времени".
  • 503 Служба недоступна, ServerBusy, "Egress превышает предел учетной записи".
  • 503 Служба недоступна, ServerBusy, "Входящий трафик превышает предел учетной записи".
  • 503 Служба недоступна, ServerBusy, "Операции в секунду превышает предел учетной записи".
  • 503 Service Unavailable, ServerBusy, "Сервер в настоящее время не может получать запросы. Please retry your request." (Программе установки кластера не удалось установить компоненты в одном или нескольких узлах. Повторите запрос.)

Headers

  • x-ms-request-id: string
  • x-ms-version: string

Определения

DataLakeStorageError
Error

Объект ответа об ошибке службы.
PathGetPropertiesAction

Необязательный элемент. Если значение равно getStatus, возвращаются только системные свойства, определенные для пути. Если значение равно "getAccessControl", список управления доступом возвращается в заголовках ответа (для учетной записи должно быть включено иерархическое пространство имен), в противном случае возвращаются свойства.

DataLakeStorageError

Name Type Description
error

Объект ответа об ошибке службы.

Error

Объект ответа об ошибке службы.

Name Type Description
code
  • string

Код ошибки службы.
message
  • string

Сообщение об ошибке службы.

PathGetPropertiesAction

Необязательный элемент. Если значение равно getStatus, возвращаются только системные свойства, определенные для пути. Если значение равно "getAccessControl", список управления доступом возвращается в заголовках ответа (для учетной записи должно быть включено иерархическое пространство имен), в противном случае возвращаются свойства.

Name Type Description
checkAccess
  • string
getAccessControl
  • string
getStatus
  • string