Výpis sdílených složek

Článek
07/19/2023

Operace List Shares vrátí seznam sdílených složek a snímků sdílených složek v rámci zadaného účtu. Toto rozhraní API je plně podporované, ale je to starší verze rozhraní API pro správu. Použijte místo toho sdílené složky – seznam, který poskytuje poskytovatel prostředků úložiště (Microsoft.Storage). Další informace o programové interakci s prostředky pomocí poskytovatele prostředků úložiště najdete v tématu Operace se sdílenýmiFileShare složkami.

Dostupnost protokolu

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

Žádost

Požadavek můžete sestavit List Shares 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/?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ě.

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 požadavku můžete zadat následující další parametry.

Parametr	Popis
`prefix`	Nepovinný parametr. Filtruje výsledky tak, aby vrátily pouze sdílené složky, které mají názvy začínající zadanou předponou.
`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 sdílených složek, 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 je parametr nastaven na hodnotu menší nebo rovnou nule, server vrátí stavový kód 400 (Chybný požadavek).
`include=metadata,snapshots,deleted`	Nepovinný parametr. Určuje jednu nebo více datových sad, které se mají zahrnout do odpovědi: - `snapshots`: Verze 2017-04-17 a novější. Určuje, že do odpovědi by měly být zahrnuté snímky sdílené složky. V odpovědi jsou uvedeny snímky sdílených složek od nejstarších po nejnovější. - `metadata`: Určuje, že se v odpovědi mají vrátit metadata sdílené složky. - `deleted`: Určuje, že odstraněné sdílené složky by měly být součástí odpovědi. Pokud chcete v 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). Všechny názvy metadat musí dodržovat zásady vytváření názvů pro identifikátory jazyka C#.
`timeout`	Nepovinný parametr. Parametr se `timeout` 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`	Vyžaduje se pro všechny autorizované žá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.

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 Stavové kódy a kódy chyb.

Hlavičky odpovědi

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

Hlavička odpovědi	Description
`Content-Type`	Standardní hlavička HTTP/1.1. 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 lze ji 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 se nachází v požadavku. Hodnota je maximálně 1024 viditelných znaků ASCII. Pokud se hlavička `x-ms-client-request-id` v požadavku nenachází, nebude tato hlavička v odpovědi.

Text odpovědi

Text odpovědi má následující formát.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults AccountName="https://myaccount.file.core.windows.net">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Shares>  
    <Share>  
      <Name>share-name</Name>  
      <Snapshot>Date-Time Value</Snapshot>
      <Version>01D2AC0C18EDFE36</Version> 
      <Deleted>true</Deleted>  
      <Properties>  
        <Last-Modified>date/time-value</Last-Modified>  
        <Etag>etag</Etag>  
        <Quota>max-share-size</Quota>
        <DeletedTime>Mon, 24 Aug 2020 04:56:10 GMT</DeletedTime>  
        <RemainingRetentionDays>360</RemainingRetentionDays>
        <AccessTier>TransactionOptimized</AccessTier>
        <AccessTierChangeTime>Mon, 24 Aug 2020 03:56:10 GMT</AccessTierChangeTime>
        <AccessTierTransitionState>pending-from-cool</AccessTierTransitionState>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

