Výpis adresářů a souborů

Článek
03/29/2023

Operace List Directories and Files vrátí seznam souborů nebo adresářů v zadané sdílené složce nebo adresáři. Vypíše obsah pouze pro jednu úroveň hierarchie adresářů.

Dostupnost protokolu

Povolený protokol sdílené složky	K dispozici.
SMB
NFS

Žádost

Požadavek můžete sestavit List Directories and Files následujícím způsobem. Doporučuje se https.

Metoda	Identifikátor URI žádosti	Verze PROTOKOLU HTTP
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list`	HTTP/1.1
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list`	HTTP/1.1

Následujícím způsobem nahraďte komponenty cesty uvedené v identifikátoru URI požadavku vlastními:

Komponenta cesty	Description
`myaccount`	Název vašeho účtu úložiště.
`myshare`	Název sdílené složky.
`mydirectorypath`	Cesta k adresáři.

Podrobnosti o omezeních pojmenování cest najdete v tématu Pojmenování sdílených složek, adresářů, souborů a metadat a odkazování na nich.

Parametry identifikátoru URI

V identifikátoru URI můžete zadat následující další parametry.

Parametr	Popis
`prefix`	Nepovinný parametr. Verze 2016-05-31 a novější. Filtruje výsledky tak, aby vracely pouze soubory a adresáře, jejichž názvy začínají zadanou předponou.
`sharesnapshot`	Nepovinný parametr. Verze 2017-04-17 a novější. Parametr snímku sdílené složky je neprůsedná `DateTime` hodnota, která pokud je k dispozici, určuje snímek sdílené složky, který se má dotazovat na seznam souborů a adresářů.
`marker`	Nepovinný parametr. Řetězcová hodnota, která identifikuje část seznamu, která má být vrácena při další operaci seznamu. Operace vrátí hodnotu značky v těle odpovědi, pokud vrácený seznam nebyl dokončený. Hodnotu značky pak můžete použít v následném volání a vyžádat si další sadu položek seznamu. Hodnota značky je pro klienta neprůžná.
`maxresults`	Nepovinný parametr. Určuje maximální počet souborů nebo adresářů, které se mají vrátit. Pokud požadavek neurčí `maxresults`nebo určuje hodnotu větší než 5 000, server vrátí až 5 000 položek. Pokud `maxresults` nastavíte hodnotu menší nebo rovnou nule, zobrazí se kód odpovědi na chybu 400 (Chybný požadavek).
`include={Timestamps, ETag, Attributes, PermissionKey}`	Volitelně k dispozici od verze 2020-04-08. Určuje jednu nebo více vlastností, které se mají zahrnout do odpovědi: `Timestamps` `ETag` `Attributes` (Atributy souboru Win32) `PermissionKey` Pokud chcete u identifikátoru URI zadat více než jednu z těchto možností, musíte každou možnost oddělit čárkou zakódovanou v adrese URL (`%82`). Při zadání tohoto parametru se implicitně předpokládá, že hlavička `x-ms-file-extended-info` má hodnotu true.
`timeout`	Nepovinný parametr. Parametr `timeout` se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace Azure Files.

Hlavičky požadavku

Následující tabulka popisuje požadované a volitelné hlavičky požadavků.

Hlavička požadavku	Popis
`Authorization`	Povinná hodnota. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
`Date` nebo `x-ms-date`	Povinná hodnota. Určuje formát UTC (Coordinated Universal Time). Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
`x-ms-version`	Povinné pro všechny autorizované žádosti, volitelné pro anonymní žádosti. Určuje verzi operace, která se má pro tento požadavek použít. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
`x-ms-client-request-id`	Nepovinný parametr. Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem počtu znaků 1 kibibajt (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování Azure Files.
`x-ms-file-extended-info: {true}`	Nepovinný parametr. Verze 2020-04-08 a novější. Implicitně se předpokládá, že tato hlavička má hodnotu true, pokud `include` parametr dotazu není prázdný. Pokud je hodnota true, `Content-Length` bude vlastnost aktuální. Ve verzích 2020-04-08, 2020-06-12 a 2020-08-04 se vrátí pro soubory a adresáře pouze v případě, `FileId` že je tato hlavička pravdivá. Ve verzích 2020-10-02 a novějších `FileId` se vždy vrací pro soubory a adresáře.
`x-ms-file-request-intent`	Vyžaduje se, pokud `Authorization` hlavička určuje token OAuth. Přijatelná hodnota je `backup`. Tato hlavička určuje, že `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` by se měly udělit nebo `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` , pokud jsou zahrnuté v zásadách RBAC přiřazené identitě, která je autorizována pomocí hlavičky `Authorization` . K dispozici pro verzi 2022-11-02 a novější.
`x-ms-allow-trailing-dot: { <Boolean> }`	Nepovinný parametr. Verze 2022-11-02 a novější. Logická hodnota určuje, jestli se má koncový tečka v adrese URL požadavku oříznout, nebo ne. Další informace najdete v tématu Pojmenování sdílených složek, adresářů, souborů a metadat a odkazování na nich.

Text požadavku

Žádné

Odpověď

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědi a text odpovědi ve formátu XML.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK). Informace o stavových kódech najdete v tématu Kódy stavu a chyb.

