Поделиться через

Path - Get Properties

  • Ссылка
Служба:
Storage Services
Версия API:
2023-08-03

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

HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}
С использованием необязательных параметров: 
HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&upn={upn}&fsAction={fsAction}&timeout={timeout}

Параметры URI

Имя В Обязательно Тип Описание
accountName
 path True

string

Имя учетной записи хранения Azure.
dnsSuffix
 path True

string

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

string

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

Шаблон регулярного выражения: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
path
 path True

string

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

PathGetPropertiesAction

Необязательный элемент. Если значение равно 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. Обратите внимание, что идентификаторы объектов групп и приложений не переводятся, так как они не имеют уникальных понятных имен.

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

Имя Обязательно Тип Описание
x-ms-lease-id

string

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

Шаблон регулярного выражения: ^[{(]?[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, записанный в журналы аналитики для устранения неполадок и корреляции.

Шаблон регулярного выражения: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

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

string

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

Ответы

Имя Тип Описание
200 OK

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

Заголовки

  • 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
  • x-ms-creation-time: string
  • x-ms-expiry-time: string
Other Status Codes

DataLakeStorageError

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

  • 400 Bad Request, ContentLengthMustBeZero, "Заголовок запроса Content-Length должен быть равен нулю".
  • 400 Bad Request, InvalidAuthenticationInfo, "Сведения о проверке подлинности предоставляются не в правильном формате. Проверьте значение заголовка Authorization.
  • 400 Bad Request, InvalidFlushPosition, "Отправленные данные не являются непрерывными или значение параметра запроса позиции не равно длине файла после добавления отправленных данных".
  • 400 Bad Request, InvalidHeaderValue, "Значение для одного из заголовков HTTP имеет неправильный формат".
  • 400 Bad Request, InvalidHttpVerb, "Указанная HTTP-команда недопустима — она не распознается сервером".
  • 400 Bad Request, 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 Forbidden, InsufficientAccountPermissions, "У учетной записи, к которой осуществляется доступ, нет достаточных разрешений для выполнения этой операции".
  • 404 Не найдено, FilesystemNotFound, "Указанная файловая система не существует".
  • 404 Не найдено, PathNotFound, "Указанный путь не существует".
  • 404 Not Found, RenameDestinationParentPathNotFound, "Родительский каталог пути назначения не существует".
  • 404 Не найдено, ResourceNotFound, "Указанный ресурс не существует".
  • 404 Не найдено, SourcePathNotFound, "Исходный путь для операции переименования не существует".
  • 405 Method Not Allowed, 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 Conflict, 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 Request Entity Too Large, RequestBodyTooLarge, "Текст запроса слишком велик и превышает максимально допустимое ограничение".
  • 416 Запрошенный диапазон не удовлетворяет, InvalidRange, "Указанный диапазон недопустим для текущего размера ресурса".
  • 500 Внутренняя ошибка сервера, InternalError, "Сервер столкнулся с внутренней ошибкой. Пожалуйста, повторите запрос".
  • 500 Внутренняя ошибка сервера OperationTimedOut: "Операция не может быть завершена в течение разрешенного времени".
  • 503 Служба недоступна, ServerBusy, "Исходящий трафик превышает ограничение учетной записи".
  • 503 Служба недоступна, ServerBusy, "Входящий трафик превышает ограничение учетной записи".
  • 503 Служба недоступна, ServerBusy, "Количество операций в секунду превышает лимит учетной записи".
  • 503 Служба недоступна, ServerBusy: "В настоящее время серверу не удается получить запросы. Please retry your request." (Программе установки кластера не удалось установить компоненты в одном или нескольких узлах. Повторите запрос.)

Заголовки

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

Определения

Имя Описание
DataLakeStorageError
Error

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

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

DataLakeStorageError

Имя Тип Описание
error

Error

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

Error

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

Имя Тип Описание
code

string

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

string

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

PathGetPropertiesAction

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

Имя Тип Описание
checkAccess

string

getAccessControl

string

getStatus

string