Prvek EnabledProtocols se zobrazí v textu odpovědi pouze ve verzi 2020-02-10 a novější.
Element RootSquash se zobrazí v textu odpovědi pouze ve verzi 2020-02-10 a novější, pokud povolené protokoly obsahují systém souborů NFS.
Element Quota se zobrazí v textu odpovědi pouze ve verzi 2015-02-21 a novější.
Prvky Version, Deleted, DeletedTimea RemainingRetentionDays se zobrazí v textu odpovědi pouze ve verzi 2019-12-12 a novější.
Elementy Prefix, Markera MaxResults jsou k dispozici pouze v případě, že je zadáte v identifikátoru URI. Element NextMarker má hodnotu pouze v případě, že výsledky seznamu nejsou dokončené.
Element Metadata je k dispozici pouze v include=metadata případě, že zadáte parametr v identifikátoru URI. V elementu Metadata je hodnota každého páru název-hodnota uvedena v elementu odpovídajícím názvu dvojice.
Snímky jsou součástí odpovědi pouze v případě, že parametr zadáteinclude=snapshots s parametrem include v identifikátoru URI požadavku.
Element AccessTier obsahuje úroveň sdílené složky. Pokud se úroveň sdílené složky nezměnila, bude tato vlastnost výchozí úrovní TransactionOptimized pro účty úložiště pro obecné účely verze 2 (GPv2). V Azure Files účtech úložiště bude Premiumvlastnost , což je jediná podporovaná úroveň.
Element AccessTierChangeTime je k dispozici pouze v případě, že explicitně nastavíte úroveň přístupu ve sdílené složce.
Element AccessTierTransitionState je k dispozici pouze v případě, že sdílená složka přechází z jedné vrstvy na jinou. Označuje úroveň, ze které přechází.
Element ProvisionedIngressMBps je k dispozici pouze pro Premium účty Azure Files a verze 2019-07-07 nebo novější. Zobrazuje zřízené příchozí přenosy dat v MiB/s.
Element ProvisionedEgressMBps je k dispozici pouze pro Premium účty Azure Files a verze 2019-07-07 nebo novější. Zobrazuje zřízený výchozí přenos dat v MiB/s.
Element ProvisionedBandwidthMiBps je k dispozici pouze pro Premium účty Azure Files a verze 2021-02-12 nebo novější. Zobrazuje zřízenou šířku pásma (v kombinaci příchozích přenosů a výchozích přenosů dat) v MiB/s.

Ukázková odpověď

Viz část Ukázková žádost a odpověď dále v tomto tématu.

Autorizace

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

Poznámky

Pokud zadáte hodnotu parametru maxresults a počet vrácených sdílených složek tuto hodnotu překročí nebo překročí výchozí hodnotu pro maxresults, tělo odpovědi obsahuje NextMarker prvek. Tento prvek označuje další sdílenou složku, která se má vrátit při následném požadavku. Pokud chcete vrátit další sadu položek, zadejte hodnotu NextMarker jako parametr značky v identifikátoru URI pro následující požadavek.

Všimněte si, že hodnota by NextMarker měla být považována za neprůselnou.

Sdílené složky jsou v textu odpovědi uvedené v abecedním pořadí.

Časový List Shares limit operace vyprší po 30 sekundách.

Ukázkový požadavek a odpověď

Následující ukázkový identifikátor URI vyžaduje seznam sdílených složek pro účet. Nastaví maximální výsledky, které se mají vrátit pro počáteční operaci, na tři.

GET https://myaccount.file.core.windows.net/?comp=list&maxresults=3&include=snapshots HTTP/1.1

Požadavek se odešle s těmito hlavičkami:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/D5Gy0fXvg=

Stavový kód a hlavičky odpovědi se vrátí takto:

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

Kód XML odpovědi na tento požadavek je následující. Všimněte si NextMarker , že element následuje sadu sdílených složek a obsahuje název další sdílené složky, která se má vrátit.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint=" https://myaccount.file.core.windows.net">  
  <MaxResults>3</MaxResults>  
  <Shares>  
    <Share>  
      <Name>audio</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C6B1B2</Etag>  
        <Quota>55</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>  
      <Name>images</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C1EEEC</Etag>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>
      <Name>textfiles</Name>
      <Snapshot>2017-05-12T20:52:22.0000000Z</Snapshot>
      <Properties>
        <Last-Modified><date></Last-Modified>
        <Etag>0x8D3F2E1A9D14700</Etag>
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>RootSquash</RootSquash>
      </Properties>
    </Share>
    <Share>  
      <Name>textfiles</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7BACAC3</Etag>  
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>AllSquash</RootSquash>  
      </Properties>  
    </Share>
  </Shares>  
  <NextMarker>video</NextMarker>  
</EnumerationResults>

Následující operace seznamu určuje značku identifikátoru URI požadavku následujícím způsobem. Vrátí se další sada výsledků, počínaje sdílenou složkou určenou značkou.

https://myaccount.file.core.windows.net/?comp=list&maxresults=3&marker=video

Viz také

Azure Files REST API