Hlavičky odpovědi

Odpověď na tuto operaci obsahuje následující hlavičky. Odpověď může také obsahovat další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Hlavička odpovědi	Description
`Content-Type`	Určuje formát, ve kterém jsou výsledky vráceny. V současné době je `application/xml`tato hodnota .
`x-ms-request-id`	Tato hlavička jednoznačně identifikuje požadavek, který byl proveden, a dá se použít k řešení potíží s požadavkem. Další informace najdete v tématu Řešení potíží s operacemi rozhraní API.
`x-ms-version`	Označuje verzi Azure Files použité ke spuštění požadavku.
`Date` nebo `x-ms-date`	Hodnota data a času UTC, která označuje čas, kdy byla odpověď zahájena. Tato služba vygeneruje tuto hodnotu.
`x-ms-client-request-id`	Tuto hlavičku můžete použít k řešení potíží s požadavky a odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě `x-ms-client-request-id` hlavičky, pokud je v požadavku. Hodnota je maximálně 1024 viditelných znaků ASCII. Pokud hlavička `x-ms-client-request-id` v požadavku není, nebude tato hlavička v odpovědi.

Text odpovědi

Formát odpovědi XML je následující.

Všimněte si, že elementy Marker, ShareSnapshota MaxResults jsou k dispozici pouze v případě, že je zadáte v identifikátoru URI požadavku. Element NextMarker má hodnotu jenom v případě, že výsledky seznamu nejsou dokončené.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.file.core.windows.net/" ShareName="myshare" ShareSnapshot="date-time" DirectoryPath="directory-path">  
  <Marker>string-value</Marker>
  <Prefix>string-value</Prefix>
  <MaxResults>int-value</MaxResults>
  <DirectoryId>directory-id</DirectoryId>
  <Entries>
    <File>
      <FileId>file-id</FileId>
      <Name>file-name</Name>  
      <Properties>  
        <Content-Length>size-in-bytes</Content-Length>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </File>  
    <Directory>
      <FileId>file-id</FileId>
      <Name>directory-name</Name>  
      <Properties>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </Directory>  
  </Entries>  
  <NextMarker />  
</EnumerationResults>

Všimněte si Content-Length , že element je vrácen v výpisu. Tato hodnota ale nemusí být aktuální, protože klient SMB mohl soubor místně upravit. Hodnota Content-Length nemusí odrážet tento fakt, dokud se úchyt nezavře nebo dokud nedojde k přerušení provozního zámku. Pokud chcete načíst aktuální hodnoty vlastností, použijte x-ms-file-extended-info: truenebo volejte Příkaz Získat vlastnosti souboru.

Ve verzích 2020-04-08, 2020-06-12 a 2020-08-04 se vrátí pro soubory a adresáře, FileId pokud je hlavička x-ms-file-extended-info pravdivá. Ve verzi 2020-10-02 a novější FileId se vždy vrátí pro soubory a adresáře.

Ve verzi 2020-04-08 include={timestamps} vrátí následující vlastnosti časového razítka: CreationTime, LastAccessTimea LastWriteTime. Ve verzi 2020-06-12 a novější include={timestamps} vrátí následující vlastnosti časového razítka: CreationTime, LastAccessTime, LastWriteTime, ChangeTimea Last-Modified.

Ve verzi 2020-10-02 a novější DirectoryId se vrátí v odpovědi. FileId Určuje adresář, ve kterém se rozhraní API volá.

Ve verzích 2021-12-02 a novějších List Directory and Files bude kódovat procenta (podle RFC 2396) všechny FileNamehodnoty elementu , DirectoryNamenebo DirectoryPath obsahující Prefix znaky neplatné v XML (konkrétně U+FFFE nebo U+FFFF). Pokud je zakódován, Nameelement , Prefix nebo EnumerationResults bude obsahovat Encoded=true atribut. Všimněte si, že k tomu dojde pouze pro Name hodnoty elementu obsahující znaky neplatné v XML, nikoli pro zbývající Name prvky v odpovědi.

Formát datetime a verze rozhraní API pro pole časového razítka

Prvek	Formát data a času	Ukázková hodnota	Verze rozhraní API
`CreationTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	8. 4. 2020 a novější
`LastAccessTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	8. 4. 2020 a novější
`LastWriteTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	8. 4. 2020 a novější
`ChangeTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-06-12 a novější
`Last-Modified`	RFC 1123	`Thu, 17 Sep 2020 13:38:07 GMT`	2020-06-12 a novější

Autorizace

Tuto operaci může volat pouze vlastník účtu.

Poznámky

Hodnota vrácená v elementu Content-Length odpovídá hodnotě hlavičky x-ms-content-length souboru.

Všimněte si, že každý Directory vrácený prvek se počítá do maximálního výsledku stejně jako každý File prvek. Soubory a adresáře jsou uvedeny v textu odpovědi v lexicky seřazených pořadích.

Výpis je omezený na jednu úroveň hierarchie adresářů. Pokud chcete zobrazit seznam více úrovní, můžete iterativním způsobem provádět několik volání. Použijte hodnotu vrácenou Directory z jednoho výsledku při následném volání .List Directories and Files

Viz také

Operace s adresáři