Megosztások listázása

Cikk
06/13/2024

A List Shares művelet a megadott fiók alatti megosztások és megosztási pillanatképek listáját adja vissza. Ez az API teljes mértékben támogatott, de örökölt felügyeleti API. Használja inkább a Fájlmegosztások – Lista lehetőséget, amelyet a tárerőforrás-szolgáltató (Microsoft.Storage) biztosít. Ha többet szeretne megtudni arról, hogyan használhatja FileShare programozott módon az erőforrásokat a tárerőforrás-szolgáltató használatával, tekintse meg a FileShares-műveletek című témakört.

Protokoll rendelkezésre állása

Engedélyezett fájlmegosztási protokoll	Elérhető
SMB
NFS

Kérés

A kérést a List Shares következőképpen hozhatja létre. A HTTPS használata ajánlott.

Metódus	Kérés URI-ja	HTTP-verzió
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

Cserélje le a kérelem URI-jában látható elérésiút-összetevőket a sajátjára az alábbiak szerint:

Elérésiút-összetevő	Description
`myaccount`	A tárfiók neve.

Az elérésiút-elnevezési korlátozások részleteiért lásd: Megosztások, könyvtárak, fájlok és metaadatok elnevezése és hivatkozása.

URI-paraméterek

A kérelem URI-ján a következő további paramétereket adhatja meg.

Paraméter	Leírás
`prefix`	Választható. Az eredményeket úgy szűri, hogy csak azokat a megosztásokat adja vissza, amelyek neve a megadott előtaggal kezdődik.
`marker`	Választható. A következő listaművelettel visszaadandó listarészt azonosító sztringérték. A művelet egy jelölőértéket ad vissza a választörzsben, ha a visszaadott lista nem fejeződött be. Ezt követően egy későbbi hívásban a jelölőérték használatával kérheti le a listaelemek következő készletét. A jelölő értéke átlátszatlan az ügyfél számára.
`maxresults`	Választható. A visszaadandó megosztások maximális számát adja meg. Ha a kérés nem ad meg `maxresults`, vagy 5000-nél nagyobb értéket ad meg, a kiszolgáló legfeljebb 5000 elemet ad vissza. Ha a paraméter nullánál kisebb vagy egyenlő értékre van állítva, a kiszolgáló a 400-ás állapotkódot adja vissza (Hibás kérés).
`include=metadata,snapshots,deleted`	Választható. Egy vagy több adatkészletet ad meg, amely szerepel a válaszban: - `snapshots`: 2017-04-17-es és újabb verzió. Meghatározza, hogy a megosztási pillanatképeknek szerepelnie kell a válaszban. A megosztási pillanatképek a válaszban a legrégebbitől a legújabbig jelennek meg. - `metadata`: Azt adja meg, hogy a válaszban a megosztási metaadatokat vissza kell adni. - `deleted`: Azt adja meg, hogy a törölt fájlmegosztásokat szerepeltetni kell a válaszban. Ha egynél több beállítást szeretne megadni az URI-ban, mindegyik beállítást url-kódolású vesszővel kell elválasztania ("%82"). Minden metaadatnévnek meg kell felelnie a C#-azonosítók elnevezési konvencióinak.
`timeout`	Választható. A `timeout` paraméter másodpercben van kifejezve. További információ: Időtúllépések beállítása az Azure Files-műveletekhez.

Kérésfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Kérelem fejléce	Leírás
`Authorization`	Kötelező. Megadja az engedélyezési sémát, a fióknevet és az aláírást. További információ: Kérések engedélyezése az Azure Storage-ba.
`Date` vagy `x-ms-date`	Kötelező. Megadja a kérés egyezményes világidő (UTC) formátumban kifejezett időpontját. További információ: Kérések engedélyezése az Azure Storage-ba.
`x-ms-version`	Minden engedélyezett kéréshez szükséges. A kérelemhez használni kívánt művelet verzióját adja meg. További információ: Az Azure Storage-szolgáltatások verziószámozása.
`x-ms-client-request-id`	Választható. Ügyfél által generált, átlátszatlan értéket biztosít egy 1 kib-os (KiB) karakterkorláttal, amelyet a naplózás konfigurálásakor rögzít a naplókban. Javasoljuk, hogy ezt a fejlécet használva korrelálja az ügyféloldali tevékenységeket a kiszolgáló által kapott kérésekkel. További információ: Az Azure Files monitorozása.

A kérés törzse

Nincsenek.

Reagálás

A válasz tartalmaz egy HTTP-állapotkódot, egy válaszfejléceket és egy XML formátumú választörzset.

Állapotkód

A sikeres művelet a 200-ra (OK) vonatkozó állapotkódot adja vissza. Az állapotkódokkal kapcsolatos információkért lásd: Állapot- és hibakódok.

Válaszfejlécek

A műveletre adott válasz a következő fejléceket tartalmazza. A válasz további szabványos HTTP-fejléceket is tartalmaz. Minden szabványos fejléc megfelel a HTTP/1.1 protokoll specifikációjának.

