Path - Get Properties

Reference

Služba:: Storage Services

Verze rozhraní API:: 2023-08-03

Získat vlastnosti | Získat stav | Získat seznam Access Control | Kontrola přístupu
Funkce Get Properties vrátí všechny systémové a uživatelem definované vlastnosti pro cestu. Funkce Get Status vrátí všechny systémem definované vlastnosti pro cestu. Get Access Control List vrátí seznam řízení přístupu pro cestu. Tato operace podporuje podmíněné požadavky HTTP. Další informace najdete v tématu Určení podmíněných hlaviček pro operace služby Blob Service.

HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string	Název účtu služby Azure Storage.
dnsSuffix	path	True	string	Přípona DNS pro koncový bod Azure Data Lake Storage.
filesystem	path	True	string	Identifikátor systému souborů. Vzor regulárního výrazu: `^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$`
path	path	True	string	Cesta k souboru nebo adresáři.
action	query		PathGetPropertiesAction	Nepovinný parametr. Pokud je hodnota "getStatus", vrátí se pouze systémově definované vlastnosti pro cestu. Pokud je hodnota getAccessControl, vrátí se v hlavičce odpovědi seznam řízení přístupu (pro účet musí být povolený hierarchický obor názvů), jinak se vrátí vlastnosti.
fsAction	query		string	Vyžaduje se pouze pro akci kontroly přístupu. Platí jenom v případě, že je pro účet povolený hierarchický obor názvů. Operace systému souborů pro čtení/zápis/spuštění v řetězcové podobě, odpovídající vzor regex '[rwx-]{3}"
timeout	query		integer int32	Volitelná hodnota časového limitu operace v sekundách. Období začíná tím, že služba obdrží požadavek. Pokud hodnota časového limitu uplynou před dokončením operace, operace selže.
upn	query		boolean	Nepovinný parametr. Platí jenom v případě, že je pro účet povolený hierarchický obor názvů. Pokud je hodnota true, hodnoty identity uživatele vrácené v hlavičce odpovědí x-ms-owner, x-ms-group a x-ms-ACL se transformují z ID objektů Azure Active Directory na hlavní názvy uživatelů. Pokud je false, vrátí se hodnoty jako ID objektů Azure Active Directory. Výchozí hodnota je False. Všimněte si, že ID objektů skupin a aplikací se nepřekládají, protože nemají jedinečné popisné názvy.

Hlavička požadavku

Name	Typ	Description
x-ms-lease-id	string	Nepovinný parametr. Pokud je tato hlavička zadána, operace se provede pouze v případě, že jsou splněny obě následující podmínky: i) zapůjčení cesty je aktuálně aktivní a ii) ID zapůjčení zadané v požadavku odpovídá id cesty. Vzor regulárního výrazu: `^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$`
If-Match	string	Nepovinný parametr. Hodnota ETag. Tuto hlavičku zadejte pro provedení operace pouze v případě, že značka ETag prostředku odpovídá zadané hodnotě. Značka ETag musí být zadána v uvozovkách.
If-None-Match	string	Nepovinný parametr. Hodnota ETag nebo speciální hodnota se zástupným znakem (*). Zadáním této hlavičky provedete operaci pouze v případě, že značka ETag prostředku neodpovídá zadané hodnotě. Značka ETag musí být zadána v uvozovkách.
If-Modified-Since	string	Nepovinný parametr. Hodnota data a času Zadáním této hlavičky provedete operaci pouze v případě, že byl prostředek od zadaného data a času změněn.
If-Unmodified-Since	string	Nepovinný parametr. Hodnota data a času Tuto hlavičku zadejte pro provedení operace pouze v případě, že prostředek nebyl od zadaného data a času změněn.
x-ms-encryption-key	string	Nepovinný parametr. Šifrovací klíč AES-256 s kódováním Base64.
x-ms-encryption-key-sha256	string	Nepovinný parametr. Hodnota hash SHA256 šifrovacího klíče v kódování Base64.
x-ms-encryption-algorithm: AES256	string	Nepovinný parametr. Určuje algoritmus, který se má použít pro šifrování. Hodnota této hlavičky musí být AES256.
x-ms-client-request-id	string	Identifikátor UUID zaznamenaný v analytických protokolech pro řešení potíží a korelaci. Vzor regulárního výrazu: `^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$`
x-ms-date	string	Určuje formát UTC (Coordinated Universal Time). To se vyžaduje při použití autorizace sdíleného klíče.
x-ms-version	string	Určuje verzi protokolu REST použitého ke zpracování požadavku. To se vyžaduje při použití autorizace sdíleného klíče.

Odpovědi

Name	Typ	Description
200 OK		Vrátí všechny vlastnosti souboru nebo adresáře. Hlavičky 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 x-ms-client-transaction-id: string
Other Status Codes	DataLakeStorageError	Došlo k chybě. Možné stavové řetězce HTTP, kód a řetězce zpráv jsou uvedené níže: 400 Chybný požadavek, ContentLengthMustBeZero, Hlavička požadavku Content-Length musí být nulová. 400 Chybný požadavek, InvalidAuthenticationInfo, "Ověřovací informace nejsou uvedeny ve správném formátu. Zkontrolujte hodnotu autorizační hlavičky. 400 Chybný požadavek, InvalidFlushPosition, "Nahraná data nejsou souvislá nebo hodnota parametru dotazu pozice není rovna délce souboru po připojení nahraných dat." 400 Chybný požadavek, InvalidHeaderValue, "Hodnota pro jednu z hlaviček HTTP není ve správném formátu." 400 Chybný požadavek, InvalidHttpVerb, "Zadaný příkaz HTTP je neplatný – server ho nerozpoznal." 400 Chybný požadavek, InvalidInput, "Jeden ze vstupů požadavku není platný." 400 Chybný požadavek, InvalidPropertyName, "Název vlastnosti nemůže být prázdný." 400 Chybný požadavek, InvalidPropertyName, "Název vlastnosti obsahuje neplatné znaky." 400 Chybný požadavek, InvalidQueryParameterValue, "Hodnota jednoho z parametrů dotazu zadaných v identifikátoru URI požadavku je neplatná." 400 Chybný požadavek, InvalidResourceName, "Zadaný název prostředku obsahuje neplatné znaky." 400 Chybný požadavek, InvalidSourceUri, "zdrojový identifikátor URI je neplatný." 400 Chybný požadavek, InvalidUri, "Identifikátor URI požadavku je neplatný." 400 Chybný požadavek, MissingRequiredHeader, "Hlavička HTTP, která je pro tento požadavek povinná, není zadána." 400 Chybný požadavek, MissingRequiredQueryParameter, "Není zadán parametr dotazu, který je pro tento požadavek povinný." 400 Chybný požadavek, MultipleConditionHeadersNotSupported, "Více hlaviček podmínky nejsou podporovány." 400 Chybný požadavek, OutOfRangeInput, "Jeden ze vstupů požadavku je mimo rozsah." 400 Chybný požadavek, OutOfRangeQueryParameterValue, "Jeden z parametrů dotazu zadaných v identifikátoru URI požadavku je mimo povolený rozsah." 400 Bad Request, UnsupportedHeader, "Jedna z hlaviček zadaných v požadavku není podporována." 400 Chybný požadavek, UnsupportedQueryParameter, "Jeden z parametrů dotazu zadaných v identifikátoru URI požadavku není podporován." 400 Chybný požadavek, NepodporovanárestVersion, "Zadaná verze rest je nepodporovaná" 403 Zakázáno, AccountIsDisabled, "Zadaný účet je zakázaný." 403 Zakázáno, AuthorizationFailure, "Tento požadavek nemá oprávnění k provedení této operace." 403 Zakázáno, InsufficientAccountPermissions, "Účet, ke kterým přistupujete, nemá dostatečná oprávnění ke spuštění této operace." 404 Nenalezeno, FilesystemNotFound, "Zadaný systém souborů neexistuje." 404 Nenalezeno, PathNotFound, "Zadaná cesta neexistuje." 404 Nenalezeno, RenameDestinationParentPathNotFound, Nadřazený adresář cílové cesty neexistuje. 404 Nenalezeno, ResourceNotFound, "Zadaný prostředek neexistuje." 404 Nenalezeno, SourcePathNotFound, "Zdrojová cesta pro operaci přejmenování neexistuje." 405 Method Not Allowed, UnsupportedHttpVerb, "The resource doesn't support the specified HTTP verb." 409 Conflict, DestinationPathIsBeingDeleted, "Zadaná cílová cesta je označena k odstranění." 409 Conflict, DirectoryNotEmpty, "Hodnota parametru rekurzivního dotazu musí být true, aby bylo možné odstranit neprázdný adresář." 409 Conflict, FilesystemAlreadyExists, "Zadaný systém souborů již existuje." 409 Konflikt, FilesystemBeingDeleted, "Zadaný systém souborů je odstraněn." 409 – Konflikt, InvalidDestinationPath, "Zadaná cesta nebo prvek cesty existuje a její typ prostředku je pro tuto operaci neplatný." * 409 Konflikt, InvalidFlushOperation, "Prostředek byl vytvořen nebo změněn rozhraním API služby Blob Service a nemůže být zapsán do rozhraní API služby Data Lake Storage." 409 Konflikt, InvalidRenameSourcePath, "Zdrojový adresář nemůže být stejný jako cílový adresář, ani cíl nemůže být podadresář zdrojového adresáře." 409 Conflict, InvalidSourceOrDestinationResourceType, "Typ zdrojového a cílového prostředku musí být identický." 409 – Konflikt, LeaseAlreadyPresent, "Zapůjčení již existuje." 409 Conflict, LeaseIdMismatchWithLeaseOperation, "Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku se zadanou operací zapůjčení." 409 Konflikt, LeaseIsAlreadyBroken, "Zapůjčení již bylo přerušeno a nelze ho znovu zlomit." 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "ID zapůjčení bylo spárováno, ale zapůjčení je aktuálně ve stavu přerušení a nelze jej získat, dokud nebude přerušeno." 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "ID zapůjčení bylo spárováno, ale zapůjčení je v současné době ve stavu přerušení a nelze ho změnit." 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "ID zapůjčení bylo spárováno, ale zapůjčení bylo explicitně přerušeno a nelze ho obnovit." 409 Conflict, LeaseNameMismatch, "Zadaný název zapůjčení neodpovídá existujícímu názvu zapůjčení." 409 Conflict, LeaseNotPresentWithLeaseOperation, "ID zapůjčení není k dispozici u zadané operace zapůjčení." 409 Konflikt, PathAlreadyExists, "Zadaná cesta již existuje." 409 Konflikt, PathConflict, "Zadaná cesta nebo prvek cesty existuje a její typ prostředku je pro tuto operaci neplatný." 409 Konflikt, SourcePathIsBeingDeleted, "Zadaná zdrojová cesta je označena k odstranění." 409 Konflikt, ResourceTypeMismatch, "Typ prostředku zadaný v požadavku neodpovídá typu prostředku." 412 Předběžná podmínka se nezdařila, ConditionNotMet, Podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna. 412 Předběžná podmínka se nezdařila, LeaseIdMismatch, "Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku." 412 Předběžná podmínka se nezdařila, LeaseIdMissing, "Prostředek je v současné době zapůjčen a v žádosti nebylo zadáno žádné ID zapůjčení." 412 Předběžná podmínka selhala, LeaseNotPresent, "Prostředek v současné době není zapůjčen." 412 Předběžná podmínka se nezdařila, LeaseLost, "Bylo zadáno ID zapůjčení, ale platnost zapůjčení prostředku vypršela." 412 Předpoklad se nezdařil, SourceConditionNotMet, "Zdrojová podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna." 413 Request Entity Too Large, RequestBodyTooLarge, "Text požadavku je příliš velký a překračuje maximální povolený limit." 416 Požadovaný rozsah není uspokojitelný, InvalidRange, "Zadaný rozsah je neplatný pro aktuální velikost prostředku." 500 Vnitřní chyba serveru, InternalError, "Server zjistil vnitřní chybu. Zkuste žádost zopakovat. 500 Vnitřní chyba serveru, OperationTimedOut, "Operaci nelze dokončit v povoleném čase." 503 Service Unavailable, ServerBusy, "Egress is over the account limit" (Výchozí přenos dat je nad limitem účtu). 503 Služba není k dispozici, ServerBusy, "Příchozí přenos dat překročil limit účtu". 503 Service Unavailable, ServerBusy, "Operations per second is over the account limit" (Počet operací za sekundu je nad limitem účtu). 503 Služba není k dispozici, ServerBusy, "Server v současné době nemůže přijímat požadavky. Zkuste prosím žádost zopakovat." Hlavičky x-ms-request-id: string x-ms-version: string

Name

Typ

Description

200 OK

Vrátí všechny vlastnosti souboru nebo adresáře.

Hlavičky

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
x-ms-client-transaction-id: string

Other Status Codes

DataLakeStorageError

Došlo k chybě. Možné stavové řetězce HTTP, kód a řetězce zpráv jsou uvedené níže:

400 Chybný požadavek, ContentLengthMustBeZero, Hlavička požadavku Content-Length musí být nulová.
400 Chybný požadavek, InvalidAuthenticationInfo, "Ověřovací informace nejsou uvedeny ve správném formátu. Zkontrolujte hodnotu autorizační hlavičky.
400 Chybný požadavek, InvalidFlushPosition, "Nahraná data nejsou souvislá nebo hodnota parametru dotazu pozice není rovna délce souboru po připojení nahraných dat."
400 Chybný požadavek, InvalidHeaderValue, "Hodnota pro jednu z hlaviček HTTP není ve správném formátu."
400 Chybný požadavek, InvalidHttpVerb, "Zadaný příkaz HTTP je neplatný – server ho nerozpoznal."
400 Chybný požadavek, InvalidInput, "Jeden ze vstupů požadavku není platný."
400 Chybný požadavek, InvalidPropertyName, "Název vlastnosti nemůže být prázdný."
400 Chybný požadavek, InvalidPropertyName, "Název vlastnosti obsahuje neplatné znaky."
400 Chybný požadavek, InvalidQueryParameterValue, "Hodnota jednoho z parametrů dotazu zadaných v identifikátoru URI požadavku je neplatná."
400 Chybný požadavek, InvalidResourceName, "Zadaný název prostředku obsahuje neplatné znaky."
400 Chybný požadavek, InvalidSourceUri, "zdrojový identifikátor URI je neplatný."
400 Chybný požadavek, InvalidUri, "Identifikátor URI požadavku je neplatný."
400 Chybný požadavek, MissingRequiredHeader, "Hlavička HTTP, která je pro tento požadavek povinná, není zadána."
400 Chybný požadavek, MissingRequiredQueryParameter, "Není zadán parametr dotazu, který je pro tento požadavek povinný."
400 Chybný požadavek, MultipleConditionHeadersNotSupported, "Více hlaviček podmínky nejsou podporovány."
400 Chybný požadavek, OutOfRangeInput, "Jeden ze vstupů požadavku je mimo rozsah."
400 Chybný požadavek, OutOfRangeQueryParameterValue, "Jeden z parametrů dotazu zadaných v identifikátoru URI požadavku je mimo povolený rozsah."
400 Bad Request, UnsupportedHeader, "Jedna z hlaviček zadaných v požadavku není podporována."
400 Chybný požadavek, UnsupportedQueryParameter, "Jeden z parametrů dotazu zadaných v identifikátoru URI požadavku není podporován."
400 Chybný požadavek, NepodporovanárestVersion, "Zadaná verze rest je nepodporovaná"
403 Zakázáno, AccountIsDisabled, "Zadaný účet je zakázaný."
403 Zakázáno, AuthorizationFailure, "Tento požadavek nemá oprávnění k provedení této operace."
403 Zakázáno, InsufficientAccountPermissions, "Účet, ke kterým přistupujete, nemá dostatečná oprávnění ke spuštění této operace."
404 Nenalezeno, FilesystemNotFound, "Zadaný systém souborů neexistuje."
404 Nenalezeno, PathNotFound, "Zadaná cesta neexistuje."
404 Nenalezeno, RenameDestinationParentPathNotFound, Nadřazený adresář cílové cesty neexistuje.
404 Nenalezeno, ResourceNotFound, "Zadaný prostředek neexistuje."
404 Nenalezeno, SourcePathNotFound, "Zdrojová cesta pro operaci přejmenování neexistuje."
405 Method Not Allowed, UnsupportedHttpVerb, "The resource doesn't support the specified HTTP verb."
409 Conflict, DestinationPathIsBeingDeleted, "Zadaná cílová cesta je označena k odstranění."
409 Conflict, DirectoryNotEmpty, "Hodnota parametru rekurzivního dotazu musí být true, aby bylo možné odstranit neprázdný adresář."
409 Conflict, FilesystemAlreadyExists, "Zadaný systém souborů již existuje."
409 Konflikt, FilesystemBeingDeleted, "Zadaný systém souborů je odstraněn."
409 – Konflikt, InvalidDestinationPath, "Zadaná cesta nebo prvek cesty existuje a její typ prostředku je pro tuto operaci neplatný." * 409 Konflikt, InvalidFlushOperation, "Prostředek byl vytvořen nebo změněn rozhraním API služby Blob Service a nemůže být zapsán do rozhraní API služby Data Lake Storage."
409 Konflikt, InvalidRenameSourcePath, "Zdrojový adresář nemůže být stejný jako cílový adresář, ani cíl nemůže být podadresář zdrojového adresáře."
409 Conflict, InvalidSourceOrDestinationResourceType, "Typ zdrojového a cílového prostředku musí být identický."
409 – Konflikt, LeaseAlreadyPresent, "Zapůjčení již existuje."
409 Conflict, LeaseIdMismatchWithLeaseOperation, "Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku se zadanou operací zapůjčení."
409 Konflikt, LeaseIsAlreadyBroken, "Zapůjčení již bylo přerušeno a nelze ho znovu zlomit."
409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "ID zapůjčení bylo spárováno, ale zapůjčení je aktuálně ve stavu přerušení a nelze jej získat, dokud nebude přerušeno."
409 Conflict, LeaseIsBreakingAndCannotBeChanged, "ID zapůjčení bylo spárováno, ale zapůjčení je v současné době ve stavu přerušení a nelze ho změnit."
409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "ID zapůjčení bylo spárováno, ale zapůjčení bylo explicitně přerušeno a nelze ho obnovit."
409 Conflict, LeaseNameMismatch, "Zadaný název zapůjčení neodpovídá existujícímu názvu zapůjčení."
409 Conflict, LeaseNotPresentWithLeaseOperation, "ID zapůjčení není k dispozici u zadané operace zapůjčení."
409 Konflikt, PathAlreadyExists, "Zadaná cesta již existuje."
409 Konflikt, PathConflict, "Zadaná cesta nebo prvek cesty existuje a její typ prostředku je pro tuto operaci neplatný."
409 Konflikt, SourcePathIsBeingDeleted, "Zadaná zdrojová cesta je označena k odstranění."
409 Konflikt, ResourceTypeMismatch, "Typ prostředku zadaný v požadavku neodpovídá typu prostředku."
412 Předběžná podmínka se nezdařila, ConditionNotMet, Podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna.
412 Předběžná podmínka se nezdařila, LeaseIdMismatch, "Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku."
412 Předběžná podmínka se nezdařila, LeaseIdMissing, "Prostředek je v současné době zapůjčen a v žádosti nebylo zadáno žádné ID zapůjčení."
412 Předběžná podmínka selhala, LeaseNotPresent, "Prostředek v současné době není zapůjčen."
412 Předběžná podmínka se nezdařila, LeaseLost, "Bylo zadáno ID zapůjčení, ale platnost zapůjčení prostředku vypršela."
412 Předpoklad se nezdařil, SourceConditionNotMet, "Zdrojová podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna."
413 Request Entity Too Large, RequestBodyTooLarge, "Text požadavku je příliš velký a překračuje maximální povolený limit."
416 Požadovaný rozsah není uspokojitelný, InvalidRange, "Zadaný rozsah je neplatný pro aktuální velikost prostředku."
500 Vnitřní chyba serveru, InternalError, "Server zjistil vnitřní chybu. Zkuste žádost zopakovat.
500 Vnitřní chyba serveru, OperationTimedOut, "Operaci nelze dokončit v povoleném čase."
503 Service Unavailable, ServerBusy, "Egress is over the account limit" (Výchozí přenos dat je nad limitem účtu).
503 Služba není k dispozici, ServerBusy, "Příchozí přenos dat překročil limit účtu".
503 Service Unavailable, ServerBusy, "Operations per second is over the account limit" (Počet operací za sekundu je nad limitem účtu).
503 Služba není k dispozici, ServerBusy, "Server v současné době nemůže přijímat požadavky. Zkuste prosím žádost zopakovat."

Hlavičky

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

Definice

Name	Description
DataLakeStorageError
Error	Objekt odpovědi na chybu služby.
PathGetPropertiesAction	Nepovinný parametr. Pokud je hodnota "getStatus", vrátí se pouze systémově definované vlastnosti pro cestu. Pokud je hodnota getAccessControl, vrátí se v hlavičce odpovědi seznam řízení přístupu (pro účet musí být povolený hierarchický obor názvů), jinak se vrátí vlastnosti.

DataLakeStorageError

Name	Typ	Description
error	Error	Objekt odpovědi na chybu služby.

Error

Objekt odpovědi na chybu služby.

Name	Typ	Description
code	string	Kód chyby služby.
message	string	Chybová zpráva služby.