Válaszfejléc	Description
`Content-Type`	Standard HTTP/1.1 fejléc. Azt a formátumot adja meg, amelyben a rendszer visszaadja az eredményeket. Ez az érték jelenleg a .`application/xml`
`x-ms-request-id`	Ez a fejléc egyedileg azonosítja a végrehajtott kérést, és a kérés hibaelhárításához használható. További információ: API-műveletek hibaelhárítása.
`x-ms-version`	A kérés futtatásához használt Azure Files-verziót jelöli.
`Date` vagy `x-ms-date`	Utc dátum/idő érték, amely a válasz indításának időpontját jelzi. A szolgáltatás létrehozza ezt az értéket.
`x-ms-client-request-id`	Ezzel a fejlécmel elháríthatja a kéréseket és a megfelelő válaszokat. A fejléc értéke megegyezik a fejléc értékével `x-ms-client-request-id` , ha az szerepel a kérelemben. Az érték legfeljebb 1024 látható ASCII-karakter lehet. Ha a `x-ms-client-request-id` fejléc nem szerepel a kérelemben, akkor ez a fejléc nem jelenik meg a válaszban.

Választörzs

A válasz törzsének formátuma a következő.

<?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>

Az EnabledProtocols elem csak a 2020-02-10-es és újabb verzióban jelenik meg a választörzsben.
Az RootSquash elem csak a 2020-02-10-es és újabb verzióban jelenik meg a válasz törzsében, ha az engedélyezett protokollok NFS-t tartalmaznak. Ez az elem csak megosztásokhoz lesz visszaadva, pillanatképekhez nem.
Az Quota elem csak a 2015-02-21-es és újabb verziókban jelenik meg a válasz törzsében.
A Version, Deleted, DeletedTimeés RemainingRetentionDays elemek csak a 2019-12-12-es és újabb verziókban jelennek meg a válasz törzsében.
A Prefix, Markerés MaxResults elem csak akkor jelenik meg, ha megadja őket az URI-n. Az NextMarker elem csak akkor rendelkezik értékkel, ha a listaeredmények nem fejeződnek be.
Az Metadata elem csak akkor jelenik meg, ha megadja a paramétert include=metadata az URI-n. Az elemen belül az Metadata egyes név-érték párok értéke a pár nevének megfelelő elemen belül jelenik meg.
A pillanatképek csak akkor szerepelnek a válaszban, ha megadja ainclude=snapshots paramétert a include kérelem URI-ján szereplő paraméterrel.
Az AccessTier elem tartalmazza a megosztás szintjét. Ha a megosztás szintje nem módosult, ez a tulajdonság lesz az alapértelmezett szint TransactionOptimized az általános célú 2. verziójú (GPv2) tárfiókok esetében. Az Azure Files-tárfiókok esetében a tulajdonság az lesz Premium, amely az egyetlen támogatott szint.
Az AccessTierChangeTime elem csak akkor jelenik meg, ha explicit módon állítja be a hozzáférési szintet a megosztáson.
Az AccessTierTransitionState elem csak akkor jelenik meg, ha a megosztás egyik rétegről a másikra vált. Azt jelzi, hogy milyen szintről vált át.
Az ProvisionedIngressMBps elem csak az Azure Files-fiókokhoz Premium , valamint a 2019-07-07-es vagy újabb verzióhoz érhető el. A kiosztott bejövő forgalom miB/s-ben jelenik meg.
Az ProvisionedEgressMBps elem csak az Azure Files-fiókokhoz Premium , valamint a 2019-07-07-es vagy újabb verzióhoz érhető el. A kiosztott kimenő forgalom miB/s-ben jelenik meg.
Az ProvisionedBandwidthMiBps elem csak Az Azure Files-fiókok esetében Premium jelenik meg, és a 2021-02-12-es vagy újabb verzió. A kiosztott sávszélességet (bejövő és kimenő forgalom együttesen) jeleníti meg a MiB/s-ben.
Az EnableSnapshotVirtualDirectoryAccess elem csak a 2024-08-04-es és újabb verzióban jelenik meg a választörzsben, ha az engedélyezett protokollok NFS-t tartalmaznak. Ez az elem csak megosztásokhoz lesz visszaadva, pillanatképekhez nem.

Mintaválasz

Tekintse meg a jelen témakör későbbi , Mintakérés és válasz szakaszát.

Engedélyezés

Ezt a műveletet csak a fióktulajdonos hívhatja meg.

Megjegyzések

Ha megad egy értéket a maxresults paraméterhez, és a visszaadandó megosztások száma meghaladja ezt az értéket, vagy meghaladja az alapértelmezett értéket maxresults, a válasz törzse tartalmaz egy NextMarker elemet. Ez az elem jelzi a következő megosztást, amely egy későbbi kérelemre tér vissza. A következő elemkészlet visszaadásához adja meg a jelölőparaméter értékét NextMarker az URI-n a következő kéréshez.

Vegye figyelembe, hogy az értékét NextMarker átlátszatlanként kell kezelni.

A megosztások betűrendben jelennek meg a válasz törzsében.

A List Shares művelet 30 másodperc után túllépi az időkorlátot.

Mintakérés és válasz

Az alábbi URI-minta lekéri egy fiók megosztásainak listáját. A kezdeti művelet maximális eredményét háromra állítja vissza.

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

A kérés az alábbi fejlécekkel lesz elküldve:

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

Az állapotkód és a válaszfejlécek a következőképpen lesznek visszaadva:

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

A kérés válasz XML-fájlja a következő. Vegye figyelembe, hogy az NextMarker elem a megosztások halmazát követi, és tartalmazza a következő visszaadandó megosztás nevét.

<?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>
      </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>

Az ezt követő listaművelet az alábbiak szerint határozza meg a kérelem URI-ján szereplő jelölőt. A következő eredményhalmaz a jelölő által megadott megosztással kezdődik.

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

Lásd még

Azure Files REST API

Megosztás a következőn keresztül: